documentation/content/applications/finance/accounting/others/reporting/customize.rst
Antoine Vandevenne (anv) e3fee2cf46 [REF][MOV] documentation apocalypse
Prior to this commit, the Odoo documentation was mainly split between
two repositories: odoo/odoo/doc and odoo/documentation-user. Some bits
of documentation were also hosted elsewhere (e.g., wiki, upgrade, ...).
This was causing several problems among which:
  - The theme, config, Makefile, and similar technical resources had to
    be duplicated. This resulted in inconsistent layout, features, and
    build environments from one documentation to another.
  - Some pages did not fit either documentation as they were relevant
    for both users and developers. Some were relevant to neither of the
    two (e.g., DB management).
  - Cross-doc references had to be absolute links and they broke often.
  - Merging large image files in the developer documentation would bloat
    the odoo/odoo repository. Some contributions had to be lightened to
    avoid merging too many images (e.g., Odoo development tutorials).
  - Long-time contributors to the user documentation were chilly about
    going through the merging process of the developer documentation
    because of the runbot, mergebot, `odoo-dev` repository, etc.
  - Some contributors would look for the developer documentation in the
    `odoo/documentation-user` repository.
  - Community issues about the user documentation were submitted on the
    `odoo/odoo` repository and vice-versa.

Merging all documentations in one repository will allow us to have one
place, one theme, one work process, and one set of tools (build
environment, ...) for all of the Odoo docs.

As this is a good opportunity to revamp the layout of the documentation,
a brand new theme replaces the old one. It features a new way to
navigate the documentation, centered on the idea of always letting the
reader know what is the context (enclosing section, child pages, page
structure ...) of the page they are reading. The previous theme would
quickly confuse readers as they navigated the documentation and followed
cross-application links.

The chance is also taken to get rid of all the technical dangling parts,
performance issues, and left-overs. Except for some page-specific JS
scripts, the Odoo theme Sphinx extension is re-written from scratch
based on the latest Sphinx release to benefit from the improvements and
ease future contributions.

task-2351938
task-2352371
task-2205684
task-2352544

Closes #945
2021-05-04 15:44:00 +02:00

100 lines
3.2 KiB
ReStructuredText
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

==========================================================
How to create a customized reports with your own formulas?
==========================================================
Overview
========
Odoo 12 comes with a powerful and easy-to-use reporting framework.
Creating new reports (such as a tax report or a balance sheet or
income statement with specific groupings and layout ) to suit your
needs is now easier than ever.
Activate the developer mode
===========================
In order to have access to the financial report creation interface, the
**developer mode** needs to be activated. To do that, first click on the
user profile in the top right menu, then **About**.
.. image:: media/customize01.png
:align: center
Click on : **Activate the developer mode**.
.. image:: media/customize03.png
:align: center
Create your financial report
============================
First, you need to create your financial report. To do that, go to
:menuselection:`Accounting --> Configuration --> Financial Reports`
.. image:: media/customize02.png
:align: center
Once the name is entered, there are two other parameters that need to be
configured:
- **Show Credit and Debit Columns**
- **Analysis Period** :
- Based on date ranges (e.g. Profit and Loss)
- Based on a single date (e.g. Balance Sheet)
- Based on date ranges with 'older' and 'total' columns and last 3
months (e.g. Aged Partner Balances)
- Bases on date ranges and cash basis method (e.g. Cash Flow
Statement)
Add lines in your custom reports
=================================
After you've created the report, you need to fill it with lines. They
all need a **name**, a **code** (that is used to refer to the line), a
**sequence number** and a **level** (Used for the line rendering).
.. image:: media/customize04.png
:align: center
In the **formulas** field you can add one or more formulas to assign a
value to the balance column (and debit and credit column if applicable
separated by ;)
You have several objects available in the formula :
- ``Ndays`` : The number of days in the selected period (for reports with a
date range).
- Another report, referenced by its code. Use ``.balance`` to get its
balance value (also available are ``.credit``, ``.debit`` and
``.amount_residual``)
A line can also be based on the sum of account move lines on a selected
domain. In which case you need to fill the domain field with an Odoo
domain on the account move line object. Then an extra object is
available in the formulas field, namely ``sum``, the sum of the account
move lines in the domain. You can also use the group by field to group
the account move lines by one of their columns.
Other useful fields :
- **Type** : Type of the result of the formula.
- **Is growth good when positive** : Used when computing the comparison
column. Check if growth is good (displayed in green) or not.
- **Special date changer** : If a specific line in a report should not use
the same dates as the rest of the report.
- **Show domain** : How the domain of a line is displayed. Can be foldable
(``default``, hidden at the start but can be unfolded), ``always``
(always displayed) or ``never`` (never shown).
.. seealso::
* :doc:`main_reports`