Update documentation of account tax cash
This commit is contained in:
Cédric Krier
@@ -20,32 +20,41 @@ 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
|
||||
--------------------------
|
||||
* Initial release
|
||||
|
||||
@@ -0,0 +1,92 @@
|
||||
******
|
||||
Design
|
||||
******
|
||||
|
||||
The *Account Tax Cash Module* extends the following concepts:
|
||||
|
||||
.. _model-account.fiscalyear:
|
||||
|
||||
Fiscal Year
|
||||
===========
|
||||
|
||||
When the *Account Tax Cash Module* is activated, the *Fiscal Year* is extended
|
||||
to allow setting which `Tax Groups <account:model-account.tax.group>` are
|
||||
reported on a cash basis for its periods.
|
||||
|
||||
.. seealso::
|
||||
|
||||
The `Fiscal Year <account:model-account.fiscalyear>` concept is introduced
|
||||
by the :doc:`Account Module <account:index>`.
|
||||
|
||||
.. _model-account.period:
|
||||
|
||||
Period
|
||||
======
|
||||
|
||||
When the *Account Tax Cash Module* is activated, the *Period* is extended to
|
||||
allow setting which `Tax Groups <account:model-account.tax.group>` are reported
|
||||
on a cash basis for that period.
|
||||
|
||||
When the *Period* is closed, a warning is raised if there are payment `Lines
|
||||
<account:model-account.move.line>` that are not linked to an `Invoice
|
||||
<account_invoice:model-account.invoice>`.
|
||||
|
||||
.. seealso::
|
||||
|
||||
The `Period <account:model-account.period>` concept is introduced by the
|
||||
:doc:`Account Module <account:index>`.
|
||||
|
||||
.. _model-account.tax.line:
|
||||
|
||||
Tax Line
|
||||
========
|
||||
|
||||
When the *Account Tax Cash Module* is activated, the *Tax Line* stores the
|
||||
`Period <account:model-account.period>` in which it must be reported.
|
||||
The *Period* is set automatically when a payment is linked to the `Invoice
|
||||
<account_invoice:model-account.invoice>` that created the *Tax Line*.
|
||||
If necessary, new *Tax Lines* are created proportionally to the amount of the
|
||||
payment.
|
||||
When a payment line is removed from an invoice, the reverse operation is
|
||||
performed.
|
||||
|
||||
.. seealso::
|
||||
|
||||
The `Tax Line <account:model-account.tax.line>` concept is introduced by the
|
||||
:doc:`Account Module <account:index>`.
|
||||
|
||||
.. _model-account.invoice:
|
||||
|
||||
Invoice
|
||||
=======
|
||||
|
||||
When the *Account Tax Cash Module* is activated, supplier *Invoices* gain a
|
||||
list of `Tax Groups <account:model-account.tax.group>` for which `Tax Lines
|
||||
<model-account.tax.line>` must be reported on a cash basis.
|
||||
This list is automatically populated from the invoice's `Party
|
||||
<model-party.party>` property.
|
||||
|
||||
.. warning::
|
||||
The `Invoice <account_invoice:report-account.invoice>` report may need to be
|
||||
adjusted to include a legal notice when tax reporting on a cash basis is
|
||||
used.
|
||||
It can be tested with the ``on_cash_basis`` property of the invoice tax.
|
||||
|
||||
.. seealso::
|
||||
|
||||
The `Invoice <account_invoice:model-account.invoice>` concept is introduced
|
||||
by the :doc:`Account Invoice Module <account_invoice:index>`.
|
||||
|
||||
.. _model-party.party:
|
||||
|
||||
Party
|
||||
=====
|
||||
|
||||
When the *Account Tax Cash Module* is activated, *Parties* gain a new property
|
||||
that allows setting which `Tax Groups <account:model-account.tax.group>` for
|
||||
that supplier are reported on a cash basis.
|
||||
|
||||
.. seealso::
|
||||
|
||||
The `Party <party:model-party.party>` concept is introduced by the
|
||||
:doc:`Party Module <party:index>`.
|
||||
@@ -1,21 +1,12 @@
|
||||
#######################
|
||||
Account Tax Cash Module
|
||||
#######################
|
||||
|
||||
The account_tax_cash module allows to make tax report on cash basis.
|
||||
The *Account Tax Cash Module* allows the tax reports to be calculated on a cash
|
||||
basis.
|
||||
|
||||
The tax groups reported on cash basis are defined on the *Fiscal Year* and
|
||||
*Period*. They can also be defined on the supplier invoices which get the
|
||||
default values from the *Party*.
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
When a payment lines is added to an invoice, the tax lines for the proportional
|
||||
amount are set on the corresponding tax code for the current period.
|
||||
If a payment line is removed from an invoice, the reverse operation is applied.
|
||||
|
||||
When closing a *Period*, a warning is raised if there are still
|
||||
receivable/payable lines not reconciled or linked to an invoice.
|
||||
|
||||
.. warning::
|
||||
The invoice template may need to be adapated to include a legal notice when
|
||||
tax on cash basis is used. It can be tested with the *on_cash_basis*
|
||||
property of the *Invoice Tax*.
|
||||
..
|
||||
design
|
||||
releases
|
||||
|
||||
@@ -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-tax-cash'),
|
||||
"Forum": 'https://www.tryton.org/forum',
|
||||
"Source Code": 'https://code.tryton.org/tryton',
|
||||
},
|
||||
|
||||
Reference in New Issue
Block a user