[IMP] account_statement_import_online_gocardless: black, isort, prettier

This commit is contained in:
Enric Tobella
2024-12-17 12:10:38 +01:00
parent 73d4689362
commit c19c5f9cb1
11 changed files with 176 additions and 147 deletions

View File

@@ -17,20 +17,20 @@ Online Bank Statements: GoCardless
:target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
:alt: License: AGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fbank--statement--import-lightgray.png?logo=github
:target: https://github.com/OCA/bank-statement-import/tree/16.0/account_statement_import_online_gocardless
:target: https://github.com/OCA/bank-statement-import/tree/17.0/account_statement_import_online_gocardless
:alt: OCA/bank-statement-import
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
:target: https://translation.odoo-community.org/projects/bank-statement-import-16-0/bank-statement-import-16-0-account_statement_import_online_gocardless
:target: https://translation.odoo-community.org/projects/bank-statement-import-17-0/bank-statement-import-17-0-account_statement_import_online_gocardless
:alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
:target: https://runboat.odoo-community.org/builds?repo=OCA/bank-statement-import&target_branch=16.0
:target: https://runboat.odoo-community.org/builds?repo=OCA/bank-statement-import&target_branch=17.0
:alt: Try me on Runboat
|badge1| |badge2| |badge3| |badge4| |badge5|
This module provides online bank statements from GoCardless Bank Account Data,
which provides a free API for connecting and getting transactions for bank
accounts.
This module provides online bank statements from GoCardless Bank Account
Data, which provides a free API for connecting and getting transactions
for bank accounts.
**Table of contents**
@@ -41,61 +41,76 @@ Configuration
=============
On the GoCardless website
~~~~~~~~~~~~~~~~~~~~~~~~~
-------------------------
#. Go to https://bankaccountdata.gocardless.com, and create or login into your
"GoCardLess Bank Account Data" account.
#. Go to Developers > User secrets option on the left.
#. Click on the "+ Create new" button on the bottom part.
#. Put a name to the user secret (eg. Odoo), and optionally limit it to certain
IPs using CIDR subnet notation.
#. Copy or download the secret ID and key for later use. The second one won't be
available anymore, so make sure you don't forget this step.
1. Go to
`https://bankaccountdata.gocardless.com <https://bankaccountdata.gocardless.com>`__,
and create or login into your "GoCardLess Bank Account Data" account.
2. Go to Developers > User secrets option on the left.
3. Click on the "+ Create new" button on the bottom part.
4. Put a name to the user secret (eg. Odoo), and optionally limit it to
certain IPs using CIDR subnet notation.
5. Copy or download the secret ID and key for later use. The second one
won't be available anymore, so make sure you don't forget this step.
On Odoo
~~~~~~~
-------
To configure online bank statements provider:
#. Add your user to the "Full Accounting Settings" group.
#. Go to *Invoicing > Configuration > Accounting > Journals*.
#. Select the journal representing your bank account (or create it).
#. The bank account number should be properly introduced.
#. Set *Bank Feeds* to *Online (OCA)*.
#. Select *GoCardless* as online bank statements provider in
*Online Bank Statements (OCA)* section.
#. Save the journal
#. Click on the created provider.
#. Put your secret ID and secret key on the existing fields.
#. Click on the button "Select Bank Account Identifier".
1. Add your user to the "Full Accounting Settings" group.
.. image:: https://raw.githubusercontent.com/OCA/bank-statement-import/16.0/account_statement_import_online_gocardless/static/img/gocardless_configuration.gif
2. Go to *Invoicing > Configuration > Accounting > Journals*.
#. A new window will appear for selecting the bank entity.
3. Select the journal representing your bank account (or create it).
.. image:: https://raw.githubusercontent.com/OCA/bank-statement-import/16.0/account_statement_import_online_gocardless/static/img/gocardless_bank_selection.gif
4. The bank account number should be properly introduced.
#. Select it, and you will be redirected to the selected entity for introducing
your bank credentials to allow the connection.
#. If the process is completed, and the bank account linked to the journal is
accessible, you'll be again redirected to the online provider form, and
everything will be linked and ready to start the transaction pulling. A
message is logged about it on the chatter.
#. If not, an error message will be logged either in the chatter.
5. Set *Bank Feeds* to *Online (OCA)*.
6. Select *GoCardless* as online bank statements provider in *Online
Bank Statements (OCA)* section.
7. Save the journal
8. Click on the created provider.
9. Put your secret ID and secret key on the existing fields.
10. Click on the button "Select Bank Account Identifier".
|image_01|
11. A new window will appear for selecting the bank entity.
|image_02|
12. Select it, and you will be redirected to the selected entity for
introducing your bank credentials to allow the connection.
13. If the process is completed, and the bank account linked to the
journal is accessible, you'll be again redirected to the online
provider form, and everything will be linked and ready to start the
transaction pulling. A message is logged about it on the chatter.
14. If not, an error message will be logged either in the chatter.
.. |image_01| image:: https://raw.githubusercontent.com/OCA/bank-statement-import/17.0/account_statement_import_online_gocardless/static/img/gocardless_configuration.gif
.. |image_02| image:: https://raw.githubusercontent.com/OCA/bank-statement-import/17.0/account_statement_import_online_gocardless/static/img/gocardless_bank_selection.gif
Usage
=====
To pull historical bank statements:
#. Go to *Invoicing > Configuration > Accounting > Journals*.
#. Select the journal representing your bank account.
#. Launch *Actions > Online Bank Statements Pull Wizard*
#. Configure date interval and click on *Pull*.
1. Go to *Invoicing > Configuration > Accounting > Journals*.
2. Select the journal representing your bank account.
3. Launch *Actions > Online Bank Statements Pull Wizard*
4. Configure date interval and click on *Pull*.
If historical data is not needed, then just simply wait for the scheduled
activity "Pull Online Bank Statements" to be executed for getting new
transactions.
If historical data is not needed, then just simply wait for the
scheduled activity "Pull Online Bank Statements" to be executed for
getting new transactions.
Bug Tracker
===========
@@ -103,7 +118,7 @@ Bug Tracker
Bugs are tracked on `GitHub Issues <https://github.com/OCA/bank-statement-import/issues>`_.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us to smash it by providing a detailed and welcomed
`feedback <https://github.com/OCA/bank-statement-import/issues/new?body=module:%20account_statement_import_online_gocardless%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
`feedback <https://github.com/OCA/bank-statement-import/issues/new?body=module:%20account_statement_import_online_gocardless%0Aversion:%2017.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
Do not contact contributors directly about support or help with technical issues.
@@ -111,27 +126,30 @@ Credits
=======
Authors
~~~~~~~
-------
* ForgeFlow
* Tecnativa
Contributors
~~~~~~~~~~~~
------------
* `ForgeFlow <https://www.forgeflow.com>`__:
- `ForgeFlow <https://www.forgeflow.com>`__:
* Christopher Ormaza
* Jordi Ballester
* `Tecnativa <https://www.tecnativa.com>`__:
- Christopher Ormaza
- Jordi Ballester
* Pedro M. Baeza
* `Alusage <https://nicolas.alusage.fr>`__:
- `Tecnativa <https://www.tecnativa.com>`__:
* Nicolas JEUDY <https://github.com/njeudy>
- Pedro M. Baeza
- `Alusage <https://nicolas.alusage.fr>`__:
- Nicolas JEUDY
<`https://github.com/njeudy <https://github.com/njeudy>`__>
Maintainers
~~~~~~~~~~~
-----------
This module is maintained by the OCA.
@@ -143,6 +161,6 @@ OCA, or the Odoo Community Association, is a nonprofit organization whose
mission is to support the collaborative development of Odoo features and
promote its widespread use.
This module is part of the `OCA/bank-statement-import <https://github.com/OCA/bank-statement-import/tree/16.0/account_statement_import_online_gocardless>`_ project on GitHub.
This module is part of the `OCA/bank-statement-import <https://github.com/OCA/bank-statement-import/tree/17.0/account_statement_import_online_gocardless>`_ project on GitHub.
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

