diff --git a/modules/account_dunning/CHANGELOG b/modules/account_dunning/CHANGELOG index 3990baa7b7..e60dbadbbf 100644 --- a/modules/account_dunning/CHANGELOG +++ b/modules/account_dunning/CHANGELOG @@ -20,66 +20,84 @@ 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) * Add date and age to dunning * Add wizard to reschedule dunning 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) * Add final state and rename done into waiting * 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) * Change days into timedelta overdue 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 dunning_procedure property on Move Line * 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 +-------------------------- * Bug fixes (see mercurial logs for details) Version 3.0.0 - 2013-10-21 +-------------------------- * Initial release diff --git a/modules/account_dunning/doc/design.rst b/modules/account_dunning/doc/design.rst new file mode 100644 index 0000000000..c54c6fbf0f --- /dev/null +++ b/modules/account_dunning/doc/design.rst @@ -0,0 +1,128 @@ +****** +Design +****** + +The *Account Dunning Module* introduces the following concepts: + +.. _model-account.dunning.procedure: + +Dunning Procedure +================= + +A *Dunning Procedure* defines the steps to be followed for overdue `receivables +`. +The steps are defined by an ordered list of `Levels +`. + +.. seealso:: + + A list of the Dunning Procedures is available from the main menu item: + + |Financial --> Configuration --> Dunnings --> Procedures|__ + + .. |Financial --> Configuration --> Dunnings --> Procedures| replace:: :menuselection:`Financial --> Configuration --> Dunnings --> Procedures` + __ https://demo.tryton.org/model/account.dunning.procedure + +.. _model-account.dunning.level: + +Dunning Level +============= + +Each level contains the criteria, such as the overdue duration, that a `Dunning +` must meet to reach it. + +.. _model-account.dunning: + +Dunning +======= + +A *Dunning* follows the dunning process for an overdue receivable `Move Line +` through the levels of the linked `Procedure +`. + +It is possible to block a dunning from going onto a later level. + +Once the move line is reconciled, the dunning is automatically removed. + +.. seealso:: + + The Dunnings can be found by opening the main menu item: + + |Financial --> Dunnings --> Dunnings|__ + + .. |Financial --> Dunnings --> Dunnings| replace:: :menuselection:`Financial --> Dunnings --> Dunnings` + __ https://demo.tryton.org/model/account.dunning + +Wizards +------- + +.. _wizard-account.dunning.create: + +Create Dunnings +^^^^^^^^^^^^^^^ + +The *Create Dunnings* wizard creates the `Dunnings ` for +each receivable `Line ` that is more overdue +then the entered date and increases the level of the waiting dunnings if they +meet the criteria. + +.. seealso:: + + The Create Dunnings wizard can be launch from the main menu item: + + |Financial --> Dunnings --> Create Dunnings|__ + + .. |Financial --> Dunnings --> Create Dunnings| replace:: :menuselection:`Financial --> Dunnings --> Create Dunnings` + __ https://demo.tryton.org/wizard/account.dunning.create + +.. _wizard-account.dunning.process: + +Process Dunning +^^^^^^^^^^^^^^^ + +The *Process Dunning* wizard performs the actions required for the level of the +selected draft `Dunnings ` and puts them in a waiting +state. + +.. note:: + + As the action for a certain level can be grouped by `Party + `, the wizard is launched from the list of + *Dunnings*. + +.. _wizard-account.dunning.reschedule: + +Reschedule Dunning +^^^^^^^^^^^^^^^^^^ + +The *Reschedule Dunning* wizard launches the `Reschedule Lines +` wizard for the `Dunning +`'s `Line `. + +.. _model-party.party: + +Party +===== + +When the *Account Dunning Module* is activated, it is possible to define the +`Dunning Procedure ` to follow for the party's +overdue `Lines `. + +.. seealso:: + + The `Party ` concept is introduced by the + :doc:`Party Module `. + +.. _model-account.configuration: + +Account Configuration +===================== + +When the *Account Dunning Module* is activated, the *Account Configuration* +gets a new property that is used to set the default `Dunning Procedure +` for new `Parties `. + +.. seealso:: + + The `Account Configuration ` concept is + introduced by the :doc:`Account Module `. diff --git a/modules/account_dunning/doc/index.rst b/modules/account_dunning/doc/index.rst index b39675cbd0..4a3b5bd308 100644 --- a/modules/account_dunning/doc/index.rst +++ b/modules/account_dunning/doc/index.rst @@ -1,46 +1,12 @@ +###################### Account Dunning Module ###################### -The account_dunning module adds dunning for receivable move lines. +The *Account Dunning Module* manages dunning process of chasing customers for +payment of receivable lines. -Procedure -********* +.. toctree:: + :maxdepth: 2 -A *Procedure* defines the dunning process with an ordered list of levels. -A dunning will raise from one level to an other by selecting the next level -that pass the test. -The Procedure is set per *Party* and a default one can be configured in the -accounting configuration. - -Level -***** - -A *Level* defines the parameters to reach it: - -- Days: The number of overdue days. - -Dunning -******* - -A *Dunning* defines the dunning level of an overdue move line. Once processed, -it triggers the communication defined on the procedure level. It is mainly -defined by: - -- Line: The overdue move line -- Procedure: The *Procedure* followed. -- Level: The current *Level*. -- Blocked: If true, it blocks the dunning to raise. - -The dunning can be in one of these states: - -* Draft - - The current level is not yet processed. - -* Waiting - - The current level has been processed. - -* Final - - All levels have been processed. + design + releases diff --git a/modules/account_dunning/doc/releases.rst b/modules/account_dunning/doc/releases.rst new file mode 100644 index 0000000000..21b13c4745 --- /dev/null +++ b/modules/account_dunning/doc/releases.rst @@ -0,0 +1,7 @@ +.. _releases-index: + +============= +Release notes +============= + +.. include:: ../CHANGELOG diff --git a/modules/account_dunning/setup.py b/modules/account_dunning/setup.py index d52450db96..c0b902908a 100755 --- a/modules/account_dunning/setup.py +++ b/modules/account_dunning/setup.py @@ -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): @@ -58,7 +61,8 @@ setup(name=name, url='http://www.tryton.org/', project_urls={ "Bug Tracker": 'https://bugs.tryton.org/', - "Documentation": 'https://docs.tryton.org/', + "Documentation": ( + 'https://docs.tryton.org/latest/modules-account-dunning'), "Forum": 'https://www.tryton.org/forum', "Source Code": 'https://code.tryton.org/tryton', }, diff --git a/modules/account_dunning_email/CHANGELOG b/modules/account_dunning_email/CHANGELOG index 46a7c0c2bb..3afb7e8fc3 100644 --- a/modules/account_dunning_email/CHANGELOG +++ b/modules/account_dunning_email/CHANGELOG @@ -21,38 +21,48 @@ 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) * Allow different FROM per language 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) * Add contact mechanism usage * Add fall-back user * 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 +-------------------------- * Initial release diff --git a/modules/account_dunning_email/doc/design.rst b/modules/account_dunning_email/doc/design.rst new file mode 100644 index 0000000000..c7e54f9652 --- /dev/null +++ b/modules/account_dunning_email/doc/design.rst @@ -0,0 +1,34 @@ +****** +Design +****** + +The *Account Dunning Email Module* extends the following concepts: + +.. _model-account.dunning.level: + +Dunning Level +============= + +The *Dunning Level* is extended with the ability to send an email when the +*Dunning Level* is processed. +The email is based on a `Report ` that uses the +`Dunning ` record in the template. + +.. seealso:: + + The `Dunning Level ` concept is + introduced by the :doc:`Account Dunning Module `. + +.. _model-account.configuration: + +Account Configuration +===================== + +When the *Account Dunning Email Module* is activated, a fall-back `User +` can be set in the *Account Configuration*. +The dunning emails will be sent to this *User* if no other e-mail is found. + +.. seealso:: + + The `Account Configuration ` concept is + introduced by the :doc:`Account Module `. diff --git a/modules/account_dunning_email/doc/index.rst b/modules/account_dunning_email/doc/index.rst index 7596b5bec2..99d2080d4e 100644 --- a/modules/account_dunning_email/doc/index.rst +++ b/modules/account_dunning_email/doc/index.rst @@ -1,7 +1,12 @@ +############################ Account Dunning Email Module ############################ -The account_dunning_email module sends a dunning email to the party email -contact after the process of dunnings for those which are at a level with *Send -Email* checked. -The template of the email is defined on the level. +The *Account Dunning Email Module* allows dunning levels to be set up so that +an email is sent when the dunnings are processed. + +.. toctree:: + :maxdepth: 2 + + design + releases diff --git a/modules/account_dunning_email/doc/releases.rst b/modules/account_dunning_email/doc/releases.rst new file mode 100644 index 0000000000..21b13c4745 --- /dev/null +++ b/modules/account_dunning_email/doc/releases.rst @@ -0,0 +1,7 @@ +.. _releases-index: + +============= +Release notes +============= + +.. include:: ../CHANGELOG diff --git a/modules/account_dunning_email/setup.py b/modules/account_dunning_email/setup.py index 6706e86cfd..4cbf3292f0 100755 --- a/modules/account_dunning_email/setup.py +++ b/modules/account_dunning_email/setup.py @@ -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-dunning-email'), "Forum": 'https://www.tryton.org/forum', "Source Code": 'https://code.tryton.org/tryton', }, diff --git a/modules/account_dunning_email/tryton.cfg b/modules/account_dunning_email/tryton.cfg index 34d0c28089..b35416d6db 100644 --- a/modules/account_dunning_email/tryton.cfg +++ b/modules/account_dunning_email/tryton.cfg @@ -1,6 +1,7 @@ [tryton] version=7.3.0 depends: + account account_dunning account_dunning_letter ir diff --git a/modules/account_dunning_fee/CHANGELOG b/modules/account_dunning_fee/CHANGELOG index 486cec97cc..8bbc587758 100644 --- a/modules/account_dunning_fee/CHANGELOG +++ b/modules/account_dunning_fee/CHANGELOG @@ -20,41 +20,53 @@ 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 +-------------------------- * Initial release diff --git a/modules/account_dunning_fee/doc/design.rst b/modules/account_dunning_fee/doc/design.rst new file mode 100644 index 0000000000..a266aab179 --- /dev/null +++ b/modules/account_dunning_fee/doc/design.rst @@ -0,0 +1,65 @@ +****** +Design +****** + +The *Account Dunning Fee Module* introduces or extends the following concepts: + +.. _model-account.dunning.fee: + +Dunning Fee +=========== + +A *Dunning Fee* defines how to calculate and post a fee for a `Dunning +`. + +.. seealso:: + + The Dunning Fees are available from the main menu item: + + |Financial --> Configuration --> Dunnings --> Fees|__ + + .. |Financial --> Configuration --> Dunnings --> Fees| replace:: :menuselection:`Financial --> Configuration --> Dunnings --> Fees` + __ https://demo.tryton.org/model/account.dunning.fee + +.. _model-account.dunning.level: + +Dunning Level +============= + +The *Dunning Level* can be set up with a `Fee ` that +will be applied when the `Dunning ` +reaches that *Level*. + +.. seealso:: + + The `Dunning Level ` concept is + introduced by the :doc:`Account Dunning Module `. + +.. _model-account.dunning: + +Dunning +======= + +The *Dunning* is extended to list the fees that were applied to it. + +.. seealso:: + + The `Dunning ` concept is introduced + by the :doc:`Account Dunning Module `. + +Reports +------- + +.. _report.account.dunning.letter: + +Dunning Letter +^^^^^^^^^^^^^^ + +The *Dunning Letter* is extended to render the total amount of fees applied to +each `Dunning `. + +.. seealso:: + + The `Dunning Letter ` + report is introduced by the :doc:`Account Dunning Letter Module + `. diff --git a/modules/account_dunning_fee/doc/index.rst b/modules/account_dunning_fee/doc/index.rst index f6467b69fb..bbe2d9af11 100644 --- a/modules/account_dunning_fee/doc/index.rst +++ b/modules/account_dunning_fee/doc/index.rst @@ -1,22 +1,12 @@ +########################## Account Dunning Fee Module ########################## -The account_dunning_fee module allows to generate accounting moves as fees when -processing dunning which are at a level with a *Fee* defined. +The *Account Dunning Fee Module* allows a fee to be added when a dunning +reaches a certain level. -The accounting move debit the fee amount from the same account as the due line -and credit the revenue account of the product. Only one move is created per -dunning and level. +.. toctree:: + :maxdepth: 2 -Fee -*** - -A *Fee* defines the parameters to apply the fee: - -- Name: The string that will be used as account move description. -- Product: The service product that represent the fee. -- Journal: The journal on which the move will be posted. -- Compute Method: - - - List Price: The list price of the product. - - Percentage: A percentage of the due amount. + design + releases diff --git a/modules/account_dunning_fee/doc/releases.rst b/modules/account_dunning_fee/doc/releases.rst new file mode 100644 index 0000000000..21b13c4745 --- /dev/null +++ b/modules/account_dunning_fee/doc/releases.rst @@ -0,0 +1,7 @@ +.. _releases-index: + +============= +Release notes +============= + +.. include:: ../CHANGELOG diff --git a/modules/account_dunning_fee/setup.py b/modules/account_dunning_fee/setup.py index c7713d686a..c2e4c4d215 100755 --- a/modules/account_dunning_fee/setup.py +++ b/modules/account_dunning_fee/setup.py @@ -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): @@ -60,7 +63,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-dunning-fee'), "Forum": 'https://www.tryton.org/forum', "Source Code": 'https://code.tryton.org/tryton', }, diff --git a/modules/account_dunning_letter/CHANGELOG b/modules/account_dunning_letter/CHANGELOG index 9fec78d56d..6c3bd0a6d7 100644 --- a/modules/account_dunning_letter/CHANGELOG +++ b/modules/account_dunning_letter/CHANGELOG @@ -20,59 +20,79 @@ 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 +-------------------------- * Bug fixes (see mercurial logs for details) Version 3.0.0 - 2013-10-21 +-------------------------- * Initial release diff --git a/modules/account_dunning_letter/doc/design.rst b/modules/account_dunning_letter/doc/design.rst new file mode 100644 index 0000000000..9871d22cec --- /dev/null +++ b/modules/account_dunning_letter/doc/design.rst @@ -0,0 +1,32 @@ +****** +Design +****** + +The *Account Dunning Letter Module* extends the following concepts: + +.. _model-account.dunning.level: + +Dunning Level +============= + +The *Dunning Level* is extended with the ability to print a `Letter +` when a dunning is processed that has reached +that level. + +.. _model-account.dunning: + +Dunning +======= + +Reports +------- + +.. _report-account.dunning.letter: + +Dunning Letter +^^^^^^^^^^^^^^ + +The *Dunning Letter* report prints one letter per `Party +` containing all of their dunnings and the `pending +payments ` that have been received but not yet +`reconciled `. diff --git a/modules/account_dunning_letter/doc/index.rst b/modules/account_dunning_letter/doc/index.rst index aef2c3027d..40c92cdde3 100644 --- a/modules/account_dunning_letter/doc/index.rst +++ b/modules/account_dunning_letter/doc/index.rst @@ -1,5 +1,12 @@ +############################# Account Dunning Letter Module ############################# -The account_dunning_letter module generates a dunning letter after the process -of dunnings for those who are at a level with *Print on Letter* checked. +The *Account Dunning Letter Module* allows dunning levels to be set up so that +a letter is printed when the dunnings are processed. + +.. toctree:: + :maxdepth: 2 + + design + releases diff --git a/modules/account_dunning_letter/doc/releases.rst b/modules/account_dunning_letter/doc/releases.rst new file mode 100644 index 0000000000..21b13c4745 --- /dev/null +++ b/modules/account_dunning_letter/doc/releases.rst @@ -0,0 +1,7 @@ +.. _releases-index: + +============= +Release notes +============= + +.. include:: ../CHANGELOG diff --git a/modules/account_dunning_letter/setup.py b/modules/account_dunning_letter/setup.py index 049c43ec83..ba2a205296 100755 --- a/modules/account_dunning_letter/setup.py +++ b/modules/account_dunning_letter/setup.py @@ -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-dunning-letter'), "Forum": 'https://www.tryton.org/forum', "Source Code": 'https://code.tryton.org/tryton', },