odoo-addon-sale-commission-product-criteria 16.0.1.0.0.2__py3-none-any.whl

odoo/addons/sale_commission_product_criteria/models/commission.py

@@ -0,0 +1,266 @@
+# © 2023 ooops404
+# Copyright 2023 Simone Rubino - Aion Tech
+# License AGPL-3 - See https://www.gnu.org/licenses/agpl-3.0.html
+from odoo import _, api, fields, models
+from odoo.exceptions import ValidationError
+from odoo.tools import float_repr
+
+
+class SaleCommission(models.Model):
+    _inherit = "commission"
+
+    commission_type = fields.Selection(
+        selection_add=[("product", "Product criteria")],
+        ondelete={"product": "set default"},
+    )
+    item_ids = fields.One2many("commission.item", "commission_id", copy=True)
+
+    def action_unarchive(self):
+        res = super().action_unarchive()
+        items = (
+            self.env["commission.item"]
+            .with_context(active_test=False)
+            .search([("commission_id", "=", self.id)])
+        )
+        if items:
+            items.write({"active": True})
+        return res
+
+    @api.onchange("commission_type")
+    def onchange_commission_type(self):
+        # Prevent commission_type change in certain cases
+        self.check_type_change_allowed_sale()
+        self.check_type_change_allowed_moves()
+
+    def check_type_change_allowed_sale(self):
+        sola_ids = self.env["sale.order.line.agent"].search(
+            [("commission_id", "=", self._origin.id)]
+        )
+        done_so_ids = sola_ids.filtered(lambda x: x.object_id.state in ["done", "sale"])
+        if done_so_ids:
+            raise ValidationError(
+                _(
+                    "There is done Sale Orders with this commission. "
+                    "Commission type change is not allowed."
+                )
+            )
+
+    def check_type_change_allowed_moves(self):
+        aila_ids = self.env["account.invoice.line.agent"].search(
+            [("commission_id", "=", self._origin.id)]
+        )
+        done_move_ids = aila_ids.filtered(
+            lambda x: x.object_id.parent_state == "posted"
+        )
+        if done_move_ids:
+            raise ValidationError(
+                _(
+                    "There is posted Account Move Lines with this commission. "
+                    "Commission type change is not allowed."
+                )
+            )
+
+
+class CommissionItem(models.Model):
+    _name = "commission.item"
+    _description = "Commission Item"
+    _order = "applied_on, based_on, categ_id desc, id desc"
+
+    sequence = fields.Integer(default=10)
+    active = fields.Boolean(default=True)
+    commission_id = fields.Many2one(
+        "commission",
+        string="Commission",
+        domain=[("commission_type", "=", "product")],
+        required=True,
+    )
+    product_tmpl_id = fields.Many2one(
+        "product.template",
+        "Product",
+        ondelete="cascade",
+        check_company=True,
+        help="Specify a template if this rule only applies to one "
+        "product template. Keep empty otherwise.",
+    )
+    product_id = fields.Many2one(
+        "product.product",
+        "Product Variant",
+        ondelete="cascade",
+        check_company=True,
+        help="Specify a product if this rule only applies "
+        "to one product. Keep empty otherwise.",
+    )
+    categ_id = fields.Many2one(
+        "product.category",
+        "Product Category",
+        ondelete="cascade",
+        help="Specify a product category if this rule only applies to "
+        "products belonging to this category or its children categories. "
+        "Keep empty otherwise.",
+    )
+    based_on = fields.Selection(
+        [("sol", "Any Sale Order Line")],
+        required=True,
+        default="sol",
+    )
+    applied_on = fields.Selection(
+        [
+            ("3_global", "All Products"),
+            ("2_product_category", "Product Category"),
+            ("1_product", "Product"),
+            ("0_product_variant", "Product Variant"),
+        ],
+        "Apply On",
+        default="3_global",
+        required=True,
+        help="Commission Item applicable on selected option",
+    )
+    commission_type = fields.Selection(
+        [("fixed", "Fixed"), ("percentage", "Percentage")],
+        index=True,
+        default="fixed",
+        required=True,
+    )
+    fixed_amount = fields.Float(digits="Product Price")
+    percent_amount = fields.Float("Percentage Amount")
+    company_id = fields.Many2one(
+        "res.company",
+        "Company",
+        default=lambda self: self.env.company,
+        readonly=True,
+    )
+    currency_id = fields.Many2one(
+        "res.currency",
+        related="company_id.currency_id",
+        readonly=True,
+    )
+    name = fields.Char(
+        compute="_compute_commission_item_name_value",
+        help="Explicit rule name for this commission line.",
+    )
+    commission_value = fields.Char(
+        "Value",
+        compute="_compute_commission_item_name_value",
+    )
+
+    @api.depends(
+        "applied_on",
+        "categ_id",
+        "product_tmpl_id",
+        "product_id",
+        "commission_type",
+        "fixed_amount",
+        "percent_amount",
+    )
+    def _compute_commission_item_name_value(self):
+        for item in self:
+            if item.categ_id and item.applied_on == "2_product_category":
+                item.name = _("Category: %s") % (item.categ_id.display_name)
+            elif item.product_tmpl_id and item.applied_on == "1_product":
+                item.name = _("Product: %s") % (item.product_tmpl_id.display_name)
+            elif item.product_id and item.applied_on == "0_product_variant":
+                item.name = _("Variant: %s") % (
+                    item.product_id.with_context(
+                        display_default_code=False
+                    ).display_name
+                )
+            else:
+                item.name = _("All Products")
+
+            if item.commission_type == "fixed":
+                decimal_places = self.env["decimal.precision"].precision_get(
+                    "Product Price"
+                )
+                if item.currency_id.position == "after":
+                    item.commission_value = "%s %s" % (
+                        float_repr(
+                            item.fixed_amount,
+                            decimal_places,
+                        ),
+                        item.currency_id.symbol or "",
+                    )
+                else:
+                    item.commission_value = "%s %s" % (
+                        item.currency_id.symbol or "",
+                        float_repr(
+                            item.fixed_amount,
+                            decimal_places,
+                        ),
+                    )
+            elif item.commission_type == "percentage":
+                item.commission_value = str(item.percent_amount) + " %"
+
+    @api.constrains("product_id", "product_tmpl_id", "categ_id")
+    def _check_product_consistency(self):
+        for item in self:
+            if item.applied_on == "2_product_category" and not item.categ_id:
+                raise ValidationError(
+                    _(
+                        "Please specify the category for which this rule should "
+                        "be applied"
+                    )
+                )
+            elif item.applied_on == "1_product" and not item.product_tmpl_id:
+                raise ValidationError(
+                    _(
+                        "Please specify the product for which this rule should "
+                        "be applied"
+                    )
+                )
+            elif item.applied_on == "0_product_variant" and not item.product_id:
+                raise ValidationError(
+                    _(
+                        "Please specify the product variant for "
+                        "which this rule should be applied"
+                    )
+                )
+
+    @api.onchange("product_id")
+    def _onchange_product_id(self):
+        has_product_id = self.filtered("product_id")
+        for item in has_product_id:
+            item.product_tmpl_id = item.product_id.product_tmpl_id
+        if self.env.context.get("default_applied_on", False) == "1_product":
+            # If a product variant is specified, apply on variants instead
+            # Reset if product variant is removed
+            has_product_id.update({"applied_on": "0_product_variant"})
+            (self - has_product_id).update({"applied_on": "1_product"})
+
+    @api.onchange("product_tmpl_id")
+    def _onchange_product_tmpl_id(self):
+        has_tmpl_id = self.filtered("product_tmpl_id")
+        for item in has_tmpl_id:
+            if (
+                item.product_id
+                and item.product_id.product_tmpl_id != item.product_tmpl_id
+            ):
+                item.product_id = None
+
+    @api.model_create_multi
+    def create(self, values_list):
+        new_values_list = []
+        for values in values_list:
+            values = self.validate_values(values)
+            new_values_list.append(values)
+        return super(CommissionItem, self).create(new_values_list)
+
+    def write(self, values):
+        values = self.validate_values(values)
+        res = super(CommissionItem, self).write(values)
+        return res
+
+    def validate_values(self, values):
+        if values.get("applied_on", False):
+            # Ensure item consistency for later searches.
+            applied_on = values["applied_on"]
+            if applied_on == "3_global":
+                values.update(
+                    dict(product_id=None, product_tmpl_id=None, categ_id=None)
+                )
+            elif applied_on == "2_product_category":
+                values.update(dict(product_id=None, product_tmpl_id=None))
+            elif applied_on == "1_product":
+                values.update(dict(product_id=None, categ_id=None))
+            elif applied_on == "0_product_variant":
+                values.update(dict(categ_id=None))
+        return values

