You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

107 lines
3.9 KiB

  1. =================================================
  2. Variable quantity in contract recurrent invoicing
  3. =================================================
  4. .. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  5. !! This file is generated by oca-gen-addon-readme !!
  6. !! changes will be overwritten. !!
  7. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  8. .. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
  9. :target: https://odoo-community.org/page/development-status
  10. :alt: Beta
  11. .. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
  12. :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
  13. :alt: License: AGPL-3
  14. .. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fcontract-lightgray.png?logo=github
  15. :target: https://github.com/OCA/contract/tree/12.0/contract_variable_quantity
  16. :alt: OCA/contract
  17. .. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
  18. :target: https://translation.odoo-community.org/projects/contract-12-0/contract-12-0-contract_variable_quantity
  19. :alt: Translate me on Weblate
  20. .. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
  21. :target: https://runbot.odoo-community.org/runbot/110/12.0
  22. :alt: Try me on Runbot
  23. |badge1| |badge2| |badge3| |badge4| |badge5|
  24. With this module, you will be able to define in recurring contracts some
  25. lines with variable quantity according to a provided formula.
  26. **Table of contents**
  27. .. contents::
  28. :local:
  29. Configuration
  30. =============
  31. #. Go to Invoicing > Configuration > Contracts > Formulas (quantity).
  32. #. Define any formula based on Python code that stores at some moment a
  33. float/integer value of the quantity to invoice in the variable 'result'.
  34. You can use these variables to compute your formula:
  35. * *env*: Environment variable for getting other models.
  36. * *context*: Current context dictionary.
  37. * *user*: Current user.
  38. * *line*: Contract recurring invoice line that triggers this formula.
  39. * *contract*: Contract whose line belongs to.
  40. * *invoice*: Invoice (header) being created.
  41. .. figure:: https://raw.githubusercontent.com/OCA/contract/12.0/contract_variable_quantity/images/formula_form.png
  42. :alt: Formula form
  43. :width: 600 px
  44. Usage
  45. =====
  46. To use this module, you need to:
  47. #. Go to Invoicing > Sales > Contracts and select or create a new contract.
  48. #. Check *Generate recurring invoices automatically*.
  49. #. Add a new recurring invoicing line.
  50. #. Select "Variable quantity" in column "Qty. type".
  51. #. Select one of the possible formulas to use (previously created).
  52. Bug Tracker
  53. ===========
  54. Bugs are tracked on `GitHub Issues <https://github.com/OCA/contract/issues>`_.
  55. In case of trouble, please check there if your issue has already been reported.
  56. If you spotted it first, help us smashing it by providing a detailed and welcomed
  57. `feedback <https://github.com/OCA/contract/issues/new?body=module:%20contract_variable_quantity%0Aversion:%2012.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
  58. Do not contact contributors directly about support or help with technical issues.
  59. Credits
  60. =======
  61. Authors
  62. ~~~~~~~
  63. * Tecnativa
  64. Contributors
  65. ~~~~~~~~~~~~
  66. * Pedro M. Baeza <pedro.baeza@tecnativa.com>
  67. * Dave Lasley <dave@laslabs.com>
  68. * Souheil Bejaoui <souheil.bejaoui@acsone.eu>
  69. Maintainers
  70. ~~~~~~~~~~~
  71. This module is maintained by the OCA.
  72. .. image:: https://odoo-community.org/logo.png
  73. :alt: Odoo Community Association
  74. :target: https://odoo-community.org
  75. OCA, or the Odoo Community Association, is a nonprofit organization whose
  76. mission is to support the collaborative development of Odoo features and
  77. promote its widespread use.
  78. This module is part of the `OCA/contract <https://github.com/OCA/contract/tree/12.0/contract_variable_quantity>`_ project on GitHub.
  79. You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.