[MOV] accounting: structure of bank sync docs

Part-of: odoo/documentation#3993
2023-03-31 09:50:37 +00:00
parent ee8341402a
commit d694c6c9f5
21 changed files with 44 additions and 57 deletions
@@ -0,0 +1,117 @@
+=====
+Ponto
+=====
+
+**Ponto** is a service that allows companies and professionals to aggregate their accounts in one
+place and directly see all their transactions within one app. It is a third-party solution that is
+continuously expanding the number of bank institutions that can be synchronized with Odoo.
+
+.. image:: ponto/ponto-logo.png
+   :align: center
+   :alt: Logo of the Ponto brand
+
+**Odoo** can synchronize directly with your bank to get all bank statements imported automatically
+into your database.
+
+Ponto is a paid third-party provider that can handle the synchronization between your bank accounts
+and Odoo. `Its pricing is 4€/month per account/integration <https://myponto.com/en#pricing>`_.
+
+.. seealso::
+   - :doc:`../bank_synchronization`
+   - :doc:`../transactions`
+
+Configuration
+=============
+
+Link your bank accounts with Ponto
+----------------------------------
+
+#. Go to `Ponto's website (https://myponto.com) <https://myponto.com>`_.
+#. Create an account if you don't have one yet.
+#. Once you are logged in, create an *organization*.
+
+   .. image:: ponto/ponto-organization.png
+      :align: center
+      :alt: Fill out the form to add an organization in Ponto.
+
+#. | Go to :menuselection:`Accounts --> Live`, and click on *Add account*.
+   | You might have to add your **Billing Information** first.
+#. Select your country, your bank institutions, give your consent to Ponto, and follow the steps
+   on-screen to link your bank account with your Ponto account.
+
+   .. image:: ponto/ponto-add-account.png
+      :align: center
+      :alt: Add bank accounts to your Ponto account.
+
+#. Make sure to add all bank accounts you want to synchronize with your Odoo database before moving
+   on to the next steps.
+
+Link your Ponto account with your Odoo database
+-----------------------------------------------
+
+#. Go to :menuselection:`Accounting --> Configuration --> Add a Bank Account`.
+#. Search your institution, make sure to select the right institution. By selecting the institution,
+   you can verify that the third party provider is Ponto.
+#. Click on *Connect* and follow the steps.
+#. At some point, you will have to authorize the accounts you want to access in Odoo. Please select
+   **all the accounts** you want to synchronize. Even the ones coming from other banking
+   institutions.
+
+   .. image:: ponto/ponto-select-accounts.png
+      :align: center
+      :alt: Selection of the accounts you wish to synchronize with Odoo.
+
+#. Finish the flow.
+
+.. note::
+   You have to authorize all the accounts you want to access in Odoo, but Odoo will filter the
+   accounts based on the institution you selected in the second step.
+
+Update your synchronization credentials
+---------------------------------------
+
+You might have to update your Ponto credentials or modify the synchronization settings.
+
+To do so, go to :menuselection:`Accounting --> Configuration --> Online Synchronization` and select
+the institution you want to fetch the other accounts. Click on *Fetch Accounts* button to start the
+flow.
+
+During the update, select **all the accounts** you want to synchronize, even the ones coming
+from other banking institutions.
+
+Fetch new accounts
+------------------
+
+You might want to add new online accounts to your connection.
+
+To do so, go to :menuselection:`Accounting --> Configuration --> Online Synchronization` and select
+the institution you want to fetch the other accounts. Click on *Fetch Accounts* button to start the
+flow.
+
+Don't forget to keep authorization for existing accounts (for all institutions that you
+have synchronized with Ponto).
+
+FAQ
+===
+
+After my synchronization, no account appears
+--------------------------------------------
+
+You selected an institution from the list and did not authorize any accounts from this institution.
+
+I have an error about that my authorization has expired
+-------------------------------------------------------
+
+Every **3 months** (90 days) you must re-authorize the connection between your bank account
+and Ponto. This must be done from the `Ponto website <https://myponto.com>`_. If you do not
+do this, the synchronization will stop for these accounts.
+
+I have some errors with my beta institution
+-------------------------------------------
+
+Ponto provides institutions in *beta*, these institutions are not directly supported by Odoo
+and we advise you to contact Ponto directly.
+
+.. important::
+   Using an institution in beta is beneficial for Ponto, it allows them to have real
+   feedback on the connection with the institution.
@@ -0,0 +1,108 @@
+=========
+Salt Edge
+=========
+
+**Salt Edge** is a third-party provider that aggregates banking information
+from your bank accounts. It supports ~5000 institutions in more than 50
+countries.
+
+.. image:: saltedge/saltedge-logo.png
+   :align: center
+   :width: 50%
+   :alt: Salt Edge Logo
+
+Odoo can synchronize directly with your bank to get all bank statements imported
+automatically into your database.
+
+.. seealso::
+   - :doc:`../bank_synchronization`
+   - :doc:`../transactions`
+
+Configuration
+=============
+
+Link your bank accounts with Odoo
+---------------------------------
+
+#. Start synchronization by clicking on :menuselection:`Accounting --> Configuration
+   --> Add a Bank Account`.
+#. Select the institution you want to synchronize. You can see if Salt Edge is the
+   third party provider of the institution by selecting it.
+#. After giving your phone number, you are asked for an email address. This email
+   address is used to create your Salt Edge account. Please make sure you enter a
+   valid email address, as otherwise, you will not be able to access your Salt Edge
+   account.
+
+   .. image:: saltedge/saltedge-contact-email.png
+      :align: center
+      :alt: Email address to provide to Salt Edge for the creation of your account.
+
+#. After entering your email address, you are redirected to Salt Edge to continue
+   the synchronization process.
+
+   .. image:: saltedge/saltedge-login-page.png
+      :align: center
+      :alt: Salt Edge Login page.
+
+#. Make sure you give your consent by checking the consent checkbox.
+
+   .. image:: saltedge/saltedge-give-consent.png
+      :align: center
+      :alt: Salt Edge give consent page.
+
+#. Complete the synchronization by following the steps.
+
+
+Update your credentials
+-----------------------
+
+You might have to update your Salt Edge credentials or modify the synchronization settings.
+
+To do so, go to :menuselection:`Accounting --> Configuration --> Online Synchronization` and
+select the institution you want to update credentials. Click on the *Update Credentials* button
+to start the flow and follow the steps.
+
+Don't forget to check the consent checkbox. Otherwise, Odoo may not be able to access
+your information.
+
+Fetch new accounts
+------------------
+
+You might want to add new online accounts to your connection.
+
+To do so, go to :menuselection:`Accounting --> Configuration --> Online Synchronization` and
+select the institution to fetch the new accounts. Click on the *Fetch Accounts* button
+to start the flow and follow the steps.
+
+Don't forget to check the consent checkbox. Otherwise, Odoo may not be able to access
+your information.
+
+FAQ
+===
+
+I have an error when I try to delete my synchronization within Odoo
+-------------------------------------------------------------------
+
+Odoo can't permanently delete the connection you have created with the banking institution. However,
+it can revoke the consent you gave so that Odoo won't be able to access your account anymore. The
+error you are seeing is probably a message telling you that the consent was revoked, but the record
+could not be deleted as it still exists within Salt edge. If you want to remove the connection
+completely, please connect to your `Salt Edge account <https://www.saltedge.com/dashboard>`_
+and manually delete your synchronization. Once this is done, you can go back to Odoo to delete the
+record.
+
+I have an error saying that I have already synchronized this account
+--------------------------------------------------------------------
+
+You have probably already synchronized your bank account with Salt Edge, please check on your `dashboard
+<https://www.saltedge.com/dashboard>`_ that you don't already have a connection with the same
+credentials.
+
+In case you already have a synchronization with the same credentials present on your Salt Edge
+dashboard and this synchronization has not been created with Odoo, please delete it and create it
+from your Odoo database.
+
+In case you already have a connection with the same credentials present on your Salt Edge dashboard
+and this synchronization was created with Odoo, you will normally be able to find it by going to
+:menuselection:`Accounting --> Configuration --> Online Synchronization`. Please make sure to do an
+*Update Credentials* to reactivate the connection.