14.0 purchase global discount (#2)

[ADD] purchase_global_discount

Author: zamberjo

purchase_global_discount/__init__.py

@@ -0,0 +1 @@
+from . import models

purchase_global_discount/__manifest__.py

@@ -0,0 +1,14 @@
+# Copyright 2021 Comunitea - Omar Castiñeira
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).
+{
+    "name": "Purchase Global Discount",
+    "version": "14.0.1.0.0",
+    "category": "Purchases Management",
+    "author": "Comunitea, Odoo Community Association (OCA)",
+    "website": "https://github.com/OCA/purchase-workflow",
+    "license": "AGPL-3",
+    "depends": ["account_global_discount", "purchase"],
+    "data": ["views/purchase_order_views.xml", "views/report_purchase_order.xml"],
+    "application": False,
+    "installable": True,
+}

purchase_global_discount/models/__init__.py

@@ -0,0 +1 @@
+from . import purchase_order

purchase_global_discount/models/purchase_order.py

@@ -0,0 +1,142 @@
+# Copyright 2021 Comunitea - Omar Castiñeira
+# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
+from odoo import _, api, exceptions, fields, models
+
+
+class PurchaseOrder(models.Model):
+    _inherit = "purchase.order"
+
+    global_discount_ids = fields.Many2many(
+        comodel_name="global.discount",
+        string="Purchase Global Discounts",
+        domain="[('discount_scope', '=', 'purchase'), "
+        "('account_id', '!=', False), '|', "
+        "('company_id', '=', company_id), ('company_id', '=', False)]",
+    )
+    # HACK: Looks like UI doesn't behave well with Many2many fields and
+    # negative groups when the same field is shown. In this case, we want to
+    # show the readonly version to any not in the global discount group.
+    # TODO: Check if it's fixed in future versions
+    global_discount_ids_readonly = fields.Many2many(
+        related="global_discount_ids",
+        string="Purchase Global Discounts (readonly)",
+        readonly=True,
+    )
+    amount_global_discount = fields.Monetary(
+        string="Total Global Discounts",
+        compute="_amount_all",  # pylint: disable=C8108
+        currency_field="currency_id",
+        compute_sudo=True,  # Odoo core fields are storable so compute_sudo is True
+        readonly=True,
+        store=True,
+    )
+    amount_untaxed_before_global_discounts = fields.Monetary(
+        string="Amount Untaxed Before Discounts",
+        compute="_amount_all",  # pylint: disable=C8108
+        currency_field="currency_id",
+        compute_sudo=True,  # Odoo core fields are storable so compute_sudo is True
+        readonly=True,
+        store=True,
+    )
+    amount_total_before_global_discounts = fields.Monetary(
+        string="Amount Total Before Discounts",
+        compute="_amount_all",  # pylint: disable=C8108
+        currency_field="currency_id",
+        compute_sudo=True,  # Odoo core fields are storable so compute_sudo is True
+        readonly=True,
+        store=True,
+    )
+
+    @api.model
+    def get_discounted_global(self, price=0, discounts=None):
+        """Compute discounts successively"""
+        discounts = discounts or []
+        if not discounts:
+            return price
+        discount = discounts.pop(0)
+        price *= 1 - (discount / 100)
+        return self.get_discounted_global(price, discounts)
+
+    def _check_global_discounts_sanity(self):
+        """Perform a sanity check for discarding cases that will lead to
+        incorrect data in discounts.
+        """
+        self.ensure_one()
+        if not self.global_discount_ids:
+            return True
+        taxes_keys = {}
+        for line in self.order_line.filtered(lambda l: not l.display_type):
+            if not line.taxes_id:
+                raise exceptions.UserError(
+                    _("With global discounts, taxes in lines are required.")
+                )
+            for key in taxes_keys:
+                if key == line.taxes_id:
+                    break
+                elif key & line.taxes_id:
+                    raise exceptions.UserError(
+                        _("Incompatible taxes found for global discounts.")
+                    )
+            else:
+                taxes_keys[line.taxes_id] = True
+
+    @api.depends("order_line.price_total", "global_discount_ids")
+    def _amount_all(self):
+        res = super()._amount_all()
+        for order in self:
+            order._check_global_discounts_sanity()
+            amount_untaxed_before_global_discounts = order.amount_untaxed
+            amount_total_before_global_discounts = order.amount_total
+            discounts = order.global_discount_ids.mapped("discount")
+            amount_discounted_untaxed = amount_discounted_tax = 0
+            for line in order.order_line:
+                discounted_subtotal = self.get_discounted_global(
+                    line.price_subtotal, discounts.copy()
+                )
+                amount_discounted_untaxed += discounted_subtotal
+                discounted_tax = line.taxes_id.compute_all(
+                    discounted_subtotal,
+                    line.order_id.currency_id,
+                    1.0,
+                    product=line.product_id,
+                    partner=line.order_id.partner_id,
+                )
+                amount_discounted_tax += sum(
+                    t.get("amount", 0.0) for t in discounted_tax.get("taxes", [])
+                )
+            order.update(
+                {
+                    "amount_untaxed_before_global_discounts": (
+                        amount_untaxed_before_global_discounts
+                    ),
+                    "amount_total_before_global_discounts": (
+                        amount_total_before_global_discounts
+                    ),
+                    "amount_global_discount": (
+                        amount_untaxed_before_global_discounts
+                        - amount_discounted_untaxed
+                    ),
+                    "amount_untaxed": amount_discounted_untaxed,
+                    "amount_tax": amount_discounted_tax,
+                    "amount_total": (amount_discounted_untaxed + amount_discounted_tax),
+                }
+            )
+        return res
+
+    @api.onchange("partner_id")
+    def onchange_partner_id(self):
+        res = super().onchange_partner_id()
+        self.global_discount_ids = self.partner_id.supplier_global_discount_ids.filtered(
+            lambda d: d.company_id == self.company_id
+        ) or self.partner_id.commercial_partner_id.supplier_global_discount_ids.filtered(
+            lambda d: d.company_id == self.company_id
+        )
+        return res
+
+    def _prepare_invoice(self):
+        invoice_vals = super()._prepare_invoice()
+        if self.global_discount_ids:
+            invoice_vals.update(
+                {"global_discount_ids": [(6, 0, self.global_discount_ids.ids)]}
+            )
+        return invoice_vals

