Syncing from upstream OCA/commission (17.0)

README.md

@@ -17,7 +17,11 @@ TODO: add repo description.
 
 [//]: # (addons)
 
-This part will be replaced when running the oca-gen-addons-table script from OCA/maintainer-tools.
+Available addons
+----------------
+addon | version | maintainers | summary
+--- | --- | --- | ---
+[commission](commission/) | 17.0.1.0.0 | [![pedrobaeza](https://github.com/pedrobaeza.png?size=30px)](https://github.com/pedrobaeza) | Commissions
 
 [//]: # (end addons)
 

commission/README.rst

@@ -0,0 +1,192 @@
+===========
+Commissions
+===========
+
+.. 
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! This file is generated by oca-gen-addon-readme !!
+   !! changes will be overwritten.                   !!
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! source digest: sha256:4a1843408e192ef9e46c57c949fb67d413b63d5cc9b4d628b6ef168ba3f10137
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
+    :target: https://odoo-community.org/page/development-status
+    :alt: Beta
+.. |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/17.0/commission
+    :alt: OCA/commission
+.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
+    :target: https://translation.odoo-community.org/projects/commission-17-0/commission-17-0-commission
+    :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=17.0
+    :alt: Try me on Runboat
+
+|badge1| |badge2| |badge3| |badge4| |badge5|
+
+This module provides the base functions for commission operations to
+enable the following:
+
+-  Define agents with their commissions
+-  Assign agents to partners
+-  Create settlements to summarize commissions for certain periods
+
+You can define which base amount is going to be taken into account: net
+amount (based on margin) or gross amount (line subtotal amount).
+
+**Table of contents**
+
+.. contents::
+   :local:
+
+Configuration
+=============
+
+For adding commissions:
+
+1. Go to *Commissions > Configuration > Commission types*.
+2. Edit or create a new record.
+3. Select a name for distinguishing that type.
+4. Select the percentage type of the commission:
+
+   -  **Fixed percentage**: all commissions are computed with a fixed
+      percentage. You can fill the percentage in the field "Fixed
+      percentage".
+   -  **By sections**: percentage varies depending amount intervals. You
+      can fill intervals and percentages in the section "Rate
+      definition".
+
+5. Select the base amount for computing the percentage:
+
+   -  **Sale/Invoice Amount**: percentage is computed from the amount
+      put on sales order/invoice.
+   -  **Margin (Amount - Cost)**: percentage is computed from the profit
+      only, taken the cost from the product.
+
+For adding new agents:
+
+1. Go to *Commissions > Agents*. You can also access from *Contacts >
+   Contacts* or *Sales > Orders > Customers*.
+
+2. Edit or create a new record.
+
+3. On "Sales & Purchases" page, mark "Agent" check. It should be checked
+   if you have accessed from first menu option.
+
+4. There's a new page called "Agent information". In it, you can set
+   following data:
+
+   -  The agent type, being in this base module "External agent" the
+      only existing configuration. It can be extended with hr_commission
+      module for setting an "Employee" agent type.
+   -  The associated commission type.
+   -  The settlement period, where you can select "Bi-weekly",
+      "Monthly", "Quaterly", "Semi-annual" or "Annual".
+
+   You will also be able to see the settlements that have been made to
+   this agent from this page.
+
+Usage
+=====
+
+For setting default agents in partners:
+
+1. Go to *Invoicing > Customers > Customers* or *Contacts > Contacts*.
+2. Edit or create a new record.
+3. On "Sales & Purchases" page, you will see a field called "Agents"
+   where they can be added. You can put the number of agents you want,
+   but you can't select specific commission for each partner in this
+   base module.
+
+For settling the commissions to agents:
+
+1. Go to *Commissions > Settlements > Settle Commissions*.
+2. On the window that appears, you should select the date up to which
+   you want to create commissions. It should be at least one day after
+   the last period date. For example, if you settlements are monthly,
+   you have to put at least the first day of the following month.
+3. You can settle only certain agents if you select them on the "Agents"
+   section. Leave it empty for settling all.
+4. Click on "Make settlements" button.
+5. If there are new settlements, they will be shown after this.
+
+Known issues / Roadmap
+======================
+
+-  Make it totally multi-company aware.
+-  Set agent popup window with a kanban view with richer information and
+   mobile friendly.
+
+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:%20commission%0Aversion:%2017.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
+-------
+
+* Tecnativa
+
+Contributors
+------------
+
+-  Pexego.
+-  Davide Corio <[email protected]>
+-  Joao Alfredo Gama Batista <[email protected]>
+-  Sandy Carter <[email protected]>
+-  Giorgio Borelli <[email protected]>
+-  Daniel Campos <[email protected]>
+-  Oihane Crucelaegui <[email protected]>
+-  Nicola Malcontenti <[email protected]>
+-  Aitor Bouzas <[email protected]>
+-  Alexei Rivera <[email protected]>
+-  `Tecnativa <https://www.tecnativa.com>`__:
+
+   -  Pedro M. Baeza
+   -  Manuel Calero
+
+-  `Quartile <https://www.quartile.co>`__:
+
+   -  Aung Ko Ko Lin
+   -  Yoshi Tashiro
+
+-  `Studio73 <https://www.studio73.es>`__:
+
+   -  Ethan Hildick
+
+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-pedrobaeza| image:: https://github.com/pedrobaeza.png?size=40px
+    :target: https://github.com/pedrobaeza
+    :alt: pedrobaeza
+
+Current `maintainer <https://odoo-community.org/page/maintainer-role>`__:
+
+|maintainer-pedrobaeza| 
+
+This module is part of the `OCA/commission <https://github.com/OCA/commission/tree/17.0/commission>`_ project on GitHub.
+
+You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

commission/__init__.py

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

commission/__manifest__.py

@@ -0,0 +1,28 @@
+# Copyright 2020 Tecnativa - Manuel Calero
+# Copyright 2022 Quartile
+# Copyright 2014-2022 Tecnativa - Pedro M. Baeza
+{
+    "name": "Commissions",
+    "version": "17.0.1.0.0",
+    "author": "Tecnativa, Odoo Community Association (OCA)",
+    "category": "Invoicing",
+    "license": "AGPL-3",
+    "depends": ["product"],
+    "website": "https://github.com/OCA/commission",
+    "maintainers": ["pedrobaeza"],
+    "data": [
+        "security/commission_security.xml",
+        "security/ir.model.access.csv",
+        "data/menuitem_data.xml",
+        "views/commission_views.xml",
+        "views/commission_settlement_views.xml",
+        "views/commission_mixin_views.xml",
+        "views/product_template_views.xml",
+        "views/res_partner_views.xml",
+        "reports/commission_settlement_report.xml",
+        "reports/report_settlement_templates.xml",
+        "wizards/commission_make_settle_views.xml",
+    ],
+    "demo": ["demo/commission_and_agent_demo.xml"],
+    "installable": True,
+}

commission/data/menuitem_data.xml

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<odoo>
+    <menuitem
+        name="Commissions"
+        id="menu_commission"
+        groups="group_commission_user"
+        web_icon="commission,static/description/icon.png"
+        sequence="50"
+    />
+    <menuitem
+        name="Configuration"
+        id="menu_commission_management"
+        parent="menu_commission"
+        groups="group_commission_manager"
+        sequence="100"
+    />
+</odoo>

commission/demo/commission_and_agent_demo.xml

@@ -0,0 +1,36 @@
+<?xml version="1.0" ?>
+<odoo>
+    <!-- Create the Commission Types -->
+    <record id="demo_commission" model="commission">
+        <field name="name">10% fixed commission - Invoice Based</field>
+        <field name="fix_qty">10.0</field>
+    </record>
+    <!-- Create de Agents -->
+    <record id="res_partner_pritesh_sale_agent" model="res.partner">
+        <field name="name">Pritesh Sales Agent</field>
+        <field name="city">Ahmedabad</field>
+        <field name="zip">380007</field>
+        <field name="country_id" model="res.country" search="[('name','=','India')]" />
+        <field name="street">56 Beijing street</field>
+        <field name="agent" eval="1" />
+        <field name="commission_id" ref="demo_commission" />
+    </record>
+    <record id="res_partner_eiffel_sale_agent" model="res.partner">
+        <field name="name">Eiffel pvt ltd</field>
+        <field name="city">Ahmedabad</field>
+        <field name="zip">380007</field>
+        <field name="country_id" model="res.country" search="[('name','=','India')]" />
+        <field name="street">Wall Street 2</field>
+        <field name="agent" eval="1" />
+        <field name="commission_id" ref="demo_commission" />
+    </record>
+    <record id="res_partner_tiny_sale_agent" model="res.partner">
+        <field name="name">Tiny Belgium</field>
+        <field name="city">Belgium</field>
+        <field name="zip">2457</field>
+        <field name="country_id" model="res.country" search="[('name','=','India')]" />
+        <field name="street">Belgium Gao</field>
+        <field name="agent" eval="1" />
+        <field name="commission_id" ref="demo_commission" />
+    </record>
+</odoo>