Author: |
Tecnativa, Odoo Community Association (OCA) |
License: |
AGPL-3 |
Branch: |
15.0 |
Repository: |
brain-tec/commission |
Dependencies: |
base,
product,
and
web |
Languages: |
HTML (440, 19.8%),
PO File (246, 11.0%),
Python (656, 29.5%),
SVG (99, 4.4%),
XML (605, 27.2%),
and
reStructuredText (181, 8.1%) |
Other branches: |
16.0 |
Other repositories: |
Change2improve/commission,
Confidere/openerp-extra-bundle,
Gabinete-Digital/commission,
OCA/commission,
Studio73/commission,
Tecnativa/commission,
a7madz90/openerp-extra-bundle,
ashokjaga/openerp-extra-bundle,
averni/openerp-extra-bundle,
bala4901/openerp-extra-bundle,
dw250100785/openerp-extra-bundle,
etorona1/openerp-extra-bundle,
mohitg1312/openerp-extra-bundle,
mostafasayed/openerp-extra-bundle,
nabilgeek/openerp-extra-bundle,
sandip-mangukiya/openerp-extra-bundle,
segarra89/openerp-extra-bundle,
sixtofarfan/openerp-extra-bundle,
slim1616/openerp-extra-bundle,
vincentcd/openerp-extra-bundle,
vnc-biz/openerp-extra-bundle,
and
zarumaru/commission |
<h1 class="title">Commissions</h1>
<p><a class="reference external" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external" href="https://github.com/OCA/commission/tree/15.0/commission"><img alt="OCA/commission" src="https://img.shields.io/badge/github-OCA%2Fcommission-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/commission-15-0/commission-15-0-commission"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external" href="https://runbot.odoo-community.org/runbot/165/15.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p>
<p>This module provides the base functions for commission operations to enable the
following:</p>
<ul class="simple">
<li>Define agents with their commissions</li>
<li>Assign agents to partners</li>
<li>Create settlements to summarize commissions for certain periods</li>
</ul>
<p>You can define which base amount is going to be taken into account: net amount
(based on margin) or gross amount (line subtotal amount).</p>
<p><strong>Table of contents</strong></p>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><a class="reference internal" href="#configuration" id="id1">Configuration</a></li>
<li><a class="reference internal" href="#usage" id="id2">Usage</a></li>
<li><a class="reference internal" href="#known-issues-roadmap" id="id3">Known issues / Roadmap</a></li>
<li><a class="reference internal" href="#bug-tracker" id="id4">Bug Tracker</a></li>
<li><a class="reference internal" href="#credits" id="id5">Credits</a><ul>
<li><a class="reference internal" href="#authors" id="id6">Authors</a></li>
<li><a class="reference internal" href="#contributors" id="id7">Contributors</a></li>
<li><a class="reference internal" href="#maintainers" id="id8">Maintainers</a></li>
</ul>
</li>
</ul>
</div>
<a name="configuration"></a>
<h2><a class="toc-backref" href="#id1">Configuration</a></h2>
<p>For adding commissions:</p>
<ol class="arabic simple">
<li>Go to <em>Commissions > Configuration > Commission types</em>.</li>
<li>Edit or create a new record.</li>
<li>Select a name for distinguishing that type.</li>
<li>Select the percentage type of the commission:<ul>
<li><strong>Fixed percentage</strong>: all commissions are computed with a fixed
percentage. You can fill the percentage in the field "Fixed percentage".</li>
<li><strong>By sections</strong>: percentage varies depending amount intervals. You can
fill intervals and percentages in the section "Rate definition".</li>
</ul>
</li>
<li>Select the base amount for computing the percentage:<ul>
<li><strong>Gross Amount</strong>: percentage is computed from the amount put on
sales order/invoice.</li>
<li><strong>Net Amount</strong>: percentage is computed from the profit only, taken the
cost from the product.</li>
</ul>
</li>
</ol>
<p>For adding new agents:</p>
<ol class="arabic">
<li><p class="first">Go to <em>Commissions > Agents</em>. You can also access from
<em>Contacts > Contacts</em> or <em>Sales > Orders > Customers</em>.</p>
</li>
<li><p class="first">Edit or create a new record.</p>
</li>
<li><p class="first">On "Sales & Purchases" page, mark "Agent" check. It should be checked if
you have accessed from first menu option.</p>
</li>
<li><p class="first">There's a new page called "Agent information". In it, you can set following
data:</p>
<ul class="simple">
<li>The agent type, being in this base module "External agent" the only
existing configuration. It can be extended with <cite>hr_commission</cite> module
for setting an "Employee" agent type.</li>
<li>The associated commission type.</li>
<li>The settlement period, where you can select "Bi-weekly", "Monthly", "Quaterly",
"Semi-annual" or "Annual".</li>
</ul>
<p>You will also be able to see the settlements that have been made to this
agent from this page.</p>
</li>
</ol>
<a name="usage"></a>
<h2><a class="toc-backref" href="#id2">Usage</a></h2>
<p>For setting default agents in partners:</p>
<ol class="arabic simple">
<li>Go to <em>Invoicing > Customers > Customers</em> or <em>Contacts > Contacts</em>.</li>
<li>Edit or create a new record.</li>
<li>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.</li>
</ol>
<p>For settling the commissions to agents:</p>
<ol class="arabic simple">
<li>Go to <em>Commissions > Settlements > Settle Commissions</em>.</li>
<li>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.</li>
<li>You can settle only certain agents if you select them on the "Agents"
section. Leave it empty for settling all.</li>
<li>Click on "Make settlements" button.</li>
<li>If there are new settlements, they will be shown after this.</li>
</ol>
<a name="known-issues-roadmap"></a>
<h2><a class="toc-backref" href="#id3">Known issues / Roadmap</a></h2>
<ul class="simple">
<li>Make it totally multi-company aware.</li>
<li>Be multi-currency aware for settlements.</li>
<li>Allow to calculate and pay in other currency different from company one.</li>
<li>Set agent popup window with a kanban view with richer information and
mobile friendly.</li>
</ul>
<a name="bug-tracker"></a>
<h2><a class="toc-backref" href="#id4">Bug Tracker</a></h2>
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/commission/issues">GitHub Issues</a>.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us smashing it by providing a detailed and welcomed
<a class="reference external" href="https://github.com/OCA/commission/issues/new?body=module:%20commission%0Aversion:%2015.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
<p>Do not contact contributors directly about support or help with technical issues.</p>
<a name="credits"></a>
<h2><a class="toc-backref" href="#id5">Credits</a></h2>
<a name="authors"></a>
<h3><a class="toc-backref" href="#id6">Authors</a></h3>
<ul class="simple">
<li>Tecnativa</li>
</ul>
<a name="contributors"></a>
<h3><a class="toc-backref" href="#id7">Contributors</a></h3>
<ul class="simple">
<li>Pexego.</li>
<li>Davide Corio <<a class="reference external" href="mailto:davide.corio@domsense.com">davide.corio@domsense.com</a>></li>
<li>Joao Alfredo Gama Batista <<a class="reference external" href="mailto:joao.gama@savoirfairelinux.com">joao.gama@savoirfairelinux.com</a>></li>
<li>Sandy Carter <<a class="reference external" href="mailto:sandy.carter@savoirfairelinux.com">sandy.carter@savoirfairelinux.com</a>></li>
<li>Giorgio Borelli <<a class="reference external" href="mailto:giorgio.borelli@abstract.it">giorgio.borelli@abstract.it</a>></li>
<li>Daniel Campos <<a class="reference external" href="mailto:danielcampos@avanzosc.es">danielcampos@avanzosc.es</a>></li>
<li>Oihane Crucelaegui <<a class="reference external" href="mailto:oihanecruce@gmail.com">oihanecruce@gmail.com</a>></li>
<li>Nicola Malcontenti <<a class="reference external" href="mailto:nicola.malcontenti@agilebg.com">nicola.malcontenti@agilebg.com</a>></li>
<li>Aitor Bouzas <<a class="reference external" href="mailto:aitor.bouzas@adaptivecity.com">aitor.bouzas@adaptivecity.com</a>></li>
<li><a class="reference external" href="https://www.tecnativa.com">Tecnativa</a>:<ul>
<li>Pedro M. Baeza</li>
<li>Manuel Calero</li>
</ul>
</li>
<li><a class="reference external" href="https://www.quartile.co">Quartile</a>:<ul>
<li>Aung Ko Ko Lin</li>
<li>Yoshi Tashiro</li>
</ul>
</li>
</ul>
<a name="maintainers"></a>
<h3><a class="toc-backref" href="#id8">Maintainers</a></h3>
<p>This module is maintained by the OCA.</p>
<a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a>
<p>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.</p>
<p>Current <a class="reference external" href="https://odoo-community.org/page/maintainer-role">maintainer</a>:</p>
<p><a class="reference external" href="https://github.com/pedrobaeza"><img alt="pedrobaeza" src="https://github.com/pedrobaeza.png?size=40px" /></a></p>
<p>This module is part of the <a class="reference external" href="https://github.com/OCA/commission/tree/15.0/commission">OCA/commission</a> project on GitHub.</p>
<p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p>