View File

@@ -0,0 +1,3 @@
[build-system]
requires = ["whool"]
build-backend = "whool.buildapi"

View File

@@ -0,0 +1,51 @@
## On the GoCardless website
1. Go to <https://bankaccountdata.gocardless.com>, and create or login
into your "GoCardLess Bank Account Data" account.
2. Go to Developers \> User secrets option on the left.
3. Click on the "+ Create new" button on the bottom part.
4. Put a name to the user secret (eg. Odoo), and optionally limit it to
certain IPs using CIDR subnet notation.
5. Copy or download the secret ID and key for later use. The second one
won't be available anymore, so make sure you don't forget this step.
## On Odoo
To configure online bank statements provider:
1. Add your user to the "Full Accounting Settings" group.
2. Go to *Invoicing \> Configuration \> Accounting \> Journals*.
3. Select the journal representing your bank account (or create it).
4. The bank account number should be properly introduced.
5. Set *Bank Feeds* to *Online (OCA)*.
6. Select *GoCardless* as online bank statements provider in *Online
Bank Statements (OCA)* section.
7. Save the journal
8. Click on the created provider.
9. Put your secret ID and secret key on the existing fields.
10. Click on the button "Select Bank Account Identifier".
![image_01](../static/img/gocardless_configuration.gif)
11. A new window will appear for selecting the bank entity.
![image_02](../static/img/gocardless_bank_selection.gif)
12. Select it, and you will be redirected to the selected entity for
introducing your bank credentials to allow the connection.
13. If the process is completed, and the bank account linked to the
journal is accessible, you'll be again redirected to the online
provider form, and everything will be linked and ready to start the
transaction pulling. A message is logged about it on the chatter.
14. If not, an error message will be logged either in the chatter.

