diff --git a/pos_margin/README.rst b/pos_margin/README.rst index b97c0917..6263379a 100644 --- a/pos_margin/README.rst +++ b/pos_margin/README.rst @@ -1,4 +1,112 @@ +================ +PoS Order Margin +================ + .. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! !! This file is generated by oca-gen-addon-readme !! !! changes will be overwritten. !! !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png + :target: https://odoo-community.org/page/development-status + :alt: Beta +.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png + :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html + :alt: License: AGPL-3 +.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fpos-lightgray.png?logo=github + :target: https://github.com/OCA/pos/tree/12.0/pos_margin + :alt: OCA/pos +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/pos-12-0/pos-12-0-pos_margin + :alt: Translate me on Weblate +.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png + :target: https://runbot.odoo-community.org/runbot/184/12.0 + :alt: Try me on Runbot + +|badge1| |badge2| |badge3| |badge4| |badge5| + +This module extends the functionality of point of sale to support margin on +pos orders. + +This gives the profitability by calculating the difference between the Unit +Price and Cost Price. + +**Table of contents** + +.. contents:: + :local: + +Usage +===== + +To use this module, you need to: + +* Go to 'Point Of Sale' / 'Orders' / 'Orders' +* Open an order + +.. figure:: https://raw.githubusercontent.com/OCA/pos/12.0/pos_margin/static/description/pos_order_form.png + :width: 800px + +Known issues / Roadmap +====================== + +This module depends on ``sale_margin`` module to reuse algorithm present in the +function ``_get_purchase_price`` of the model ``sale.order.line`` to +compute correctly purchase price, in a multicurrency context. + +This dependency can be removed, when Odoo Core will be correctly refactored, +moving this ``@api.model`` function in a more generic module (``account`` +for exemple). + +Changelog +========= + +12.0.1.0.0 +~~~~~~~~~~ + +* Migrate to V12.0 +* Reuse ``sale_margin`` computation to handle multi currency context. +* Correct computation of margin, if a module that adds ``uom_id`` on + ``pos.order.line`` is installed. +* Add test + +Bug Tracker +=========== + +Bugs are tracked on `GitHub Issues `_. +In case of trouble, please check there if your issue has already been reported. +If you spotted it first, help us smashing it by providing a detailed and welcomed +`feedback `_. + +Do not contact contributors directly about support or help with technical issues. + +Credits +======= + +Authors +~~~~~~~ + +* GRAP + +Contributors +~~~~~~~~~~~~ + +* Sylvain LE GAL (https://twitter.com/legalsylvain) +* Wolfgang Pichler + +Maintainers +~~~~~~~~~~~ + +This module is maintained by the OCA. + +.. image:: https://odoo-community.org/logo.png + :alt: Odoo Community Association + :target: https://odoo-community.org + +OCA, or the Odoo Community Association, is a nonprofit organization whose +mission is to support the collaborative development of Odoo features and +promote its widespread use. + +This module is part of the `OCA/pos `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/pos_margin/static/description/index.html b/pos_margin/static/description/index.html new file mode 100644 index 00000000..f0091af0 --- /dev/null +++ b/pos_margin/static/description/index.html @@ -0,0 +1,462 @@ + + + + + + +PoS Order Margin + + + +
+

PoS Order Margin

+ + +

Beta License: AGPL-3 OCA/pos Translate me on Weblate Try me on Runbot

+

This module extends the functionality of point of sale to support margin on +pos orders.

+

This gives the profitability by calculating the difference between the Unit +Price and Cost Price.

+

Table of contents

+ +
+

Usage

+

To use this module, you need to:

+
    +
  • Go to ‘Point Of Sale’ / ‘Orders’ / ‘Orders’
    • +
  • Open an order
    • +
+
+https://raw.githubusercontent.com/OCA/pos/12.0/pos_margin/static/description/pos_order_form.png +
+
+
+

Known issues / Roadmap

+

This module depends on sale_margin module to reuse algorithm present in the +function _get_purchase_price of the model sale.order.line to +compute correctly purchase price, in a multicurrency context.

+

This dependency can be removed, when Odoo Core will be correctly refactored, +moving this @api.model function in a more generic module (account +for exemple).

+
+
+

Changelog

+
+

12.0.1.0.0

+
    +
  • Migrate to V12.0
    • +
  • Reuse sale_margin computation to handle multi currency context.
    • +
  • Correct computation of margin, if a module that adds uom_id on +pos.order.line is installed.
    • +
  • Add test
    • +
+
+
+
+

Bug Tracker

+

Bugs are tracked on GitHub Issues. +In case of trouble, please check there if your issue has already been reported. +If you spotted it first, help us smashing it by providing a detailed and welcomed +feedback.

+

Do not contact contributors directly about support or help with technical issues.

+
+
+

Credits

+
+

Authors

+
    +
  • GRAP
    • +
+
+
+

Contributors

+ +
+
+

Maintainers

+

This module is maintained by the OCA.

+Odoo Community Association +

OCA, or the Odoo Community Association, is a nonprofit organization whose +mission is to support the collaborative development of Odoo features and +promote its widespread use.

+

This module is part of the OCA/pos project on GitHub.

+

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

+
+
+
+ +