odoo/addons/sale_commission_product_criteria/models/sale.py

@@ -0,0 +1,55 @@
+# © 2023 ooops404
+# Copyright 2023 Simone Rubino - Aion Tech
+# License AGPL-3 - See https://www.gnu.org/licenses/agpl-3.0.html
+from odoo import api, fields, models
+
+
+class SaleOrderLineAgent(models.Model):
+    _inherit = "sale.order.line.agent"
+
+    discount = fields.Float(related="object_id.discount")
+    applied_commission_item_id = fields.Many2one("commission.item")
+    based_on = fields.Selection(related="applied_commission_item_id.based_on")
+    applied_on_name = fields.Char(related="applied_commission_item_id.name")
+    commission_type = fields.Selection(
+        related="applied_commission_item_id.commission_type"
+    )
+    fixed_amount = fields.Float(related="applied_commission_item_id.fixed_amount")
+    percent_amount = fields.Float(related="applied_commission_item_id.percent_amount")
+
+    @api.depends(
+        "object_id.price_subtotal", "object_id.product_id", "object_id.product_uom_qty"
+    )
+    def _compute_amount(self):
+        res = None
+        for line in self:
+            if line.commission_id and line.commission_id.commission_type == "product":
+                order_line = line.object_id
+                line.amount = line._get_single_commission_amount(
+                    line.commission_id,
+                    order_line.price_subtotal,
+                    order_line.product_id,
+                    order_line.product_uom_qty,
+                )
+            else:
+                res = super(SaleOrderLineAgent, line)._compute_amount()
+        return res
+
+
+class SaleOrderLine(models.Model):
+    _inherit = "sale.order.line"
+
+    def _prepare_invoice_line(self, **optional_values):
+        vals = super()._prepare_invoice_line(**optional_values)
+        vals["agent_ids"] = [
+            (
+                0,
+                0,
+                {
+                    "agent_id": x.agent_id.id,
+                    "commission_id": x.commission_id.id,
+                },
+            )
+            for x in self.agent_ids
+        ]
+        return vals