purchase_global_discount/readme/CONFIGURE.rst

@@ -0,0 +1,14 @@
+To configure this module, you need to:
+
+#. Go to *Settings > Technical > Parameters > Global Discounts*
+#. Add a new discount.
+#. Choose the discount scope (sales or purchases).
+#. You can also restrict it to a certain company if needed.
+
+You can assign global discounts to partners as well:
+
+#. Go to a partner that is a company.
+#. Go to the *Sales & Purchases* tab.
+#. In section sale (if the partner is a customer), you can set sale discounts.
+#. In section purchase (if the partner is a supplier), you can set purchase
+   discounts.

purchase_global_discount/readme/CONTRIBUTORS.rst

@@ -0,0 +1 @@
+* Omar Castiñeira <omar@comunitea.com>

purchase_global_discount/readme/DESCRIPTION.rst

@@ -0,0 +1,2 @@
+Apply global financial discounts to purchases that will be transmited to
+invoices and accounting.

purchase_global_discount/readme/ROADMAP.rst

@@ -0,0 +1,3 @@
+* Not all the taxes combination can be compatible with global discounts. An
+  error is raised in that cases.
+* Currently, taxes in invoice lines are mandatory with global discounts.

purchase_global_discount/readme/USAGE.rst

@@ -0,0 +1,9 @@
+To use this module, you need to:
+
+#. Create a new purchase order and choose a partner.
+#. If the partner has supplier global discounts set, those will be applied to
+   the order by default.
+#. Otherwise, you can set them manually from the header of the purchase order.
+#. In the order footer, you can see the computed discounts.
+#. When you create an invoice from the order, the proper global discounts will
+   be applied on it.

purchase_global_discount/static/description/icon.png

@@ -0,0 +1 @@
+from . import test_purchase_global_discount