View File

@@ -1,42 +0,0 @@
On the GoCardless website
~~~~~~~~~~~~~~~~~~~~~~~~~
#. Go to https://bankaccountdata.gocardless.com, and create or login into your
"GoCardLess Bank Account Data" account.
#. Go to Developers > User secrets option on the left.
#. Click on the "+ Create new" button on the bottom part.
#. Put a name to the user secret (eg. Odoo), and optionally limit it to certain
IPs using CIDR subnet notation.
#. Copy or download the secret ID and key for later use. The second one won't be
available anymore, so make sure you don't forget this step.
On Odoo
~~~~~~~
To configure online bank statements provider:
#. Add your user to the "Full Accounting Settings" group.
#. Go to *Invoicing > Configuration > Accounting > Journals*.
#. Select the journal representing your bank account (or create it).
#. The bank account number should be properly introduced.
#. Set *Bank Feeds* to *Online (OCA)*.
#. Select *GoCardless* as online bank statements provider in
*Online Bank Statements (OCA)* section.
#. Save the journal
#. Click on the created provider.
#. Put your secret ID and secret key on the existing fields.
#. Click on the button "Select Bank Account Identifier".
.. image:: ../static/img/gocardless_configuration.gif
#. A new window will appear for selecting the bank entity.
.. image:: ../static/img/gocardless_bank_selection.gif
#. Select it, and you will be redirected to the selected entity for introducing
your bank credentials to allow the connection.
#. If the process is completed, and the bank account linked to the journal is
accessible, you'll be again redirected to the online provider form, and
everything will be linked and ready to start the transaction pulling. A
message is logged about it on the chatter.
#. If not, an error message will be logged either in the chatter.

View File

