diff --git a/modules/account_statement/CHANGELOG b/modules/account_statement/CHANGELOG index 8af924c132..6334220359 100644 --- a/modules/account_statement/CHANGELOG +++ b/modules/account_statement/CHANGELOG @@ -19,6 +19,7 @@ Version 6.6.0 - 2022-10-31 * Require party on statement line if account requires one Version 6.4.0 - 2022-05-02 +-------------------------- * Bug fixes (see mercurial logs for details) * Use reference field for statement line relation * Create default statement journal @@ -26,38 +27,46 @@ 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) * Allow statement journals to be deactivated Version 6.0.0 - 2021-05-03 +-------------------------- * Bug fixes (see mercurial logs for details) * Warn user when posting a statement with cancelled or paid invoices * Fill move line's origin with statement line Version 5.8.0 - 2020-11-02 +-------------------------- * Bug fixes (see mercurial logs for details) * Remove support for Python 3.5 * Rename statement state from cancel to cancelled Version 5.6.0 - 2020-05-04 +-------------------------- * Bug fixes (see mercurial logs for details) * Prevent posting move from statement that is not posted Version 5.4.0 - 2019-11-04 +-------------------------- * Bug fixes (see mercurial logs for details) * Require fresh session to post a statement Version 5.2.0 - 2019-05-06 +-------------------------- * Bug fixes (see mercurial logs for details) * Use invoice amount to pay as line amount when creating lines from origins * Rename Origin field informations to information Version 5.0.0 - 2018-10-01 +-------------------------- * Bug fixes (see mercurial logs for details) * Use single account for statement journal * Remove support for Python 2.7 Version 4.8.0 - 2018-04-23 +-------------------------- * Bug fixes (see mercurial logs for details) * Do not check amount to pay when reconcile move lines * Remove line split by invoice in non company currency @@ -65,35 +74,42 @@ Version 4.8.0 - 2018-04-23 * Add button to reconcile statement Version 4.6.0 - 2017-10-30 +-------------------------- * Bug fixes (see mercurial logs for details) * Add generic wizard to import statement from files * Add statement origins * Unreconcile lines when cancelling statement Version 4.4.0 - 2017-05-01 +-------------------------- * Bug fixes (see mercurial logs for details) * Add statement line number as move description * Set description on statement account line if unique Version 4.2.0 - 2016-11-28 +-------------------------- * Bug fixes (see mercurial logs for details) * Manage readonly state on Statement Line 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) * Remove states on statement's date Version 3.6.0 - 2015-04-20 +-------------------------- * Bug fixes (see mercurial logs for details) * Add support for PyPy * Add line group model * Create Move by grouped lines (number, date, party) Version 3.4.0 - 2014-10-20 +-------------------------- * Bug fixes (see mercurial logs for details) * Add different validation type on journal * Add explicit name on statement @@ -102,45 +118,57 @@ Version 3.4.0 - 2014-10-20 * Switch journal debit/credit account usage Version 3.2.0 - 2014-04-21 +-------------------------- * Bug fixes (see mercurial logs for details) * Append new line under the original one * Prevent usage of paid invoice in draft statements Version 3.0.0 - 2013-10-21 +-------------------------- * Bug fixes (see mercurial logs for details) * Allow to use invoice to fill party and account on statement line * Replace move_lines by a relate Version 2.8.0 - 2013-04-22 +-------------------------- * Bug fixes (see mercurial logs for details) Version 2.6.0 - 2012-10-22 +-------------------------- * Bug fixes (see mercurial logs for details) * Allow to use credit note on statement line Version 2.4.0 - 2012-04-23 +-------------------------- * Bug fixes (see mercurial logs for details) * Don't deactivate payment wizard on invoice Version 2.2.0 - 2011-10-24 +-------------------------- * Bug fixes (see mercurial logs for details) Version 2.0.0 - 2011-04-27 +-------------------------- * Bug fixes (see mercurial logs for details) * Add company on statement Version 1.8.0 - 2010-11-01 +-------------------------- * Bug fixes (see mercurial logs for details) Version 1.6.0 - 2010-05-13 +-------------------------- * Bug fixes (see mercurial logs for details) Version 1.4.0 - 2009-10-19 +-------------------------- * Bug fixes (see mercurial logs for details) * Fix digits of start and end balance Version 1.2.0 - 2009-04-20 +-------------------------- * Bug fixes (see mercurial logs for details) Version 1.0.0 - 2009-05-01 +-------------------------- * Initial release diff --git a/modules/account_statement/doc/configuration.rst b/modules/account_statement/doc/configuration.rst new file mode 100644 index 0000000000..0bbb89cee3 --- /dev/null +++ b/modules/account_statement/doc/configuration.rst @@ -0,0 +1,28 @@ +************* +Configuration +************* + +The *Account Statement Module* uses values from settings in the +``[account_statement]`` section of the :doc:`configuration file +`. + +.. _config-account_statement.filestore: + +``filestore`` +============= + +This configuration value indicates whether the `Statement +` origin files should be stored in the +:py:mod:`trytond:trytond.filestore` (``True``) or the database (``False``). + +The default value is: ``False`` + + +``store_prefix`` +================ + +This is the prefix to use with the :py:mod:`trytond:trytond.filestore`. +This value is only used when the `filestore +` setting is in use. + +The default value is: ``None`` diff --git a/modules/account_statement/doc/design.rst b/modules/account_statement/doc/design.rst new file mode 100644 index 0000000000..a5c164d089 --- /dev/null +++ b/modules/account_statement/doc/design.rst @@ -0,0 +1,107 @@ +****** +Design +****** + +The *Account Statement Module* introduces the following concepts: + +.. _model-account.statement: + +Statement +========= + +The *Statement* concept groups together lines that represent entries in a +`Journal `. +These lines contain, among other information, the date, amount, `party +` and `account `. + +A statement may also contain a list of origins each of these holds a single +line from the raw information that was imported. + +A statement progresses through several different states until it is either +posted or cancelled. + +.. seealso:: + + Statements can be found by opening the main menu item: + + |Financial --> Statements --> Statements|__ + + .. |Financial --> Statements --> Statements| replace:: :menuselection:`Financial --> Statements --> Statements` + __ https://demo.tryton.org/model/account.statement + +Reports +------- + +.. _report-account.statement: + +Statement Report +^^^^^^^^^^^^^^^^ + +The *Statement Report* is a document that can be printed out that contains all +the relevant information about each statement, including the lines. + +Wizards +------- + +.. _wizard-account.statement.import: + +Import Statement +^^^^^^^^^^^^^^^^ + +The *Import Statement* wizard creates `Statements ` +from one of the supported file formats. +The raw lines from the file are stored as a list of origins on the statement. + +.. seealso:: + + Import Statement can be launch by opening the main menu item: + + |Financial --> Statements --> Import Statement|__ + + .. |Financial --> Statements --> Import Statement| replace:: :menuselection:`Financial --> Statements --> Import Statement` + __ https://demo.tryton.org/wizard/account.statement.import + + +.. _wizard-account.statement.reconcile: + +Reconcile Statement +^^^^^^^^^^^^^^^^^^^ + +The *Reconcile Statement* wizard launches the `Reconcile Accounts +` wizard on the `Account Move Lines +` created by the `Statement +`. + +.. _model-account.statement.line.group: + +Line Group +========== + +The *Line Group* displays the grouping of statement lines that was created +at the point when the `Statement ` was validated. + +.. seealso:: + + Line Groups can be found by opening the main menu item: + + |Financial --> Statements --> Statements --> Line Groups|__ + + .. |Financial --> Statements --> Statements --> Line Groups| replace:: :menuselection:`Financial --> Statements --> Statements --> Line Groups` + __ https://demo.tryton.org/model/account.statement.line.group + +.. _model-account.statement.journal: + +Statement Journal +================= + +A *Statement Journal* represents a `Statement ` book. +Among other things it defines how the statements must be validated. + +.. seealso:: + + Statement Journals can be found by opening the main menu item: + + |Financial --> Configuration --> Statements --> Statement Journals|__ + + .. |Financial --> Configuration --> Statements --> Statement Journals| replace:: :menuselection:`Financial --> Configuration --> Statements --> Statement Journals` + __ https://demo.tryton.org/model/account.statement.journal diff --git a/modules/account_statement/doc/index.rst b/modules/account_statement/doc/index.rst index a674992b25..e269189d6c 100644 --- a/modules/account_statement/doc/index.rst +++ b/modules/account_statement/doc/index.rst @@ -1,103 +1,13 @@ +######################## Account Statement Module ######################## -The account_statement module allows to book statements. Statement can be used -for bank statement, cash daybook etc. +The *Account Statement Module* provides facilities to book statements. +Statements can be used for bank statements, cash daybooks etc. -Statement -********* +.. toctree:: + :maxdepth: 2 -A statement groups many lines under a journal for a date. It is mainly defined -by: - -- Name. -- Journal. -- Date. - -The statement can be in one of this states: - -* Draft - - The statement is waiting for validation - -* Validated - - The statement is validated and is waiting to be posted. A move for each - grouped lines is already created in draft state. - -* Posted - - The statement is posted which means all the moves have been posted. - -* Cancelled - - The statement is cancelled which means all the moves previously created have - been deleted. - -Line -**** - -A Statement Line is mainly defined by: - -- Sequence: Use to order the lines in the statement. -- Number: The number to identify a transaction. -- Date. -- Amount. -- Party. -- Account. -- Invoice. -- Description. -- Move: The move created for this line. - -Origin -****** - -The statement origin store the raw information from an external system that -are imported. The origin are converted into statement lines. - -Line Group -********** - -The line group represent the group of lines created at the validation of the -statement. -By default the lines of a statement are grouped by *Number*, *Date* and *Party*. - -Journal -******* - -A Statement Journal is mainly defined by: - -- Name. -- Journal (from account). -- Currency. -- Validation Type: - - Balance - - Amount - - Number of Lines - -The statements are validated following the validation type of the journal. -The Balance validation requests to set the start and end balance (the start is -automaticaly filled with the end balance of the last statement on the same -journal) and the difference is checked against the total amount of the lines. -The Amount validation requests to set the total amount to check against the -total amount of the lines. -The Number of Lines requests to set the number of unique lines on the -statement. - -Import Statement -**************** - -A wizard to import statements from an external system. It creates statements -with origins filled. - -Configuration -************* - -The account_statement module uses the section ``account_statement`` to retrieve -some parameters: - -- ``filestore``: a boolean value to store origin file in the FileStore. - The default value is ``False``. - -- ``store_prefix``: the prefix to use with the FileStore. - The default value is ``None``. + configuration + design + releases diff --git a/modules/account_statement/doc/releases.rst b/modules/account_statement/doc/releases.rst new file mode 100644 index 0000000000..21b13c4745 --- /dev/null +++ b/modules/account_statement/doc/releases.rst @@ -0,0 +1,7 @@ +.. _releases-index: + +============= +Release notes +============= + +.. include:: ../CHANGELOG diff --git a/modules/account_statement/setup.py b/modules/account_statement/setup.py index cfd4584dad..3190b21174 100755 --- a/modules/account_statement/setup.py +++ b/modules/account_statement/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/projects/modules-account-statement'), "Forum": 'https://www.tryton.org/forum', "Source Code": 'https://code.tryton.org/tryton', },