===========
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 <davide.corio@domsense.com>
- Joao Alfredo Gama Batista <joao.gama@savoirfairelinux.com>
- Sandy Carter <sandy.carter@savoirfairelinux.com>
- Giorgio Borelli <giorgio.borelli@abstract.it>
- Daniel Campos <danielcampos@avanzosc.es>
- Oihane Crucelaegui <oihanecruce@gmail.com>
- Nicola Malcontenti <nicola.malcontenti@agilebg.com>
- Aitor Bouzas <aitor.bouzas@adaptivecity.com>
- Alexei Rivera <arivera@archeti.com>
- `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.
Raw data
{
"_id": null,
"home_page": "https://github.com/OCA/commission",
"name": "odoo-addon-commission",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": null,
"author": "Tecnativa, Odoo Community Association (OCA)",
"author_email": "support@odoo-community.org",
"download_url": null,
"platform": null,
"description": "===========\nCommissions\n===========\n\n.. \n !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n !! This file is generated by oca-gen-addon-readme !!\n !! changes will be overwritten. !!\n !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n !! source digest: sha256:4a1843408e192ef9e46c57c949fb67d413b63d5cc9b4d628b6ef168ba3f10137\n !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n\n.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png\n :target: https://odoo-community.org/page/development-status\n :alt: Beta\n.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png\n :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html\n :alt: License: AGPL-3\n.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fcommission-lightgray.png?logo=github\n :target: https://github.com/OCA/commission/tree/17.0/commission\n :alt: OCA/commission\n.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png\n :target: https://translation.odoo-community.org/projects/commission-17-0/commission-17-0-commission\n :alt: Translate me on Weblate\n.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png\n :target: https://runboat.odoo-community.org/builds?repo=OCA/commission&target_branch=17.0\n :alt: Try me on Runboat\n\n|badge1| |badge2| |badge3| |badge4| |badge5|\n\nThis module provides the base functions for commission operations to\nenable the following:\n\n- Define agents with their commissions\n- Assign agents to partners\n- Create settlements to summarize commissions for certain periods\n\nYou can define which base amount is going to be taken into account: net\namount (based on margin) or gross amount (line subtotal amount).\n\n**Table of contents**\n\n.. contents::\n :local:\n\nConfiguration\n=============\n\nFor adding commissions:\n\n1. Go to *Commissions > Configuration > Commission types*.\n2. Edit or create a new record.\n3. Select a name for distinguishing that type.\n4. Select the percentage type of the commission:\n\n - **Fixed percentage**: all commissions are computed with a fixed\n percentage. You can fill the percentage in the field \"Fixed\n percentage\".\n - **By sections**: percentage varies depending amount intervals. You\n can fill intervals and percentages in the section \"Rate\n definition\".\n\n5. Select the base amount for computing the percentage:\n\n - **Sale/Invoice Amount**: percentage is computed from the amount\n put on sales order/invoice.\n - **Margin (Amount - Cost)**: percentage is computed from the profit\n only, taken the cost from the product.\n\nFor adding new agents:\n\n1. Go to *Commissions > Agents*. You can also access from *Contacts >\n Contacts* or *Sales > Orders > Customers*.\n\n2. Edit or create a new record.\n\n3. On \"Sales & Purchases\" page, mark \"Agent\" check. It should be checked\n if you have accessed from first menu option.\n\n4. There's a new page called \"Agent information\". In it, you can set\n following data:\n\n - The agent type, being in this base module \"External agent\" the\n only existing configuration. It can be extended with hr_commission\n module for setting an \"Employee\" agent type.\n - The associated commission type.\n - The settlement period, where you can select \"Bi-weekly\",\n \"Monthly\", \"Quaterly\", \"Semi-annual\" or \"Annual\".\n\n You will also be able to see the settlements that have been made to\n this agent from this page.\n\nUsage\n=====\n\nFor setting default agents in partners:\n\n1. Go to *Invoicing > Customers > Customers* or *Contacts > Contacts*.\n2. Edit or create a new record.\n3. On \"Sales & Purchases\" page, you will see a field called \"Agents\"\n where they can be added. You can put the number of agents you want,\n but you can't select specific commission for each partner in this\n base module.\n\nFor settling the commissions to agents:\n\n1. Go to *Commissions > Settlements > Settle Commissions*.\n2. On the window that appears, you should select the date up to which\n you want to create commissions. It should be at least one day after\n the last period date. For example, if you settlements are monthly,\n you have to put at least the first day of the following month.\n3. You can settle only certain agents if you select them on the \"Agents\"\n section. Leave it empty for settling all.\n4. Click on \"Make settlements\" button.\n5. If there are new settlements, they will be shown after this.\n\nKnown issues / Roadmap\n======================\n\n- Make it totally multi-company aware.\n- Set agent popup window with a kanban view with richer information and\n mobile friendly.\n\nBug Tracker\n===========\n\nBugs are tracked on `GitHub Issues <https://github.com/OCA/commission/issues>`_.\nIn case of trouble, please check there if your issue has already been reported.\nIf you spotted it first, help us to smash it by providing a detailed and welcomed\n`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**>`_.\n\nDo not contact contributors directly about support or help with technical issues.\n\nCredits\n=======\n\nAuthors\n-------\n\n* Tecnativa\n\nContributors\n------------\n\n- Pexego.\n- Davide Corio <davide.corio@domsense.com>\n- Joao Alfredo Gama Batista <joao.gama@savoirfairelinux.com>\n- Sandy Carter <sandy.carter@savoirfairelinux.com>\n- Giorgio Borelli <giorgio.borelli@abstract.it>\n- Daniel Campos <danielcampos@avanzosc.es>\n- Oihane Crucelaegui <oihanecruce@gmail.com>\n- Nicola Malcontenti <nicola.malcontenti@agilebg.com>\n- Aitor Bouzas <aitor.bouzas@adaptivecity.com>\n- Alexei Rivera <arivera@archeti.com>\n- `Tecnativa <https://www.tecnativa.com>`__:\n\n - Pedro M. Baeza\n - Manuel Calero\n\n- `Quartile <https://www.quartile.co>`__:\n\n - Aung Ko Ko Lin\n - Yoshi Tashiro\n\n- `Studio73 <https://www.studio73.es>`__:\n\n - Ethan Hildick\n\nMaintainers\n-----------\n\nThis module is maintained by the OCA.\n\n.. image:: https://odoo-community.org/logo.png\n :alt: Odoo Community Association\n :target: https://odoo-community.org\n\nOCA, or the Odoo Community Association, is a nonprofit organization whose\nmission is to support the collaborative development of Odoo features and\npromote its widespread use.\n\n.. |maintainer-pedrobaeza| image:: https://github.com/pedrobaeza.png?size=40px\n :target: https://github.com/pedrobaeza\n :alt: pedrobaeza\n\nCurrent `maintainer <https://odoo-community.org/page/maintainer-role>`__:\n\n|maintainer-pedrobaeza| \n\nThis module is part of the `OCA/commission <https://github.com/OCA/commission/tree/17.0/commission>`_ project on GitHub.\n\nYou are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.\n",
"bugtrack_url": null,
"license": "AGPL-3",
"summary": "Commissions",
"version": "17.0.1.0.0.7",
"project_urls": {
"Homepage": "https://github.com/OCA/commission"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a05aeafdadbf3d1c75f597305e1e69e3d98043551676df0394508cfbaa90e77b",
"md5": "ae5434cf6bc309e49c6875be1980f120",
"sha256": "0faf9d869b031fabe576fa5f3b1d69ee48c5495b3c7358304369df951bf7e5c5"
},
"downloads": -1,
"filename": "odoo_addon_commission-17.0.1.0.0.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ae5434cf6bc309e49c6875be1980f120",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 75240,
"upload_time": "2024-05-08T03:13:10",
"upload_time_iso_8601": "2024-05-08T03:13:10.034205Z",
"url": "https://files.pythonhosted.org/packages/a0/5a/eafdadbf3d1c75f597305e1e69e3d98043551676df0394508cfbaa90e77b/odoo_addon_commission-17.0.1.0.0.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-08 03:13:10",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "OCA",
"github_project": "commission",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "odoo-addon-commission"
}
JSON
