Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
128 changes: 128 additions & 0 deletions sale_commission_product_criteria_price_compliance/README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
===================================================
Sale Commission Product Criteria - Price Compliance
===================================================

..
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:5a14698bcd8b8675afc30805436f3ec9a21fc98576a90920f63e2200c73dc933
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

.. |badge1| image:: https://img.shields.io/badge/maturity-Alpha-red.png
:target: https://odoo-community.org/page/development-status
:alt: Alpha
.. |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%2Fcommission-lightgray.png?logo=github
:target: https://github.com/OCA/commission/tree/16.0/sale_commission_product_criteria_price_compliance
:alt: OCA/commission
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
:target: https://translation.odoo-community.org/projects/commission-16-0/commission-16-0-sale_commission_product_criteria_price_compliance
:alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
:target: https://runboat.odoo-community.org/builds?repo=OCA/commission&target_branch=16.0
:alt: Try me on Runboat

|badge1| |badge2| |badge3| |badge4| |badge5|

This module extends the functionality of commissions to support adding
Price Compliance Tiers to the Commission rules and to allow you to
manage Price Compliances commissions in this way.

.. IMPORTANT::
This is an alpha version, the data model and design can change at any time without warning.
Only for development or testing purpose, do not use in production.
`More details on development status <https://odoo-community.org/page/development-status>`_

**Table of contents**

.. contents::
:local:

Use Cases / Context
===================

This module was developed because we need to introduce Price Compliance
tiers on commissions.

It will be useful for you if you want to define commisions based on how
are doing our agents with Compliant Pricing.

Configuration
=============

To configure this module, you need to setup Commissions and Price
Compliance Tiers.

See documentation of Commission and Sale Price Compliance modules.

Usage
=====

To use this module, you need to:

1. Go to Commissions App > Configuration > Commision types.
2. Create a new Commission Type and set **Product criteria** on field
Type.
3. On rules, select the rule that you want and choose Product Criteria
Tier.
4. Create a Sale with an Agent and change price to change Product
Criteria Tier.
5. Continue with the main workflow to create an effective settlement
from a Sale.
6. Print settlement Report to see the Product Criteria Tier on each
Settlement Line.

Bug Tracker
===========

Bugs are tracked on `GitHub Issues <https://github.com/OCA/commission/issues>`_.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us to smash it by providing a detailed and welcomed
`feedback <https://github.com/OCA/commission/issues/new?body=module:%20sale_commission_product_criteria_price_compliance%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.

Do not contact contributors directly about support or help with technical issues.

Credits
=======

Authors
-------

* Moduon

Contributors
------------

- Eduardo de Miguel (`Moduon <https://www.moduon.team/>`__)

Maintainers
-----------

This module is maintained by the OCA.

.. image:: https://odoo-community.org/logo.png
:alt: Odoo Community Association
:target: https://odoo-community.org

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.

.. |maintainer-Shide| image:: https://github.com/Shide.png?size=40px
:target: https://github.com/Shide
:alt: Shide
.. |maintainer-rafaelbn| image:: https://github.com/rafaelbn.png?size=40px
:target: https://github.com/rafaelbn
:alt: rafaelbn

Current `maintainers <https://odoo-community.org/page/maintainer-role>`__:

|maintainer-Shide| |maintainer-rafaelbn|

This module is part of the `OCA/commission <https://github.com/OCA/commission/tree/16.0/sale_commission_product_criteria_price_compliance>`_ project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
from . import models
27 changes: 27 additions & 0 deletions sale_commission_product_criteria_price_compliance/__manifest__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Copyright 2026 Moduon Team S.L.
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl-3.0)

{
"name": "Sale Commission Product Criteria - Price Compliance",
"summary": "Commision rules for Pricing Compliance",
"version": "16.0.1.0.0",
"development_status": "Alpha",
"category": "Sales",
"website": "https://github.com/OCA/commission",
"author": "Moduon, Odoo Community Association (OCA)",
"maintainers": ["Shide", "rafaelbn"],
"license": "AGPL-3",
"application": False,
"installable": True,
"depends": [
"sale_commission_product_criteria",
"sale_price_compliance",
],
"data": [
"views/commission_view.xml",
"views/commission_item_view.xml",
"views/commission_settlement_view.xml",
"views/commission_settlement_line_view.xml",
"report/report_settlement_templates.xml",
],
}
60 changes: 60 additions & 0 deletions sale_commission_product_criteria_price_compliance/i18n/es.po
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
# Translation of Odoo Server.
# This file contains the translation of the following modules:
# * sale_commission_product_criteria_price_compliance
#
msgid ""
msgstr ""
"Project-Id-Version: Odoo Server 16.0\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2026-02-19 11:13+0000\n"
"PO-Revision-Date: 2026-02-19 12:14+0100\n"
"Last-Translator: \n"
"Language-Team: \n"
"Language: es\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
"Plural-Forms: nplurals=2; plural=(n != 1);\n"
"X-Generator: Poedit 3.6\n"

#. module: sale_commission_product_criteria_price_compliance
#: model:ir.model,name:sale_commission_product_criteria_price_compliance.model_commission_item
msgid "Commission Item"
msgstr "Detalle de la comisión"

#. module: sale_commission_product_criteria_price_compliance
#: model:ir.model.fields,help:sale_commission_product_criteria_price_compliance.field_commission_item__price_compliance_tier
#: model:ir.model.fields,help:sale_commission_product_criteria_price_compliance.field_commission_settlement_line__price_compliance_tier
msgid ""
"Indicates the Tier of Price Compliance based on the unit price and applied "
"discount compared to defined thresholds."
msgstr ""
"Indica el tramo del Cumplimiento de Precios basado en el precio unitario y "
"el descuento aplicado comparado con los tramos definidos."

#. module: sale_commission_product_criteria_price_compliance
#: model:ir.model,name:sale_commission_product_criteria_price_compliance.model_commission_settlement_line
msgid "Line of a commission settlement"
msgstr "Línea de liquidación de una comisión"

#. module: sale_commission_product_criteria_price_compliance
#: model:ir.model,name:sale_commission_product_criteria_price_compliance.model_commission_line_mixin
msgid ""
"Mixin model for having commission agent lines in any object inheriting from "
"this one"
msgstr ""
"Modelo de mezclador para tener líneas de comisionista en cualquier objeto "
"que herede de éste"

#. module: sale_commission_product_criteria_price_compliance
#: model_terms:ir.ui.view,arch_db:sale_commission_product_criteria_price_compliance.report_settlement_document
msgid "Price Compliance"
msgstr "Cumplimiento de Precios"

#. module: sale_commission_product_criteria_price_compliance
#: model:ir.model.fields,field_description:sale_commission_product_criteria_price_compliance.field_commission_item__price_compliance_tier
#: model:ir.model.fields,field_description:sale_commission_product_criteria_price_compliance.field_commission_settlement_line__price_compliance_tier
#: model_terms:ir.ui.view,arch_db:sale_commission_product_criteria_price_compliance.commission_item_search
#: model_terms:ir.ui.view,arch_db:sale_commission_product_criteria_price_compliance.view_settlement_line_search
msgid "Price Compliance Tier"
msgstr "Nivel de cumplimiento de precios"
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# Translation of Odoo Server.
# This file contains the translation of the following modules:
# * sale_commission_product_criteria_price_compliance
#
msgid ""
msgstr ""
"Project-Id-Version: Odoo Server 16.0\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2026-02-19 11:13+0000\n"
"PO-Revision-Date: 2026-02-19 11:13+0000\n"
"Last-Translator: \n"
"Language-Team: \n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: \n"
"Plural-Forms: \n"

#. module: sale_commission_product_criteria_price_compliance
#: model:ir.model,name:sale_commission_product_criteria_price_compliance.model_commission_item
msgid "Commission Item"
msgstr ""

#. module: sale_commission_product_criteria_price_compliance
#: model:ir.model.fields,help:sale_commission_product_criteria_price_compliance.field_commission_item__price_compliance_tier
#: model:ir.model.fields,help:sale_commission_product_criteria_price_compliance.field_commission_settlement_line__price_compliance_tier
msgid ""
"Indicates the Tier of Price Compliance based on the unit price and applied "
"discount compared to defined thresholds."
msgstr ""

#. module: sale_commission_product_criteria_price_compliance
#: model:ir.model,name:sale_commission_product_criteria_price_compliance.model_commission_settlement_line
msgid "Line of a commission settlement"
msgstr ""

#. module: sale_commission_product_criteria_price_compliance
#: model:ir.model,name:sale_commission_product_criteria_price_compliance.model_commission_line_mixin
msgid ""
"Mixin model for having commission agent lines in any object inheriting from "
"this one"
msgstr ""

#. module: sale_commission_product_criteria_price_compliance
#: model_terms:ir.ui.view,arch_db:sale_commission_product_criteria_price_compliance.report_settlement_document
msgid "Price Compliance"
msgstr ""

#. module: sale_commission_product_criteria_price_compliance
#: model:ir.model.fields,field_description:sale_commission_product_criteria_price_compliance.field_commission_item__price_compliance_tier
#: model:ir.model.fields,field_description:sale_commission_product_criteria_price_compliance.field_commission_settlement_line__price_compliance_tier
#: model_terms:ir.ui.view,arch_db:sale_commission_product_criteria_price_compliance.commission_item_search
#: model_terms:ir.ui.view,arch_db:sale_commission_product_criteria_price_compliance.view_settlement_line_search
msgid "Price Compliance Tier"
msgstr ""
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
from . import commission_item
from . import commission_settlement_line
from . import sale_commission_line_mixin
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Copyright 2026 Moduon Team S.L.
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl-3.0)

from odoo import api, fields, models


class CommissionItem(models.Model):
_name = "commission.item"
_inherit = ["commission.item", "product.price.compliance.threshold.tier.mixin"]
_order = "applied_on, based_on, categ_id desc, price_compliance_tier asc, id desc"

price_compliance_tier = fields.Selection(
readonly=False,
)

@api.model
def _get_price_compliance_selection_tiers(self):
"""Dislay texts on selection instead of icon colors."""
return self._get_price_compliance_selection_tiers_text()
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Copyright 2026 Moduon Team S.L.
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl-3.0)

from odoo import api, fields, models


class CommissionSettlementLine(models.AbstractModel):
_name = "commission.settlement.line"
_inherit = [
"commission.settlement.line",
"product.price.compliance.threshold.tier.mixin",
]

price_compliance_tier = fields.Selection(
compute="_compute_price_compliance_tier",
store=True,
)

@api.model
def _get_price_compliance_selection_tiers(self):
"""Dislay texts on selection instead of icon colors."""
return self._get_price_compliance_selection_tiers_text()

@api.depends("invoice_line_id")
def _compute_price_compliance_tier(self):
for settlement_line in self:
# Get the first one
sale_line = settlement_line.invoice_line_id.sale_line_ids[:1]
settlement_line.price_compliance_tier = sale_line.price_compliance_tier
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Copyright 2026 Moduon Team S.L.
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl-3.0)

from odoo import models


class SaleCommissionLineMixin(models.AbstractModel):
_inherit = "commission.line.mixin"

def _commission_items_query_params(self, commission, product):
res = super()._commission_items_query_params(commission, product)
# Find the sale.order.line related to its price_compliance_tier
sale_line = None
if self.object_id._name == "sale.order.line":
sale_line = self.object_id
elif self.object_id._name == "account.move.line":
sale_line = self.object_id.sale_line_ids[:1] # Choose the first one
res["price_compliance_tier"] = (
sale_line and sale_line.price_compliance_tier or None
)
return res

def _commission_items_where(self):
res = super()._commission_items_where()
res = f"""{res} AND (
item.price_compliance_tier IS NULL
OR item.price_compliance_tier = %(price_compliance_tier)s
)""" # noqa: E202
return res

def _commission_items_order(self):
res = super()._commission_items_order()
res = f"item.price_compliance_tier asc, {res}"
return res
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
To configure this module, you need to setup Commissions and Price Compliance Tiers.

See documentation of Commission and Sale Price Compliance modules.
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
This module was developed because we need to introduce Price Compliance tiers on commissions.

It will be useful for you if you want to define commisions based on how are doing our agents with Compliant Pricing.
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
- Eduardo de Miguel ([Moduon](https://www.moduon.team/))
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@

This module extends the functionality of commissions to support adding Price Compliance Tiers to the Commission rules and to allow you to manage Price Compliances commissions in this way.
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
To use this module, you need to:

1. Go to Commissions App > Configuration > Commision types.
1. Create a new Commission Type and set **Product criteria** on field Type.
1. On rules, select the rule that you want and choose Product Criteria Tier.
1. Create a Sale with an Agent and change price to change Product Criteria Tier.
1. Continue with the main workflow to create an effective settlement from a Sale.
1. Print settlement Report to see the Product Criteria Tier on each Settlement Line.

Loading
Loading