[IMP] l10n: update CodaBox documentation

This commit updates the documentation of CodaBox:
- new connection process
- new revocation process
- modified potential errors

closes odoo/documentation#7761

Related: odoo/enterprise#56838
Signed-off-by: Ricardo Gomes Rodrigues (rigr) <rigr@odoo.com>
This commit is contained in:
Ricardo Gomes Rodrigues 2024-02-16 11:19:58 +01:00
parent 3d83bec933
commit 2c6c7a0dcd
2 changed files with 77 additions and 111 deletions

View File

@ -124,7 +124,7 @@ Categories`. Some categories already exist by default but do not have any rates.
This makes the vehicle mandatory while booking a vendor bill.
To link a disallowed expenses category with a specific account, go to :menuselection:`Accounting -->
Configuration --> Acounting: Chart of Accounts`. Find the account you want, and click on
Configuration --> Accounting: Chart of Accounts`. Find the account you want, and click on
:guilabel:`Setup`. Add the :guilabel:`Disallowed Expense category` in the :guilabel:`Disallowed
Expenses` field. From now, when an expense is created with this account, the disallowed expense is
calculated based on the rate mentioned in the :guilabel:`Disallowed Expense category`.
@ -234,8 +234,7 @@ SODA
files can be imported into the journal you use to record salaries by going to your Accounting
**dashboard** and clicking :guilabel:`Upload` in the related journal card form.
Once your **SODA** files are imported, the entries are created automatically in your 'salary'
journal.
Once your **SODA** files are imported, the entries are created automatically in your salary journal.
.. image:: belgium/soda-import.png
:alt: Import SODA files
@ -245,7 +244,7 @@ journal.
CodaBox
-------
**CodaBox** is a service that allows Belgian accounting firms accessing their clients' bank
**CodaBox** is a service that allows Belgian accounting firms to access their clients' bank
information and statements. Odoo provides a way to import such statements automatically.
.. note::
@ -259,15 +258,16 @@ The configuration must be done on each client database. In the following
instructions, we will refer to your client's company as *Company* and to your
accounting firm as *Accounting Firm*.
You must first :ref:`Install <general/install>` :guilabel:`CodaBox` to start.
You must first :ref:`install <general/install>` :guilabel:`CodaBox` and
:guilabel:`CodaBox Bridge Wizard` (if available) to start.
.. important::
Make sure the company settings are correctly configured, i.e., the country is set to
:guilabel:`Belgium`, the :guilabel:`Tax ID` and :guilabel:`Accounting Firm` fields are filled,
as well as the :guilabel:`Tax ID` of the accounting firm (unless it is the same as the
company's :guilabel:`Tax ID`).
as well as the :guilabel:`Tax ID` of the accounting firm (if not filled, the :guilabel:`Tax ID`
of the company is used).
Configure the Journals
Configure the journals
**********************
.. tabs::
@ -276,7 +276,7 @@ Configure the Journals
#. :doc:`Create a new bank journal <../accounting/bank>`.
#. Set the right IBAN in the :guilabel:`Account Number` field.
#. Select :guilabel:`CodaBox synchronisation` as the :guilabel:`Bank Feed`.
#. Select :guilabel:`CodaBox synchronization` as the :guilabel:`Bank Feed`.
.. image:: belgium/codabox_configuration_coda_journal.png
:align: center
@ -285,7 +285,8 @@ Configure the Journals
.. tab:: For SODA files
#. Create a new miscellaneous journal.
#. Go to :menuselection:`Accounting --> Configuration --> Accounting: CodaBox`.
#. Go to :menuselection:`Accounting --> Configuration --> Settings`, then go to the
:guilabel:`CodaBox` section.
#. Select the journal you just created in the SODA journal field.
.. image:: belgium/codabox_configuration_soda_setting.png
@ -294,54 +295,28 @@ Configure the Journals
.. _belgium/codabox-configuration-connection:
Configure the Connection
Configure the connection
************************
First, you must select which users can access the **CodaBox** connection settings. To do so, go to
:menuselection:`Settings --> Users & Companies --> Groups`, and search for the group
:guilabel:`Allow to show and modify the CodaBox Connection Settings`. Add the users you want
to this group. By default, only the :guilabel:`Administrator` is part of this group.
#. Go to :menuselection:`Accounting --> Configuration --> Settings`, then go to the
:guilabel:`CodaBox` section.
#. Click on :guilabel:`Manage Connection` to open the connection wizard, which shows the
:guilabel:`Accounting Firm VAT` number and the :guilabel:`Company VAT` number that will be used
for the connection.
#. If this is your **first connection**, click on :guilabel:`Create connection`.
The wizard confirms that the connection has been created on **Odoo's side**. Follow the steps
to validate the connection on **CodaBox's side**, too.
Then, to configure the connection itself, go to
:menuselection:`Accounting --> Configuration --> Accounting: CodaBox`.
If this is **not your first connection**, the :guilabel:`Accounting Firm Password` provided by
Odoo during the first connection will be requested to create a new connection.
The procedure differs depending on whether **CodaBox** is
being setup for a first client or an additional one.
.. note::
This :guilabel:`Accounting Firm Password` is unique to Odoo and must be stored securely
on your side.
.. tabs::
The :guilabel:`Status` should have now switched to :guilabel:`Connected`.
.. tab:: First connection
#. Click on :guilabel:`Connect`, where you are redirected to
the **CodaBox** platform, here validate the connection.
#. Once redirected back to Odoo, the :guilabel:`Status` should be set to
:guilabel:`Connected` and a new field :guilabel:`Access Token` should appear
with a unique value generated by Odoo.
.. image:: belgium/codabox_configuration_connection_ok.png
:align: center
:alt: Configured connection.
.. note::
This Odoo :guilabel:`Access Token` will be used to create new connections
for other clients without having to validate the connection again.
.. tab:: Following connection
#. Copy the :guilabel:`Access Token` from a previous connection.
#. Click on :guilabel:`Connect`.
The **CodaBox** connection linked to the :guilabel:`Access Token` should still exist,
therefore there is no need to validate the connection again. A new and different
:guilabel:`Access Token` is generated by Odoo, and the :guilabel:`Status` should be set to
:guilabel:`Connected`.
.. note::
By having a different :guilabel:`Access Token` for each client, you can
easily revoke the access of a client to your CodaBox account without
affecting the other clients. One client cannot interfere with another.
Synchronisation
Synchronization
~~~~~~~~~~~~~~~
Once the connection is established, Odoo can be synchronized with CodaBox.
@ -360,87 +335,78 @@ Once the connection is established, Odoo can be synchronized with CodaBox.
.. tab:: For SODA files
SODA files are automatically imported from CodaBox once a day as draft. You do
not have to do anything. However, if you wish, it can also be done manually,
by clicking on :guilabel:`Fetch SODA's` in the Accounting Dashboard.
SODA files are automatically imported from CodaBox once a day as a draft. You do not have to
do anything. However, if you wish, it can also be done manually by clicking on
:guilabel:`Fetch SODA's` in the Accounting Dashboard.
By default, if an account in the SODA is not mapped to an account in Odoo, the Suspense
Account (499000) is used and a note is left in the created journal entry.
By default, if an account in the SODA file is not mapped to an account in Odoo, the Suspense
Account (499000) is used, and a note is added to the created journal entry.
.. image:: belgium/codabox_dashboard_soda.png
:align: center
:alt: Manually fetch SODA's.
.. note::
You can access the mapping between the SODA accounts and the Odoo accounts by clicking
on the :guilabel:`SODA Mapping` button in
:menuselection:`Accounting --> Configuration --> Accounting: CodaBox`.
You can access the mapping between the SODA and Odoo accounts by going to
:menuselection:`Accounting --> Configuration --> Settings` and clicking on the
:guilabel:`Open SODA Mapping` button in the :guilabel:`CodaBox` section.
.. note::
The connection between Odoo and CodaBox can be revoked by using the
:guilabel:`Revoke` button in the CodaBox settings, which will revoke
the link on Odoo's side only.
If you have multiple connections, you will still be able to use the
Access Token of one of them to easily reconnect Odoo and CodaBox for
another client.
However, if you have only one (remaining) connection, you will not be able
to use its Access Token to create new connections. In that case, you will
have to revoke the connection from the CodaBox platform too,
and then recreate a new one following the steps in the
:ref:`first connection <belgium/codabox-configuration-connection>` section.
Potential issues
~~~~~~~~~~~~~~~~
CodaBox is not configured. Please check your configuration.
Either the Company VAT of the Accounting Firm VAT is not set.
* **CodaBox is not configured. Please check your configuration.**
It seems that the fiduciary VAT number you provided is not valid. Please check your configuration.
Either the Company VAT of the Accounting Firm VAT is in the wrong format.
Either the :guilabel:`Company VAT` or the :guilabel:`Accounting Firm VAT` is not set.
It seems that the fiduciary VAT number you provided does not exist in CodaBox. Please check your configuration.
The Accounting Firm VAT number you provided is not registered in CodaBox.
* **No connection exists with these accounting firms and company VAT numbers.**
**Please check your configuration.**
Error while connecting to the IAP server. Please contact Odoo support.
It seems that Odoo's IAP server is down or unreachable. Please contact
Odoo support.
This can happen when checking the connection status, and the :guilabel:`Accounting Firm VAT` and
:guilabel:`Company VAT` combination still needs to be registered. This may happen if you have
changed the :guilabel:`Company VAT` after the connection was established. For security reasons,
you have to :ref:`recreate a connection <belgium/codabox-configuration-connection>`
for this :guilabel:`Company VAT`.
It seems that your CodaBox connection is not valid anymore. Please check your configuration.
It seems that you have either revoked the access of Odoo to your CodaBox account, or that
you have not completed the configuration process. In this case, you must click on the
:guilabel:`Revoke connection` button in the settings, and follow again the steps in
the :ref:`first connection <belgium/codabox-configuration-connection>` section.
* **It seems that your CodaBox connection is not valid anymore. Please connect again.**
A previous CodaBox registration already exists. Paste the access token from a previous connection here. Odoo will generate a new one, exclusive to this database.
It seems that you have already your Accounting Firm with Odoo, but that the Access Token
is either not filled or wrong. You should follow the steps in the
:ref:`following connection <belgium/codabox-configuration-connection>` tab section.
This can happen if you revoke Odoo's access to your CodaBox account or still need to complete
the configuration process. In this case, you must revoke the connection and create a new one.
If you have lost your Access Token, you have to go on the CodaBox platform,
and revoke the access of Odoo to your CodaBox account. Then, you will have to follow
the steps in the :ref:`first connection <belgium/codabox-configuration-connection>` section.
* **The provided password is not valid for this accounting firm.**
**You must reuse the password you received from Odoo during your first connection.**
The provided access token is not valid for this fiduciary. Please check your configuration. If you have lost your access token, please contact Odoo support.
Same as above.
The password you provided is different from the one you received from Odoo during your first
connection. You must use the password you received from Odoo during your first connection to
create a new connection for this accounting firm. If you have lost your password, you must first
revoke the Odoo connection on CodaBox's side (i.e., on your myCodaBox portal). Then, you can
revoke the connection on Odoo's side and
:ref:`create a new one <belgium/codabox-configuration-connection>`.
It seems that no connection linked to your database/VAT number exists. Please check your configuration.
You may obtain this error when revoking or trying to fetch files from CodaBox if
the pair (Accounting Firm VAT, Company VAT) is not registered yet. This may happen if
you have changed the company VAT after the connection was established for instance.
For security reasons, you have to recreate a connection for this company VAT by following the
steps in the :ref:`first connection <belgium/codabox-configuration-connection>` section.
* **It seems that the company or accounting firm VAT number you provided is not valid.**
**Please check your configuration.**
No files were found. Please check your configuration.
This may occur if the company VAT has changed after the connection was established.
In that case, you must click on the :guilabel:`Revoke connection` button in the settings,
and recreate the connection.
Either the :guilabel:`Company VAT` or the :guilabel:`Accounting Firm VAT` is not in a valid
Belgian format.
It seems you have already created a connection to CodaBox with this fiduciary. To create a new connection, you must first revoke the old one on myCodaBox portal.
You must go on the CodaBox platform, and revoke the access of Odoo to your CodaBox account.
Then, you will have to follow the steps in the
:ref:`first connection <belgium/codabox-configuration-connection>` section.
* **It seems that the accounting firm VAT number you provided does not exist in CodaBox.**
**Please check your configuration.**
The :guilabel:`Accounting Firm VAT` number you provided is not registered in CodaBox.
You may not have a valid CodaBox license linked to this VAT number.
* **It seems you have already created a connection to CodaBox with this accounting firm.**
**To create a new connection, you must first revoke the old one on myCodaBox portal.**
You must go to your myCodaBox portal and revoke Odoo's access to your CodaBox account.
Then, you can :ref:`create a new connection <belgium/codabox-configuration-connection>`
on Odoo's side.
.. tip::
To revoke the connection between Odoo and CodaBox, go to
:menuselection:`Accounting --> Configuration --> Settings`, scroll down to the
:guilabel:`CodaBox` section, click on :guilabel:`Manage Connection`, then click on
:guilabel:`Revoke`.
Electronic invoicing
====================

Binary file not shown.

Before

Width:  |  Height:  |  Size: 4.9 KiB