57b7ca69d9
Prior to this commit, users had to either know in advance or guess the
location of the content they were looking for. Top-level pages of the
"Developer" section of the documentation, in particular the "Developer"
page itself, were listing their sub-pages without directions for users.
This commit brings the following changes to improve the navigation:
- add directions for users on the "Developer" page and list the three
main categories of developer documentation ("Tutorials", "How-to
guides", and "Reference") with explanations of their content and
target audience;
- add categories for content cards on the "Tutorials" and "How-to
guides" pages, and fine-tune the toctree of the "Reference" page to
more easily locate specific topics;
- clarify what are the "Python framework" and the "JavaScript framework"
by relabelling them to "Server framework" and "Web framework" on
top-level pages, as some users were confused to find that the JS
framework was not responsible for the server, and others that the
documentation for QWeb template is located in the Python documentation;
- extract the "Setup guide" from the "Getting started" tutorial and
rename the latter to "Server framework 101" to allow reusing the setup
guide in other tutorials and make clear that the "Server framework 101"
tutorial is not about the Web framework.
task-3802536
closes odoo/documentation#8712
X-original-commit: 7f623b6ad5
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Valeriya (vchu) <vchu@odoo.com>
316 lines
12 KiB
ReStructuredText
316 lines
12 KiB
ReStructuredText
|
|
=======================
|
|
Accounting localization
|
|
=======================
|
|
|
|
.. warning::
|
|
|
|
This tutorial requires knowledge about how to build a module in Odoo (see
|
|
:doc:`../tutorials/server_framework_101`).
|
|
|
|
|
|
Installation procedure
|
|
======================
|
|
|
|
On installing the `account <{GITHUB_PATH}/addons/account>`_ module, the localization module corresponding to the country code of the company is installed automatically.
|
|
In case of no country code set or no localization module found, the `l10n_generic_coa <{GITHUB_PATH}/addons/l10n_generic_coa>`_ (US) localization module is installed by default.
|
|
Check `post init hook <{GITHUB_PATH}/addons/account/__init__.py>`_ for details.
|
|
|
|
For example, `l10n_ch <{GITHUB_PATH}/addons/l10n_ch>`_ will be installed if the company has ``Switzerland`` as country.
|
|
|
|
Building a localization module
|
|
==============================
|
|
|
|
The structure of a basic ``l10n_XX`` module may be described with the following :file:`__manifest__.py` file:
|
|
|
|
.. code-block:: python
|
|
|
|
{
|
|
"name": "COUNTRY - Accounting",
|
|
"version": "1.0.0",
|
|
"category": "Accounting/Localizations/Account Charts",
|
|
"license": "LGPL-3",
|
|
"depends": [
|
|
"account",
|
|
],
|
|
"data": [
|
|
"data/other_data.xml",
|
|
"views/xxxmodel_views.xml",
|
|
],
|
|
"demo": [
|
|
"demo/demo_company.xml",
|
|
]
|
|
}
|
|
|
|
Your worktree should look like this
|
|
|
|
.. code-block:: bash
|
|
|
|
l10n_xx
|
|
├── data
|
|
│ ├── template
|
|
│ │ ├── account.account-xx.csv
|
|
│ │ ├── account.group-xx.csv
|
|
│ │ └── account.tax.group-xx.csv
|
|
│ └── other_data.xml
|
|
├── views
|
|
│ └── xxxmodel_views.xml
|
|
├── demo
|
|
│ └── demo_company.xml
|
|
├── models
|
|
│ ├── template_xx.py
|
|
│ └── __init__.py
|
|
├── __init__.py
|
|
└── __manifest__.py
|
|
|
|
|
|
In the first file :file:`models/template_xx.py`, we set the name for the chart of accounts along with some basic fields.
|
|
|
|
.. seealso::
|
|
:doc:`Chart Template References </developer/reference/standard_modules/account>`
|
|
|
|
.. example::
|
|
`addons/l10n_be/models/template_be.py <{GITHUB_PATH}/addons/l10n_be/models/template_be.py>`_
|
|
|
|
.. literalinclude:: {ODOO_RELPATH}/addons/l10n_be/models/template_be.py
|
|
:condition: odoo_dir_in_path
|
|
:language: python
|
|
:start-at: _get_be_template_data
|
|
:end-before: _get_be_reconcile_model
|
|
|
|
|
|
Chart of Accounts
|
|
=================
|
|
|
|
Account tags
|
|
------------
|
|
|
|
.. seealso::
|
|
:ref:`Account Tag References <reference/account_account_tag>`
|
|
|
|
Tags are a way to sort accounts.
|
|
For example, imagine you want to create a financial report having multiple lines but you have no way to find a rule to dispatch the accounts according to their ``code``.
|
|
The solution is the usage of tags, one for each report line, to filter accounts like you want.
|
|
|
|
Put the tags in the :file:`data/account_account_tag_data.xml` file.
|
|
|
|
.. example::
|
|
`addons/l10n_lt/data/template/account.account-lt.csv <{GITHUB_PATH}/addons/l10n_lt/data/template/account.account-lt.csv>`_
|
|
|
|
.. literalinclude:: {ODOO_RELPATH}/addons/l10n_lt/data/template/account.account-lt.csv
|
|
:condition: odoo_dir_in_path
|
|
:language: csv
|
|
:end-at: account_account_template_1201
|
|
|
|
Accounts
|
|
--------
|
|
|
|
.. seealso::
|
|
- :ref:`Account References <reference/account_account>`
|
|
- :doc:`/applications/finance/accounting/get_started/chart_of_accounts`
|
|
|
|
Obviously, :guilabel:`Chart of Accounts` cannot exist without :guilabel:`Accounts`. You need to specify them in :file:`data/account.account.template.csv`.
|
|
|
|
.. example::
|
|
`addons/l10n_ch/data/template/account.account-ch.csv <{GITHUB_PATH}/addons/l10n_ch/data/template/account.account-ch.csv>`_
|
|
|
|
.. literalinclude:: {ODOO_RELPATH}/addons/l10n_ch/data/template/account.account-ch.csv
|
|
:condition: odoo_dir_in_path
|
|
:language: csv
|
|
:end-at: ch_coa_1171
|
|
|
|
.. warning::
|
|
|
|
- Avoid the usage of `asset_cash` ``account_type``!
|
|
Indeed, the bank & cash accounts are created directly at the installation of the localization module and then, are linked to an ``account.journal``.
|
|
- Only one account of type payable/receivable is enough for the generic case. We need to define a PoS receivable account as well however. (linked in the CoA)
|
|
- Don't create too many accounts: 200-300 is enough. But mostly, we try to find a good balance where the CoA needs minimal adapting for most companies afterwards.
|
|
|
|
|
|
Account groups
|
|
--------------
|
|
|
|
.. seealso::
|
|
:ref:`Account Group References <reference/account_group>`
|
|
|
|
Account groups allow describing the hierarchical structure of the chart of accounts. The filter needs to be activated in the report and then when you decollapse into journal entries it will show the parents of the account.
|
|
|
|
It works with the prefix *start*/*end*, so every account where the code starts with something between *start* and *end* will have this ``account.group`` as the parent group. Furthermore, the account groups can have a parent account group as well to form the hierarchy.
|
|
|
|
|
|
.. example::
|
|
`addons/l10n_il/data/template/account.group-il.csv <{GITHUB_PATH}/addons/l10n_il/data/template/account.group-il.csv>`_
|
|
|
|
.. csv-table::
|
|
:condition: odoo_dir_in_path
|
|
:file: {ODOO_RELPATH}/addons/l10n_il/data/template/account.group-il.csv
|
|
:widths: 20,20,20,20,20
|
|
:header-rows: 1
|
|
|
|
Taxes
|
|
-----
|
|
|
|
.. seealso::
|
|
- :ref:`Tax References <reference/account_tax>`
|
|
- :doc:`/applications/finance/accounting/taxes/`
|
|
|
|
To add taxes you first need to specify tax groups. You normally need just one tax group for every tax rate, except for the 0% as you need to often distinguish between exempt, 0%, not subject, ... taxes.
|
|
This model only has two required fields: `name` and `country`. Create the file :file:`data/template/account.tax.group-xx.csv` and list the groups.
|
|
|
|
.. example::
|
|
`addons/l10n_uk/data/template/account.tax.group-uk.csv <{GITHUB_PATH}/addons/l10n_uk/data/template/account.tax.group-uk.csv>`_
|
|
|
|
.. literalinclude:: {ODOO_RELPATH}/addons/l10n_uk/data/template/account.tax.group-uk.csv
|
|
:condition: odoo_dir_in_path
|
|
:language: csv
|
|
|
|
|
|
Now you can add the taxes via :file:`data/template/account.tax-xx.csv` file. The first tax you define that is purchase/sale also becomes the default purchase/sale tax for your products.
|
|
|
|
|
|
.. example::
|
|
`addons/l10n_ae/data/template/account.tax-ae.csv <{GITHUB_PATH}/addons/l10n_ae/data/template/account.tax-ae.csv>`_
|
|
|
|
.. literalinclude:: {ODOO_RELPATH}/addons/l10n_ae/data/template/account.tax-ae.csv
|
|
:condition: odoo_dir_in_path
|
|
:language: xml
|
|
:end-at: uae_sale_tax_5_ras_al_khaima
|
|
|
|
|
|
Tax Report
|
|
----------
|
|
|
|
.. raw:: html
|
|
|
|
<div><span class="badge" style="background-color:#AD5E99">Enterprise feature</span><div>
|
|
|
|
The tax report is declared in the :guilabel:`Invoicing` (`account`) app, but the report is only accessible when :guilabel:`Accounting` (`account_accountant`) is installed.
|
|
|
|
.. seealso::
|
|
- :doc:`/developer/reference/standard_modules/account/account_report_line`
|
|
- :doc:`/applications/finance/accounting/reporting/tax_returns`
|
|
|
|
In the previous section, you noticed the fields `invoice_repartition_line_ids` or `refund_repartition_line_ids` and probably understood nothing about them. Good news: you are not alone on this incomprehension. Bad news: you have to figure it out a bit. The topic is complicated. Indeed:
|
|
|
|
.. graphviz:: accounting_localization/tax_report.dot
|
|
:class: overflow-auto
|
|
|
|
The simple version is that, in the tax template, you indicate in the invoice/refund repartition lines whether the base or a percentage of the tax needs to be reported in which report line (through the *minus/plus_report_line_ids* fields).
|
|
It becomes clear also when you check the tax configuration in the Odoo interface (or check the docs :ref:`Tax References <reference/account_tax>`, :ref:`Tax Repartition References <reference/account_tax_repartition>`).
|
|
|
|
So, once you have properly configured taxes, you just need to add the :file:`data/account_tax_report_data.xml` file with a record for your `account.report`. For it to be considered as a tax report, you need to provide it with the right `root_report_id`.
|
|
|
|
.. code-block:: xml
|
|
|
|
<odoo>
|
|
<record id="tax_report" model="account.report">
|
|
<field name="name">Tax Report</field>
|
|
<field name="root_report_id" ref="account.generic_tax_report"/>
|
|
<field name="country_id" ref="base.XX"/>
|
|
</record>
|
|
|
|
...
|
|
</odoo>
|
|
|
|
... followed by the declaration of its lines, as `account.report.line` records.
|
|
|
|
.. example::
|
|
`addons/l10n_au/data/account_tax_report_data.xml <{GITHUB_PATH}/addons/l10n_au/data/account_tax_report_data.xml>`_
|
|
|
|
.. literalinclude:: {ODOO_RELPATH}/addons/l10n_au/data/account_tax_report_data.xml
|
|
:condition: odoo_dir_in_path
|
|
:language: xml
|
|
:start-at: tax_report
|
|
:end-before: account_tax_report_gstrpt_g3
|
|
|
|
|
|
|
|
Fiscal positions
|
|
----------------
|
|
|
|
.. seealso::
|
|
- :ref:`Fiscal Position References <reference/account_fiscal_position>`
|
|
- :doc:`/applications/finance/accounting/taxes/fiscal_positions`
|
|
|
|
Specify fiscal positions in the :file:`data/template/account.fiscal.position-xx.csv` file.
|
|
|
|
.. example::
|
|
`addons/l10n_es/data/template/account.fiscal.position-es_common.csv <{GITHUB_PATH}/addons/l10n_es/data/template/account.fiscal.position-es_common.csv>`_
|
|
|
|
.. literalinclude:: {ODOO_RELPATH}/addons/l10n_es/data/template/account.fiscal.position-es_common.csv
|
|
:condition: odoo_dir_in_path
|
|
:language: csv
|
|
:end-at: account_tax_template_p_iva10_sp_ex
|
|
|
|
Final steps
|
|
===========
|
|
|
|
Finally, you may add a demo company, so the localization can easily be tested in demo mode.
|
|
|
|
.. example::
|
|
`addons/l10n_ch/demo/demo_company.xml <{GITHUB_PATH}/addons/l10n_ch/demo/demo_company.xml>`_
|
|
|
|
.. literalinclude:: {ODOO_RELPATH}/addons/l10n_ch/demo/demo_company.xml
|
|
:condition: odoo_dir_in_path
|
|
:language: xml
|
|
:start-after: <odoo>
|
|
:end-before: </odoo>
|
|
|
|
Accounting reports
|
|
==================
|
|
|
|
.. raw:: html
|
|
|
|
<div><span class="badge" style="background-color:#AD5E99">Enterprise feature</span><div>
|
|
|
|
.. seealso::
|
|
:doc:`/applications/finance/accounting/reporting`
|
|
|
|
Accounting reports should be added via a separate module `l10n_XX_reports` that should go to the `enterprise repository <{GITHUB_ENT_PATH}>`_.
|
|
|
|
Basic :file:`__manifest__.py` file for such a module looks as following:
|
|
|
|
|
|
.. code-block:: python
|
|
|
|
{
|
|
"name": "COUNTRY - Accounting Reports",
|
|
"category": "Accounting/Localizations/Reporting",
|
|
"version": "1.0.0",
|
|
"license": "OEEL-1",
|
|
"depends": [
|
|
"l10n_XX", "account_reports"
|
|
],
|
|
"data": [
|
|
"data/balance_sheet.xml",
|
|
"data/profit_and_loss.xml",
|
|
],
|
|
"auto_install": True,
|
|
}
|
|
|
|
|
|
Functional overview of financial reports is here: :doc:`/applications/finance/accounting/reporting`.
|
|
|
|
Some good examples:
|
|
|
|
* `l10n_ch_reports/data/account_financial_html_report_data.xml <{GITHUB_ENT_PATH}/l10n_ch_reports/data/account_financial_html_report_data.xml>`_
|
|
* `l10n_be_reports/data/account_financial_html_report_data.xml <{GITHUB_ENT_PATH}/l10n_be_reports/data/account_financial_html_report_data.xml>`_
|
|
|
|
You can check the meaning of the fields here:
|
|
|
|
* :doc:`/developer/reference/standard_modules/account/account_report`
|
|
* :doc:`/developer/reference/standard_modules/account/account_report_line`
|
|
|
|
If you gave a `root_report_id` to your report, it is now available in its variant selector. If not,
|
|
you still need to add a menu item for it. A default menu item can be created from the form view of
|
|
the report by clicking on :menuselection:`Actions --> Create Menu Item`. You will then need to
|
|
refresh the page to see it. Alternatively, to create a dedicated section for a totally new report in
|
|
the :guilabel:`Reporting` menu, you need to create a new `ir.ui.menu` record (usually in the main
|
|
`l10n_XX` module) and a new `ir.actions.client` (usually in the new report XML file) that calls the
|
|
`account.report` with the new **report id**. Then, set the new menu as `parent_id` field in the
|
|
action model.
|
|
|
|
.. example::
|
|
* `ir.ui.menu creation <{GITHUB_PATH}/addons/l10n_be/data/menuitem_data.xml>`_
|
|
* `ir.actions.client and menu item creation <{GITHUB_ENT_PATH}/l10n_be_reports/data/partner_vat_listing.xml>`_
|