Update documentation of account credit limit
This commit is contained in:
Cédric Krier
@@ -20,57 +20,75 @@ Version 6.6.0 - 2022-10-31
|
||||
* Bug fixes (see mercurial logs for details)
|
||||
|
||||
Version 6.4.0 - 2022-05-02
|
||||
--------------------------
|
||||
* Bug fixes (see mercurial logs for details)
|
||||
* Add support for Python 3.10
|
||||
* Remove support for Python 3.6
|
||||
|
||||
Version 6.2.0 - 2021-11-01
|
||||
--------------------------
|
||||
* Bug fixes (see mercurial logs for details)
|
||||
|
||||
Version 6.0.0 - 2021-05-03
|
||||
--------------------------
|
||||
* Bug fixes (see mercurial logs for details)
|
||||
|
||||
Version 5.8.0 - 2020-11-02
|
||||
--------------------------
|
||||
* Bug fixes (see mercurial logs for details)
|
||||
* Remove support for Python 3.5
|
||||
|
||||
Version 5.6.0 - 2020-05-04
|
||||
--------------------------
|
||||
* Bug fixes (see mercurial logs for details)
|
||||
|
||||
Version 5.4.0 - 2019-11-04
|
||||
--------------------------
|
||||
* Bug fixes (see mercurial logs for details)
|
||||
|
||||
Version 5.2.0 - 2019-05-06
|
||||
--------------------------
|
||||
* Bug fixes (see mercurial logs for details)
|
||||
|
||||
Version 5.0.0 - 2018-10-01
|
||||
--------------------------
|
||||
* Bug fixes (see mercurial logs for details)
|
||||
* Remove support for Python 2.7
|
||||
|
||||
Version 4.8.0 - 2018-04-23
|
||||
--------------------------
|
||||
* Bug fixes (see mercurial logs for details)
|
||||
|
||||
Version 4.6.0 - 2017-10-30
|
||||
--------------------------
|
||||
* Bug fixes (see mercurial logs for details)
|
||||
|
||||
Version 4.4.0 - 2017-05-01
|
||||
--------------------------
|
||||
* Bug fixes (see mercurial logs for details)
|
||||
|
||||
Version 4.2.0 - 2016-11-28
|
||||
--------------------------
|
||||
* Bug fixes (see mercurial logs for details)
|
||||
|
||||
Version 4.0.0 - 2016-05-02
|
||||
--------------------------
|
||||
* Bug fixes (see mercurial logs for details)
|
||||
* Add Python3 support
|
||||
|
||||
Version 3.8.0 - 2015-11-02
|
||||
--------------------------
|
||||
* Bug fixes (see mercurial logs for details)
|
||||
|
||||
Version 3.6.0 - 2015-04-20
|
||||
--------------------------
|
||||
* Bug fixes (see mercurial logs for details)
|
||||
* Add support for PyPy
|
||||
|
||||
Version 3.4.0 - 2014-10-20
|
||||
--------------------------
|
||||
* Bug fixes (see mercurial logs for details)
|
||||
|
||||
Version 3.2.0 - 2014-04-21
|
||||
--------------------------
|
||||
* Initial release
|
||||
|
||||
@@ -0,0 +1,47 @@
|
||||
******
|
||||
Design
|
||||
******
|
||||
|
||||
The *Account Credit Limit Module* extends the following concepts:
|
||||
|
||||
.. _model-account.configuration:
|
||||
|
||||
Account Configuration
|
||||
=====================
|
||||
|
||||
When the *Account Credit Limit Module* is activated, the *Account
|
||||
Configuration* receives a new property which is used to store the default
|
||||
credit limit in the `Company <company:model-company.company>`'s currency.
|
||||
|
||||
.. seealso::
|
||||
|
||||
The `Account Configuration <account:model-account.configuration>` concept is
|
||||
introduced by the :doc:`Account Module <account:index>`.
|
||||
|
||||
.. _model-party.party:
|
||||
|
||||
Party
|
||||
=====
|
||||
|
||||
When the *Account Credit Limit Module* is activated, the *Party* gets a new
|
||||
property that is used to limit how much credit a party can have.
|
||||
|
||||
.. seealso::
|
||||
|
||||
The `Party <party:model-party.party>` concept is introduced by the
|
||||
:doc:`Party Module <party:index>`.
|
||||
|
||||
.. _model-account.dunning.level:
|
||||
|
||||
Dunning Level
|
||||
=============
|
||||
|
||||
When the *Account Credit Limit Module* is activated, the *Dunning Level* can be
|
||||
flagged to block any additional credit for the `Parties
|
||||
<party:model-party.party>` who have at least one pending `Dunning
|
||||
<account_dunning:model-account.dunning>` at that level.
|
||||
|
||||
.. seealso::
|
||||
|
||||
The `Dunning Level <account_dunning:model-account.dunning.level>` concept is
|
||||
introduced by the :doc:`Account Dunning Module <account_dunning:index>`.
|
||||
@@ -1,11 +1,12 @@
|
||||
####################
|
||||
Account Credit Limit
|
||||
####################
|
||||
|
||||
The account_credit_limit module manages credit limit of parties. A "Credit
|
||||
Limit Amount" is added on Party. The module allows to check for a party:
|
||||
The *Account Credit Limit Module* manages credit limits for parties.
|
||||
|
||||
* If an amount will exceed his limit.
|
||||
* If a dunning has reached a limit level.
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
and then raises an error message or a warning if the user is part of the
|
||||
"Account Credit Limit" group.
|
||||
design
|
||||
reference
|
||||
releases
|
||||
|
||||
@@ -0,0 +1,12 @@
|
||||
*************
|
||||
API Reference
|
||||
*************
|
||||
|
||||
Party
|
||||
=====
|
||||
|
||||
.. method:: Party.check_credit_limit(amount[, origin])
|
||||
|
||||
Raise an error if the amount, when credited to the party, reaches the credit
|
||||
limit.
|
||||
If origin is set then a warning is raised instead of an error.
|
||||
@@ -0,0 +1,7 @@
|
||||
.. _releases-index:
|
||||
|
||||
=============
|
||||
Release notes
|
||||
=============
|
||||
|
||||
.. include:: ../CHANGELOG
|
||||
@@ -11,9 +11,12 @@ from setuptools import find_packages, setup
|
||||
|
||||
|
||||
def read(fname):
|
||||
return io.open(
|
||||
content = io.open(
|
||||
os.path.join(os.path.dirname(__file__), fname),
|
||||
'r', encoding='utf-8').read()
|
||||
content = re.sub(
|
||||
r'(?m)^\.\. toctree::\r?\n((^$|^\s.*$)\r?\n)*', '', content)
|
||||
return content
|
||||
|
||||
|
||||
def get_require_version(name):
|
||||
@@ -59,7 +62,8 @@ setup(name=name,
|
||||
download_url=download_url,
|
||||
project_urls={
|
||||
"Bug Tracker": 'https://bugs.tryton.org/',
|
||||
"Documentation": 'https://docs.tryton.org/',
|
||||
"Documentation": (
|
||||
'https://docs.tryton.org/latest/modules-account-credit-limit'),
|
||||
"Forum": 'https://www.tryton.org/forum',
|
||||
"Source Code": 'https://code.tryton.org/tryton',
|
||||
},
|
||||
|
||||
Reference in New Issue
Block a user