@@ -0,0 +1,7 @@
- [ForgeFlow](https://www.forgeflow.com):
- Christopher Ormaza
- Jordi Ballester
- [Tecnativa](https://www.tecnativa.com):
- Pedro M. Baeza
- [Alusage](https://nicolas.alusage.fr):
- Nicolas JEUDY \<<https://github.com/njeudy>\>

View File

@@ -1,10 +0,0 @@
* `ForgeFlow <https://www.forgeflow.com>`__:
* Christopher Ormaza
* Jordi Ballester
* `Tecnativa <https://www.tecnativa.com>`__:
* Pedro M. Baeza
* `Alusage <https://nicolas.alusage.fr>`__:
* Nicolas JEUDY <https://github.com/njeudy>

View File

@@ -0,0 +1,3 @@
This module provides online bank statements from GoCardless Bank Account
Data, which provides a free API for connecting and getting transactions
for bank accounts.

View File

@@ -1,3 +0,0 @@
This module provides online bank statements from GoCardless Bank Account Data,
which provides a free API for connecting and getting transactions for bank
accounts.

View File

@@ -0,0 +1,10 @@
To pull historical bank statements:
1. Go to *Invoicing \> Configuration \> Accounting \> Journals*.
2. Select the journal representing your bank account.
3. Launch *Actions \> Online Bank Statements Pull Wizard*
4. Configure date interval and click on *Pull*.
If historical data is not needed, then just simply wait for the
scheduled activity "Pull Online Bank Statements" to be executed for
getting new transactions.

View File

@@ -1,10 +0,0 @@
To pull historical bank statements:
#. Go to *Invoicing > Configuration > Accounting > Journals*.
#. Select the journal representing your bank account.
#. Launch *Actions > Online Bank Statements Pull Wizard*
#. Configure date interval and click on *Pull*.
If historical data is not needed, then just simply wait for the scheduled
activity "Pull Online Bank Statements" to be executed for getting new
transactions.

View File

@@ -369,10 +369,10 @@ ul.auto-toc {
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:86c3a6944d510b258d44f2a74e4e9e433cb0e4f9745ca156414b7a5c0d83efb1
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
<p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external image-reference" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OCA/bank-statement-import/tree/16.0/account_statement_import_online_gocardless"><img alt="OCA/bank-statement-import" src="https://img.shields.io/badge/github-OCA%2Fbank--statement--import-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/bank-statement-import-16-0/bank-statement-import-16-0-account_statement_import_online_gocardless"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external image-reference" href="https://runboat.odoo-community.org/builds?repo=OCA/bank-statement-import&amp;target_branch=16.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
<p>This module provides online bank statements from GoCardless Bank Account Data,
which provides a free API for connecting and getting transactions for bank
accounts.</p>
<p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external image-reference" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OCA/bank-statement-import/tree/17.0/account_statement_import_online_gocardless"><img alt="OCA/bank-statement-import" src="https://img.shields.io/badge/github-OCA%2Fbank--statement--import-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/bank-statement-import-17-0/bank-statement-import-17-0-account_statement_import_online_gocardless"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external image-reference" href="https://runboat.odoo-community.org/builds?repo=OCA/bank-statement-import&amp;target_branch=17.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
<p>This module provides online bank statements from GoCardless Bank Account
Data, which provides a free API for connecting and getting transactions
for bank accounts.</p>
<p><strong>Table of contents</strong></p>
<div class="contents local topic" id="contents">
<ul class="simple">
@@ -396,14 +396,15 @@ accounts.</p>
<div class="section" id="on-the-gocardless-website">
<h2><a class="toc-backref" href="#toc-entry-2">On the GoCardless website</a></h2>
<ol class="arabic simple">
<li>Go to <a class="reference external" href="https://bankaccountdata.gocardless.com">https://bankaccountdata.gocardless.com</a>, and create or login into your
“GoCardLess Bank Account Data” account.</li>
<li>Go to
<a class="reference external" href="https://bankaccountdata.gocardless.com">https://bankaccountdata.gocardless.com</a>,
and create or login into your “GoCardLess Bank Account Data” account.</li>
<li>Go to Developers &gt; User secrets option on the left.</li>
<li>Click on the “+ Create new” button on the bottom part.</li>
<li>Put a name to the user secret (eg. Odoo), and optionally limit it to certain
IPs using CIDR subnet notation.</li>
<li>Copy or download the secret ID and key for later use. The second one wont be
available anymore, so make sure you dont forget this step.</li>
<li>Put a name to the user secret (eg. Odoo), and optionally limit it to
certain IPs using CIDR subnet notation.</li>
<li>Copy or download the secret ID and key for later use. The second one
wont be available anymore, so make sure you dont forget this step.</li>
</ol>
</div>
<div class="section" id="on-odoo">
@@ -420,8 +421,8 @@ available anymore, so make sure you dont forget this step.</li>
</li>
<li><p class="first">Set <em>Bank Feeds</em> to <em>Online (OCA)</em>.</p>
</li>
<li><p class="first">Select <em>GoCardless</em> as online bank statements provider in
<em>Online Bank Statements (OCA)</em> section.</p>
<li><p class="first">Select <em>GoCardless</em> as online bank statements provider in <em>Online
Bank Statements (OCA)</em> section.</p>
</li>
<li><p class="first">Save the journal</p>
</li>
@@ -430,18 +431,18 @@ available anymore, so make sure you dont forget this step.</li>
<li><p class="first">Put your secret ID and secret key on the existing fields.</p>
</li>
<li><p class="first">Click on the button “Select Bank Account Identifier”.</p>
<img alt="https://raw.githubusercontent.com/OCA/bank-statement-import/16.0/account_statement_import_online_gocardless/static/img/gocardless_configuration.gif" src="https://raw.githubusercontent.com/OCA/bank-statement-import/16.0/account_statement_import_online_gocardless/static/img/gocardless_configuration.gif" />
<p><img alt="image_01" src="https://raw.githubusercontent.com/OCA/bank-statement-import/17.0/account_statement_import_online_gocardless/static/img/gocardless_configuration.gif" /></p>
</li>
<li><p class="first">A new window will appear for selecting the bank entity.</p>
<img alt="https://raw.githubusercontent.com/OCA/bank-statement-import/16.0/account_statement_import_online_gocardless/static/img/gocardless_bank_selection.gif" src="https://raw.githubusercontent.com/OCA/bank-statement-import/16.0/account_statement_import_online_gocardless/static/img/gocardless_bank_selection.gif" />
<p><img alt="image_02" src="https://raw.githubusercontent.com/OCA/bank-statement-import/17.0/account_statement_import_online_gocardless/static/img/gocardless_bank_selection.gif" /></p>
</li>
<li><p class="first">Select it, and you will be redirected to the selected entity for introducing
your bank credentials to allow the connection.</p>
<li><p class="first">Select it, and you will be redirected to the selected entity for
introducing your bank credentials to allow the connection.</p>
</li>
<li><p class="first">If the process is completed, and the bank account linked to the journal is
accessible, youll be again redirected to the online provider form, and
everything will be linked and ready to start the transaction pulling. A
message is logged about it on the chatter.</p>
<li><p class="first">If the process is completed, and the bank account linked to the
journal is accessible, youll be again redirected to the online
provider form, and everything will be linked and ready to start the
transaction pulling. A message is logged about it on the chatter.</p>
</li>
<li><p class="first">If not, an error message will be logged either in the chatter.</p>
</li>
@@ -457,16 +458,16 @@ message is logged about it on the chatter.</p>
<li>Launch <em>Actions &gt; Online Bank Statements Pull Wizard</em></li>
<li>Configure date interval and click on <em>Pull</em>.</li>
</ol>
<p>If historical data is not needed, then just simply wait for the scheduled
activity “Pull Online Bank Statements” to be executed for getting new
transactions.</p>
<p>If historical data is not needed, then just simply wait for the
scheduled activity “Pull Online Bank Statements” to be executed for
getting new transactions.</p>
</div>
<div class="section" id="bug-tracker">
<h1><a class="toc-backref" href="#toc-entry-5">Bug Tracker</a></h1>
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/bank-statement-import/issues">GitHub Issues</a>.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us to smash it by providing a detailed and welcomed
<a class="reference external" href="https://github.com/OCA/bank-statement-import/issues/new?body=module:%20account_statement_import_online_gocardless%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
<a class="reference external" href="https://github.com/OCA/bank-statement-import/issues/new?body=module:%20account_statement_import_online_gocardless%0Aversion:%2017.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
<p>Do not contact contributors directly about support or help with technical issues.</p>
</div>
<div class="section" id="credits">
@@ -491,7 +492,8 @@ If you spotted it first, help us to smash it by providing a detailed and welcome
</ul>
</li>
<li><a class="reference external" href="https://nicolas.alusage.fr">Alusage</a>:<ul>
<li>Nicolas JEUDY &lt;<a class="reference external" href="https://github.com/njeudy">https://github.com/njeudy</a>&gt;</li>
<li>Nicolas JEUDY
&lt;<a class="reference external" href="https://github.com/njeudy">https://github.com/njeudy</a>&gt;</li>
</ul>
</li>
</ul>
@@ -505,7 +507,7 @@ If you spotted it first, help us to smash it by providing a detailed and welcome
<p>OCA, or the Odoo Community Association, is a nonprofit organization whose
mission is to support the collaborative development of Odoo features and
promote its widespread use.</p>
<p>This module is part of the <a class="reference external" href="https://github.com/OCA/bank-statement-import/tree/16.0/account_statement_import_online_gocardless">OCA/bank-statement-import</a> project on GitHub.</p>
<p>This module is part of the <a class="reference external" href="https://github.com/OCA/bank-statement-import/tree/17.0/account_statement_import_online_gocardless">OCA/bank-statement-import</a> project on GitHub.</p>
<p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p>
</div>
</div>