Update documentation of account_payment_clearing

This commit is contained in:
Cédric Krier
2023-08-05 19:54:57 +02:00
parent e9db5f0234
commit ef1405dda7
6 changed files with 86 additions and 7 deletions
@@ -11,6 +11,7 @@ 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)
* Prevent to select reconciled payment or group on draft statement line
* Reconcile payment clearing line with all statement lines
@@ -19,57 +20,73 @@ Version 6.4.0 - 2022-05-02
* 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)
* Use the date of the statement line as date for the clearing move
Version 5.4.0 - 2019-11-04
--------------------------
* Bug fixes (see mercurial logs for details)
* Relax Account domain on Payment
Version 5.2.0 - 2019-05-06
--------------------------
* Bug fixes (see mercurial logs for details)
* Add support for payment and payment_group on Statement Rule
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)
* Add cron task to post clearing move after journal delay
Version 4.6.0 - 2017-10-30
--------------------------
* Bug fixes (see mercurial logs for details)
* Allow to use account instead of line for clearing
Version 4.4.0 - 2017-05-01
--------------------------
* Bug fixes (see mercurial logs for details)
* Allow to set the date of the clearing move
Version 4.2.0 - 2016-11-28
--------------------------
* Bug fixes (see mercurial logs for details)
* Mark Payment as succeded or failed when imported in statement
* Allow to link statement line to group of payments
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
--------------------------
* Initial release
@@ -0,0 +1,48 @@
******
Design
******
The *Account Payment Clearing Module* introduces the following concepts:
.. _model-account.payment:
Payment
=======
When the *Account Payment Clearing Module* is activated, the payment gain some
extra properties.
These include an `Account <account:model-account.account>` to use for clearing
if no `Move Line <account:model-account.move.line>` is set.
.. seealso::
The `Payment <account_payment:model-account.payment>` concept is introduced
by the :doc:`Account Payment Module <account_payment:index>`.
Wizards
-------
.. _wizard-account.payment.succeed:
Succeed Payment
^^^^^^^^^^^^^^^
The *Succeed Payment* wizard asks for the date to use for the clearing `Account
Move <account:model-account.move>` before succeeding the payment.
.. _model-account.payment.journal:
Payment Journal
===============
When the *Account Payment Clearing Module* is activated, the payment journal
gain some extra properties that controls the clearing behavior.
These include a clearing account and journal to use to create the `Account Move
<account:model-account.move>` and a clearing delay to post automatically the
created moves.
.. seealso::
The `Payment Journal <account_payment:model-account.payment.journal>`
concept is introduced by the :doc:`Account Payment Module
<account_payment:index>`.
@@ -1,12 +1,13 @@
###############################
Account Payment Clearing Module
###############################
The account_payment_clearing module allows to generate account move when a
The *Account Payment Clearing Module* allows to generate account move when a
payment is succeeded between the receivable/payable account to a clearing
account defined on the payment journal.
The clearing account will be used for statement lines which are linked to such
payment.
.. toctree::
:maxdepth: 2
If a delay is configured on journal for posting, a scheduled task will post
automatically clearing moves after this delay.
design
releases
@@ -0,0 +1,7 @@
.. _releases-index:
=============
Release notes
=============
.. include:: ../CHANGELOG
+7 -2
View File
@@ -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):
@@ -63,7 +66,9 @@ 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/projects/'
'modules-account-payment-clearing'),
"Forum": 'https://www.tryton.org/forum',
"Source Code": 'https://code.tryton.org/tryton',
},
@@ -1,6 +1,7 @@
[tryton]
version=6.9.0
depends:
account
account_payment
ir
extras_depend: