diff --git a/contract_variable_quantity/README.rst b/contract_variable_quantity/README.rst index f61ddfce..b9115a01 100644 --- a/contract_variable_quantity/README.rst +++ b/contract_variable_quantity/README.rst @@ -1,14 +1,38 @@ -.. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg - :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html - :alt: License: AGPL-3 - ================================================= Variable quantity in contract recurrent invoicing ================================================= +.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! 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%2Fcontract-lightgray.png?logo=github + :target: https://github.com/OCA/contract/tree/12.0/contract_variable_quantity + :alt: OCA/contract +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/contract-12-0/contract-12-0-contract_variable_quantity + :alt: Translate me on Weblate +.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png + :target: https://runbot.odoo-community.org/runbot/110/12.0 + :alt: Try me on Runbot + +|badge1| |badge2| |badge3| |badge4| |badge5| + With this module, you will be able to define in recurring contracts some lines with variable quantity according to a provided formula. +**Table of contents** + +.. contents:: + :local: + Configuration ============= @@ -25,7 +49,7 @@ Configuration * *contract*: Contract whose line belongs to. * *invoice*: Invoice (header) being created. -.. figure:: images/formula_form.png +.. figure:: https://raw.githubusercontent.com/OCA/contract/12.0/contract_variable_quantity/images/formula_form.png :alt: Formula form :width: 600 px @@ -40,38 +64,44 @@ To use this module, you need to: #. Select "Variable quantity" in column "Qty. type". #. Select one of the possible formulas to use (previously created). -.. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas - :alt: Try me on Runbot - :target: https://runbot.odoo-community.org/runbot/110/11.0 - 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. +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 +~~~~~~~ + +* Tecnativa + Contributors ------------- +~~~~~~~~~~~~ * Pedro M. Baeza * Dave Lasley +* Souheil Bejaoui -Maintainer ----------- +Maintainers +~~~~~~~~~~~ + +This module is maintained by the OCA. .. image:: https://odoo-community.org/logo.png :alt: Odoo Community Association :target: https://odoo-community.org -This module is maintained by the OCA. - 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. -To contribute to this module, please visit https://odoo-community.org. +This module is part of the `OCA/contract `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/contract_variable_quantity/static/description/index.html b/contract_variable_quantity/static/description/index.html new file mode 100644 index 00000000..1e704842 --- /dev/null +++ b/contract_variable_quantity/static/description/index.html @@ -0,0 +1,457 @@ + + + + + + +Variable quantity in contract recurrent invoicing + + + +
+

Variable quantity in contract recurrent invoicing

+ + +

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

+

With this module, you will be able to define in recurring contracts some +lines with variable quantity according to a provided formula.

+

Table of contents

+ +
+

Configuration

+
    +

  1. Go to Invoicing > Configuration > Contracts > Formulas (quantity).

    +
    2. +

  2. Define any formula based on Python code that stores at some moment a +float/integer value of the quantity to invoice in the variable ‘result’.

    +

    You can use these variables to compute your formula:

    +
      +
    • env: Environment variable for getting other models.
      • +
    • context: Current context dictionary.
      • +
    • user: Current user.
      • +
    • line: Contract recurring invoice line that triggers this formula.
      • +
    • contract: Contract whose line belongs to.
      • +
    • invoice: Invoice (header) being created.
      • +
    +
    3. +
+
+Formula form +
+
+
+

Usage

+

To use this module, you need to:

+
    +
  1. Go to Invoicing > Sales > Contracts and select or create a new contract.
    2. +
  2. Check Generate recurring invoices automatically.
    3. +
  3. Add a new recurring invoicing line.
    4. +
  4. Select “Variable quantity” in column “Qty. type”.
    5. +
  5. Select one of the possible formulas to use (previously created).
    6. +
+
+
+

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

+
    +
  • Tecnativa
    • +
+
+
+

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/contract project on GitHub.

+

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

+
+
+
+ +