diff --git a/content/applications/finance/accounting/reporting/data_inalterability.rst b/content/applications/finance/accounting/reporting/data_inalterability.rst index 915b3dbea..55ea85434 100644 --- a/content/applications/finance/accounting/reporting/data_inalterability.rst +++ b/content/applications/finance/accounting/reporting/data_inalterability.rst @@ -3,10 +3,10 @@ Data inalterability check report ================================ Tax authorities in some countries require companies to **prove their posted accounting entries are -inalterable**, meaning that once an entry has been posted, it can no longer be changed. +unaltered**, meaning that once an entry has been secured, it can no longer be changed. -To do so, Odoo can use the **SHA-256 algorithm** to create a unique fingerprint for each posted -entry. This fingerprint is called a hash. The hash is generated by taking an entry's essential data +To do so, Odoo creates a unique fingerprint for each secured entry thanks to the **SHA-256 algorithm**. +This fingerprint is called a hash. The hash is generated by taking an entry's essential data (the values of the `name`, `date`, `journal_id`, `company_id`, `debit`, `credit`, `account_id`, and `partner_id` fields), concatenating it, and inputting it to the SHA-256 hash function, which then outputs a fixed size (256-bit) string of characters. The hash function is deterministic (:dfn:`the @@ -15,7 +15,7 @@ completely change the resulting hash. Consequently, the SHA-256 algorithm is oft others, for data integrity verification purposes. In addition, the previous entry's hash is always added to the next entry to form a **hash chain**. -This is used to ensure a new entry is not added afterward between two posted entries, as doing so +This is used to ensure a new entry is not added afterward between two secured entries, as doing so would break the hash chain. .. note:: @@ -24,23 +24,70 @@ would break the hash chain. bigger than the number of atoms in the known universe. This is why hashes are considered unique in practice. -.. _data-inalterability/lock: +.. _data-inalterability/inalterability_features: -Lock posted entries with hash -============================= +Inalterability features +======================= -To start using the hashing function, go to :menuselection:`Accounting --> Configuration > Journals`. -Open the journal for which you want to activate the feature, go to the :guilabel:`Advanced Settings` -tab, and enable :guilabel:`Lock Posted Invoices with Hash`. -This feature is available for sale, purchase, and general journals. +Inalterability features can be enabled by activating the :ref:`secure posted entries with hash +` option on any journal or using the :ref:`secure entries wizard +`. + +- Two indicators are added to the journal entry's form view. + They show whether the entry is secured or not. + + - A :icon:`fa-lock` or :icon:`fa-unlock` (:guilabel:`lock icon`) next to the :guilabel:`Posted` state. + - A :guilabel:`Secured` checkbox in the :guilabel:`Other info` tab. + +- A :guilabel:`Not Secured` filter is available on journal entries and journal items' list views. + It can be used to find posted journal entries that are not secured yet. +- The option to open the :ref:`secure entries wizard ` is displayed in the + :guilabel:`Accounting` menu. + +.. _data-inalterability/restricted: + +Secure posted entries with hash +=============================== + +To activate the hashing function on a specific journal, go to :menuselection:`Accounting --> +Configuration --> Journals`. Open a sales, purchase, or miscellaneous journal, go to the +:guilabel:`Advanced Settings` tab, and enable :guilabel:`Secure Posted Entries with Hash`. +Journals for which the feature is activated are called "restricted". To compute the hash of an entry, Odoo retrieves the predecessor entries of the chain (i.e., the entries with the same sequence prefix) and hashes them in a continuous way from the last hashed entry to the new entry to hash. .. warning:: - Once you post an entry in a locked journal, you cannot disable the feature anymore, nor edit any - locked entry. + Once you post an entry in a restricted journal, you cannot disable the feature anymore, nor edit + any secured entry. + +.. _data-inalterability/wizard: + +Secure entries wizard +===================== + +You can also use the :guilabel:`Secure Entries` Wizard to secure all journal entries, +in **all** journals, up to a specific date. + +.. note:: + The wizard operates independently of the journal settings and journal types. + +To open it, activate the :ref:`developer mode `, go to :menuselection:`Accounting +--> Accounting`, and click on :guilabel:`Secure Entries`. If the :ref:`inalterability features +` are activated, it is also visible outside the debug +mode. + +To secure entries, select a date up to which all entries should be secured and press +:guilabel:`Secure Entries`. + +.. warning:: + After securing the entries, you can no longer edit them. + +.. note:: + It can happen that entries that are past the selected date are secured. + This is possible since the hash chain corresponds to the sequence prefix, + ordered by sequence number. .. _data-inalterability/report: @@ -50,17 +97,18 @@ Report download To download the data inalterability check report, go to :menuselection:`Accounting --> Configuration --> Settings --> Reporting` and click on :guilabel:`Download the Data Inalterability Check Report`. -The report's first section is an overview of all your journals and their configuration. Under the -inalterability check column, you can see whether or not a journal's entries are locked with a hash -(V) or not (X). The coverage column tells you when a journal's entries started being locked. +The report's first section is an overview of all journal sequence prefixes containing hashed entries. +In the :guilabel:`Restricted` column, you can see whether or not a journal has the :ref:`secure +posted entries with hash ` option (V) activated or not (X). The +:guilabel:`Check` column tells you whether all entries are correctly hashed. .. image:: data_inalterability/journal-overview.png :align: center :alt: Configuration report for two journals -The second section gives you the result of the data consistency check for each hashed journal. You -can view the first hashed entry and its corresponding hash and the last hashed entry and its -corresponding hash. +The second section gives a more detailed result of the data consistency check for each hashed +journal sequence prefix. You can view the first hashed entry and its corresponding hash, +as well as the last hashed entry and its corresponding hash. .. image:: data_inalterability/data-consistency-check.png :align: center diff --git a/content/applications/finance/accounting/reporting/data_inalterability/data-consistency-check.png b/content/applications/finance/accounting/reporting/data_inalterability/data-consistency-check.png index bd3017b38..c8b7ae893 100644 Binary files a/content/applications/finance/accounting/reporting/data_inalterability/data-consistency-check.png and b/content/applications/finance/accounting/reporting/data_inalterability/data-consistency-check.png differ diff --git a/content/applications/finance/accounting/reporting/data_inalterability/journal-overview.png b/content/applications/finance/accounting/reporting/data_inalterability/journal-overview.png index 316c943e2..e50b795b9 100644 Binary files a/content/applications/finance/accounting/reporting/data_inalterability/journal-overview.png and b/content/applications/finance/accounting/reporting/data_inalterability/journal-overview.png differ