diff --git a/modules/account_payment/CHANGELOG b/modules/account_payment/CHANGELOG index 3364ed172b..1377cd75c0 100644 --- a/modules/account_payment/CHANGELOG +++ b/modules/account_payment/CHANGELOG @@ -14,6 +14,7 @@ Version 6.6.0 - 2022-10-31 * Add identical party from payments Version 6.4.0 - 2022-05-02 +-------------------------- * Bug fixes (see mercurial logs for details) * Allow only lines with maturity date to be paid * Allow processing receivable payment without approval @@ -26,15 +27,18 @@ Version 6.4.0 - 2022-05-02 * Add amount_line_paid property on payments Version 6.2.0 - 2021-11-01 +-------------------------- * Bug fixes (see mercurial logs for details) * Add wizard to create direct debit for configured parties * Add succeed button for payment groups Version 6.0.0 - 2021-05-03 +-------------------------- * Bug fixes (see mercurial logs for details) * Add employee on payments for some states Version 5.8.0 - 2020-11-02 +-------------------------- * Bug fixes (see mercurial logs for details) * Remove support for Python 3.5 * Allow payment journal to be deactivated @@ -42,35 +46,43 @@ Version 5.8.0 - 2020-11-02 * Add aggregated information on Payment groups Version 5.6.0 - 2020-05-04 +-------------------------- * Bug fixes (see mercurial logs for details) * Allow scheduling payments on their line maturity dates 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) * Add warning to group lines * Add date to Pay Lines wizard 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) * Check pending payment to erase party Version 4.6.0 - 2017-10-30 +-------------------------- * Bug fixes (see mercurial logs for details) * Add origin field on payment Version 4.4.0 - 2017-05-01 +-------------------------- * Bug fixes (see mercurial logs for details) * Support direct debit of payable line * Set default journal when paying line Version 4.2.0 - 2016-11-28 +-------------------------- * Bug fixes (see mercurial logs for details) * Allow to block payment of line * Ask payment journal for each currency @@ -78,21 +90,27 @@ Version 4.2.0 - 2016-11-28 * Add group Payment Approval Version 4.0.0 - 2016-05-02 +-------------------------- * Bug fixes (see mercurial logs for details) * Rename Payment Group reference into number * Add payment group sequence in configuration * Add Python3 support Version 3.8.0 - 2015-11-02 +-------------------------- * Bug fixes (see mercurial logs for details) * Add date to Pay Lines wizard 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) * Add transitions between succeeded and failed Version 3.2.0 - 2014-04-21 +-------------------------- * Initial release diff --git a/modules/account_payment/doc/design.rst b/modules/account_payment/doc/design.rst new file mode 100644 index 0000000000..5f7957680b --- /dev/null +++ b/modules/account_payment/doc/design.rst @@ -0,0 +1,136 @@ +****** +Design +****** + +The *Account Payment Module* introduces the following concepts: + +.. _model-account.payment: + +Payment +======= + +A *Payment* represents an order to pay an amount to a `Party +` or receive an amount from a party. +It may be linked to an `Move Line ` to deduce its +*Amount to Pay*. + +Once processed, a payment can not be changed except to be succeeded or failed. + +When the :doc:`Account Statement Module ` is +activated, the payment lines linked to a statement line are marked as succeeded +when the statement is validated. + +.. seealso:: + + The receivable payments can be found by opening the main menu item: + + |Financial --> Payments --> Receivable Payments|__ + + .. |Financial --> Payments --> Receivable Payments| replace:: :menuselection:`Financial --> Payments --> Receivable Payments` + __ https://demo.tryton.org/model/account.payment;domain=[["kind"%2C"%3D"%2C"receivable"]] + + The payable payments can be found by opening the main menu item: + + |Financial --> Payments --> Payable Payments|__ + + .. |Financial --> Payments --> Payable Payments| replace:: :menuselection:`Financial --> Payments --> Payable Payments` + __ https://demo.tryton.org/model/account.payment;domain=[["kind"%2C"%3D"%2C"payable"]] + +Wizards +------- + +.. _wizard-account.payment.process: + +Process Payment +^^^^^^^^^^^^^^^ + +The *Process Payment* wizard groups the payments of same kind and process them +following the method defined on the journal. + +.. _model-account.payment.journal: + +Payment Journal +=============== + +A *Payment Journal* groups `Payments `. +It defines the `Currency ` and the processing +method. + +.. seealso:: + + The payment journals can be found by opening the main menu item: + + |Financial --> Configuration --> Payments --> Journals|__ + + .. |Financial --> Configuration --> Payments --> Journals| replace:: :menuselection:`Financial --> Configuration --> Payments --> Journals` + __ https://demo.tryton.org/model/account.payment.journal + + +.. _model-account.payment.group: + +Payment Group +============= + +A *Payment Group* contains `Payments ` processed +together at the same time. +The payment group is used to follow the processing of the payments. + +.. seealso:: + + The payment groups can be found by opening the main menu item: + + |Financial --> Payments --> Payment Groups|__ + + .. |Financial --> Payments --> Payment Groups| replace:: :menuselection:`Financial --> Payments --> Payment Groups` + __ https://demo.tryton.org/model/account.payment.group + + +.. _model-account.move.line: + +Account Move Line +================= + +When the *Account Payment Module* is activated, the account move lines gain +some extra properties. +These include the amount to pay for a receivable or payable line and the +blocked and direct debit checkboxes. + +.. seealso:: + + The `Account Move Line ` concept is + introduced by the :doc:`Account Module `. + +Wizards +------- + +.. _wizard-account.move.line.create_direct_debit: + +Create Direct Debit +^^^^^^^^^^^^^^^^^^^ + +The *Credit Direct Debit* wizard creates receivable payments for due lines for +a date based on the direct debits property of the `Party `. + +.. _wizard-account.move.line.pay: + +Pay Line +^^^^^^^^ + +The *Pay Line* wizard creates payments for each line and using the amount to +pay. + + +.. _model-party.party: + +Party +===== + +When the *Account Payment Module* is activated, the parties gain some extra +accounting properties. +These include a checkbox to prevent to pay supplier which does direct debit and +a list of direct debit options to collect payments from customer. + +.. seealso:: + + The `Party ` concept is introduced by the + :doc:`Party Module `. diff --git a/modules/account_payment/doc/index.rst b/modules/account_payment/doc/index.rst index b73fd986ee..34d63b8977 100644 --- a/modules/account_payment/doc/index.rst +++ b/modules/account_payment/doc/index.rst @@ -1,67 +1,15 @@ +###################### Account Payment Module ###################### -The account_payment module allows to generate grouped payments for receivable -or payable Account Move Lines. +The *Account Payment Module* manages the receivable and payable payments. +A payment is an order to pay an amount to a party or to receive an amount from +a party. +Such order can be electronic payment, bank order or checks. -Payment -******* -A Payment defines the attempt to pay an amount to a party or to receive an -amount from a party. It is mainly defined by: +.. toctree:: + :maxdepth: 2 -- Journal. -- Kind: - - Payable - - Receivable -- Party. -- Line. -- Amount. -- Date. -- Description. - -A payment can be created from an payable or receivable *Account Move Line* -using the ``Pay Lines`` action. The amount is computed from the debit/credit -deducing existing payments for this line. - -Direct debit payments can be created from the wizard ``Create Direct Debit`` -for all the parties that are configured with at least one *Direct Debits* -record. - -The payment can be in one of this states: - -* Draft - - The payment is in preparation. - -* Submitted - - The payment has been submitted and is waiting approval or to be processed. - -* Approved - - The payment has been approved and is waiting to be processed by the wizard in - a Group. - -* Processing - - The payment has been processed in a Group. - -* Succeeded - - The payment was successfully processed. - -* Failed - - The payment was not successfully processed. - -Group -***** - -A group links a set of payment of the same kind processed together inside the -same journal. - -Journal -******* - -A journal defines the configuration of the processing of payments. + design + releases diff --git a/modules/account_payment/doc/releases.rst b/modules/account_payment/doc/releases.rst new file mode 100644 index 0000000000..21b13c4745 --- /dev/null +++ b/modules/account_payment/doc/releases.rst @@ -0,0 +1,7 @@ +.. _releases-index: + +============= +Release notes +============= + +.. include:: ../CHANGELOG diff --git a/modules/account_payment/setup.py b/modules/account_payment/setup.py index dc084d9db6..4a96168f6a 100755 --- a/modules/account_payment/setup.py +++ b/modules/account_payment/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): @@ -65,7 +68,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/projects/modules-account-payment'), "Forum": 'https://www.tryton.org/forum', "Source Code": 'https://code.tryton.org/tryton', },