odoo/addons/sale_commission_product_criteria/models/sale_commission_line_mixin.py

@@ -0,0 +1,78 @@
+# © 2023 ooops404
+# Copyright 2023 Simone Rubino - Aion Tech
+# License AGPL-3 - See https://www.gnu.org/licenses/agpl-3.0.html
+from odoo import fields, models
+
+
+class SaleCommissionLineMixin(models.AbstractModel):
+    _inherit = "commission.line.mixin"
+
+    applied_commission_id = fields.Many2one("commission", readonly=True)
+    commission_id = fields.Many2one(
+        comodel_name="commission",
+        ondelete="restrict",
+        required=False,
+        compute="_compute_commission_id",
+        store=True,
+        readonly=False,
+        copy=True,
+    )
+
+    def _get_commission_items(self, commission, product):
+        # Method replaced
+        categ_ids = {}
+        categ = product.categ_id
+        while categ:
+            categ_ids[categ.id] = True
+            categ = categ.parent_id
+        categ_ids = list(categ_ids)
+        # Select all suitable items. Order by best match
+        # (priority is: all/cat/subcat/product/variant).
+        self.env.cr.execute(
+            """
+            SELECT
+                item.id
+            FROM
+                commission_item AS item
+            LEFT JOIN product_category AS categ ON item.categ_id = categ.id
+            WHERE
+                (item.product_tmpl_id IS NULL OR item.product_tmpl_id = any(%s))
+                AND (item.product_id IS NULL OR item.product_id = any(%s))
+                AND (item.categ_id IS NULL OR item.categ_id = any(%s))
+                AND (item.commission_id = %s)
+                AND (item.active = TRUE)
+            ORDER BY
+                item.applied_on, item.based_on, categ.complete_name desc
+            """,
+            (
+                product.product_tmpl_id.ids,
+                product.ids,
+                categ_ids,
+                commission._origin.id,  # Added this
+            ),
+        )
+        item_ids = [x[0] for x in self.env.cr.fetchall()]
+        return item_ids
+
+    def _get_single_commission_amount(self, commission, subtotal, product, quantity):
+        self.ensure_one()
+        item_ids = self._get_commission_items(commission, product)
+        if not item_ids:
+            return 0.0
+        commission_item = self.env["commission.item"].browse(item_ids[0])
+        if commission.amount_base_type == "net_amount":
+            # If subtotal (sale_price * quantity) is less than
+            # standard_price * quantity, it means that we are selling at
+            # lower price than we bought, so set amount_base to 0
+            subtotal = max([0, subtotal - product.standard_price * quantity])
+        self.applied_commission_item_id = commission_item
+        # if self.agent_id.use_multi_type_commissions:
+        self.applied_commission_id = commission_item.commission_id
+        if commission_item.commission_type == "fixed":
+            return commission_item.fixed_amount
+        elif commission_item.commission_type == "percentage":
+            return subtotal * (commission_item.percent_amount / 100.0)
+
+    def _get_discount_value(self, commission_item):
+        # Will be overridden
+        return self.object_id.discount

odoo/addons/sale_commission_product_criteria/models/settlement.py

@@ -0,0 +1,7 @@
+# © 2023 ooops404
+# License AGPL-3 - See https://www.gnu.org/licenses/agpl-3.0.html
+from odoo import models
+
+
+class SettlementLine(models.Model):
+    _inherit = "commission.settlement.line"

odoo/addons/sale_commission_product_criteria/readme/CONTRIBUTORS.rst

@@ -0,0 +1,6 @@
+* `Ooops404 <https://www.ooops404.com>`__:
+
+  * Ilyas <irazor147@gmail.com>
+* `Aion Tech <https://aiontech.company/>`_:
+
+  * Simone Rubino <simone.rubino@aion-tech.it>

odoo/addons/sale_commission_product_criteria/readme/DESCRIPTION.rst

@@ -0,0 +1,16 @@
+This module allows to set in the same Commission Type different commission rates according to the product on SO/invoice line.
+
+This is made possible since this module adds a new "Product criteria" type to Commission Type and applies commission rates with the same logic of sale pricelist items.
+
+For example, such a Commission Type can grant:
+
+10% on a specific Product A,
+10$ on Product B,
+4% on products in Category 1 and
+5$ on all other products.
+
+In SO/invoice, system will apply different commissions based on variant/product/category or global, applied hierarchically. This means that for the example above, if product A is assigned to Category 1, commission assigned is 10%, as per variant/product/category/global rule application order.
+
+Furthermore, these commission type items can be accessed and created by a specific menu, to facilitate their management in environments with lots of records.
+
+The form for commission type item can be extended by future modules with further conditions to decide when to apply a specific item.

odoo/addons/sale_commission_product_criteria/readme/USAGE.rst

@@ -0,0 +1,7 @@
+To use features of this module, you need to:
+
+#. Go to Commissions > Configuration > Commission Types.
+#. Create a Commission Type with type = "Product criteria".
+#. Create multiple rules based on variant/product/category or global
+#. These rules will be sorted according to the same logic of sale pricelist.
+#. Rest flow is according to OCA sale_commission module.

odoo/addons/sale_commission_product_criteria/security/ir.model.access.csv

@@ -0,0 +1,3 @@
+id,name,model_id:id,group_id:id,perm_read,perm_write,perm_create,perm_unlink
+access_commission_item_manager,access_commission_item_manager,model_commission_item,sales_team.group_sale_manager,1,1,1,1
+access_commission_item_salesman,access_commission_item_salesman,model_commission_item,sales_team.group_sale_salesman,1,0,0,0