Metadata-Version: 2.1
Name: trytond-commission
Version: 6.2.0
Summary: Tryton module for commission
Home-page: http://www.tryton.org/
Download-URL: http://downloads.tryton.org/6.2/
Author: Tryton
Author-email: bugs@tryton.org
License: GPL-3
Project-URL: Bug Tracker, https://bugs.tryton.org/
Project-URL: Documentation, https://docs.tryton.org/
Project-URL: Forum, https://www.tryton.org/forum
Project-URL: Source Code, https://hg.tryton.org/modules/commission
Keywords: tryton commission
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Plugins
Classifier: Framework :: Tryton
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Financial and Insurance Industry
Classifier: Intended Audience :: Legal Industry
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Natural Language :: Bulgarian
Classifier: Natural Language :: Catalan
Classifier: Natural Language :: Chinese (Simplified)
Classifier: Natural Language :: Czech
Classifier: Natural Language :: Dutch
Classifier: Natural Language :: English
Classifier: Natural Language :: Finnish
Classifier: Natural Language :: French
Classifier: Natural Language :: German
Classifier: Natural Language :: Hungarian
Classifier: Natural Language :: Indonesian
Classifier: Natural Language :: Italian
Classifier: Natural Language :: Persian
Classifier: Natural Language :: Polish
Classifier: Natural Language :: Portuguese (Brazilian)
Classifier: Natural Language :: Romanian
Classifier: Natural Language :: Russian
Classifier: Natural Language :: Slovenian
Classifier: Natural Language :: Spanish
Classifier: Natural Language :: Turkish
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Office/Business
Classifier: Topic :: Office/Business :: Financial :: Accounting
Requires-Python: >=3.6
Provides-Extra: sparklines
License-File: LICENSE

Commission Module
#################

The commission module allows to manage commission for sale's agent.
A commission move is created when posting the invoice, following the agent's
commission plan.

Agent
*****

An agent links a party with a commission plan and method.

- The *Plan* is the commission plan.
- The *Account* is the payable account on which the commission will be
  credited.
- The *Commission Method* defines when the commission will be due:
    - *On Posting*: when the invoice is posted.
    - *On Payment*: when the invoice is paid.

Commission Plan
***************

A plan contains a sets of lines that defines the formula to use to compute the
commission amount. The line is selected by choosing the first that matches the
criteria.

- The *Commission Product* is used to debit the commission using its expense
  account.

Line
----

- The *Formula* is a Python expression that will be evaluated with `amount` as
  the invoiced amount.

The criteria:

- *Product*.
