diff --git a/contract_variable_quantity/__manifest__.py b/contract_variable_quantity/__manifest__.py index c28d7de4..29aab21a 100644 --- a/contract_variable_quantity/__manifest__.py +++ b/contract_variable_quantity/__manifest__.py @@ -4,7 +4,7 @@ { 'name': 'Variable quantity in contract recurrent invoicing', - 'version': '11.0.1.3.0', + 'version': '12.0.1.0.0', 'category': 'Contract Management', 'license': 'AGPL-3', 'author': "Tecnativa," diff --git a/contract_variable_quantity/models/contract.py b/contract_variable_quantity/models/contract.py index dff047a4..26edf6d9 100644 --- a/contract_variable_quantity/models/contract.py +++ b/contract_variable_quantity/models/contract.py @@ -59,6 +59,7 @@ class AccountAnalyticContractLine(models.Model): class ContractLineFormula(models.Model): _name = 'contract.line.qty.formula' + _description = 'Contract Line Formula' name = fields.Char(required=True, translate=True) code = fields.Text(required=True, default="result = 0") diff --git a/contract_variable_quantity/readme/CONFIGURE.rst b/contract_variable_quantity/readme/CONFIGURE.rst new file mode 100644 index 00000000..547b2d69 --- /dev/null +++ b/contract_variable_quantity/readme/CONFIGURE.rst @@ -0,0 +1,16 @@ +#. Go to Invoicing > Configuration > Contracts > Formulas (quantity). +#. 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. + +.. figure:: images/formula_form.png + :alt: Formula form + :width: 600 px \ No newline at end of file diff --git a/contract_variable_quantity/readme/CONTRIBUTORS.rst b/contract_variable_quantity/readme/CONTRIBUTORS.rst new file mode 100644 index 00000000..7894b462 --- /dev/null +++ b/contract_variable_quantity/readme/CONTRIBUTORS.rst @@ -0,0 +1,3 @@ +* Pedro M. Baeza +* Dave Lasley +* Souheil Bejaoui diff --git a/contract_variable_quantity/readme/DESCRIPTION.rst b/contract_variable_quantity/readme/DESCRIPTION.rst new file mode 100644 index 00000000..286996ff --- /dev/null +++ b/contract_variable_quantity/readme/DESCRIPTION.rst @@ -0,0 +1,2 @@ +With this module, you will be able to define in recurring contracts some +lines with variable quantity according to a provided formula. diff --git a/contract_variable_quantity/readme/USAGE.rst b/contract_variable_quantity/readme/USAGE.rst new file mode 100644 index 00000000..6de2d0e2 --- /dev/null +++ b/contract_variable_quantity/readme/USAGE.rst @@ -0,0 +1,7 @@ +To use this module, you need to: + +#. Go to Invoicing > Sales > Contracts and select or create a new contract. +#. Check *Generate recurring invoices automatically*. +#. Add a new recurring invoicing line. +#. Select "Variable quantity" in column "Qty. type". +#. Select one of the possible formulas to use (previously created).