audrius/bank-statement-import
1
0
Fork 1
mirror of https://github.com/OCA/bank-statement-import.git synced 2025-01-20 12:37:43 +02:00
Code Issues Packages Projects Releases Wiki Activity

[UPD] README.rst

Browse Source
This commit is contained in:
OCA-git-bot
2023-05-01 12:30:48 +00:00
parent b5b58f8537
commit 2b81521fb8
2 changed files with 78 additions and 61 deletions
Download Patch File Download Diff File Expand all files Collapse all files

69
account_statement_import_online_paypal/README.rst
View File

@@ -36,45 +36,54 @@ This module provides online bank statements from
Configuration
=============
To configure online bank statements provider:
You will need a *Client ID* and *Secret* from PayPal to communicate with the PayPal API. To obtain your PayPal API
*Client ID* and *Secret*:
#. Go to *Invoicing > Configuration > Bank Accounts*
#. Open bank account to configure and edit it
#. Set *Bank Feeds* to *Online*
#. Select *PayPal.com* as online bank statements provider in
*Online Bank Statements (OCA)* section
#. Save the bank account
#. Click on provider and configure provider-specific settings.
#. Open `PayPal Developer <https://developer.paypal.com/dashboard/>`_.
#. Login with your *PayPal for Business* account (upgrade your personal account to
a Business Account, if required).
#. Go to *Apps & Credentials* and switch to *Live*.
#. Under *REST API apps*, click *Create App* to begin creating a new application.
#. Enter a descriptive name for your app (e.g. *Odoo-Statements*) and click *Create App*.
#. Copy the *Client ID* and *Secret* to use during provider configuration (instructions below).
#. Under *Features*, uncheck all optional features except *Transaction Search*.
#. Click *Save Changes*.
or, alternatively:
To configure PayPal as an online bank statement provider, you will need to create a Bank Account & Journal that
corresponds to your *PayPal for Business* account, and then configure the *PayPal.com* provider with the *Client ID*
and *Secret* obtained above:
#. Go to *Invoicing > Overview*
#. Open settings of the corresponding journal account
#. Switch to *Bank Account* tab
#. Set *Bank Feeds* to *Online*
#. Select *PayPal.com* as online bank statements provider in
*Online Bank Statements (OCA)* section
#. Save the bank account
#. Click on provider and configure provider-specific settings.
#. Go to *Invoicing > Configuration > Banks > Add a Bank Account*.
#. In the *Account Number* field, enter some descriptive text for the account, such as the email address or *PayPal
Merchant ID* of your *PayPal for Business* account. NOTE: This *Account Number* is not used in the authentication
with PayPal's API, and is only used to distinguish this PayPal Bank Account/Journal from others you may have
configured.
#. Fill in the other fields for the Bank Account if desired, and then click *Create*.
#. Go to *Invoicing > Configuration > Accounting > Journals*.
#. Open and *Edit* the Journal corresponding to the PayPal bank account (this Journal was created automatically
when you created the Bank Account above.
#. Set *Bank Feeds* to *Online (OCA)*.
#. Select *PayPal.com* as the provider in the *Online Bank Statements (OCA)* section.
#. *Save* the Journal.
#. To configure provider-specific settings, click on the provider to open it and click *Edit*.
#. Fill in your desired *Configuration* and *Scheduled Pull* settings.
#. Leave the *API base* field empty, and fill in the *Client ID* and *Secret* from your PayPal
Developer account.
#. Click *Save*.
To obtain *Client ID* and *Secret*:
#. Open `PayPal Developer <https://developer.paypal.com/developer/applications/>`_
#. Go to *My Apps & Credentials* and switch to *Live*
#. Under *REST API apps*, click *Create App* to create new application (e.g. *Odoo*)
#. Copy *Client ID* and *Secret* to use during provider configuration
#. Under *Live App Settings*, uncheck all features except *Transaction Search*
#. Click Save
NOTE: For development and testing purposes, you can create Sandbox credentials associated with your *PayPal
for Business* account. When configuring the provider-specific settings, enter the following in the *API base* field:
https://api.sandbox.paypal.com
Usage
=====
To pull historical bank statements:
#. Go to *Invoicing > Configuration > Bank Accounts*
#. Select specific bank accounts
#. Launch *Actions > Online Bank Statements Pull Wizard*
#. Configure date interval and click *Pull*
#. Go to *Invoicing > Configuration > Accounting > Journals*.
#. Open the Journal corresponding to the PayPal bank account.
#. Click the *Pull Online Bank Statement* button.
#. Configure a date interval and click *Pull*.
Known issues / Roadmap
======================
@@ -83,7 +92,7 @@ Known issues / Roadmap
can be imported manually, see ``account_bank_statement_import_paypal``. See
`PayPal Help Center article <https://www.paypal.com/us/smarthelp/article/why-can't-i-access-transaction-history-greater-than-3-years-ts2241>`_
for details.
* `PayPal Transaction Info <https://developer.paypal.com/docs/api/sync/v1/#definition-transaction_info>`_
* `PayPal Transaction Info <https://developer.paypal.com/docs/api/transaction-search/v1/#definition-transaction_info>`_
defines extra fields like ``tip_amount``, ``shipping_amount``, etc. that
could be useful to be decomposed from a single transaction.
* There's a known issue with PayPal API that on every Monday for couple of

70
account_statement_import_online_paypal/static/description/index.html
View File

@@ -387,45 +387,53 @@ ul.auto-toc {
</div>
<div class="section" id="configuration">
<h1><a class="toc-backref" href="#id1">Configuration</a></h1>
<p>To configure online bank statements provider:</p>
<p>You will need a <em>Client ID</em> and <em>Secret</em> from PayPal to communicate with the PayPal API. To obtain your PayPal API
<em>Client ID</em> and <em>Secret</em>:</p>
<ol class="arabic simple">
<li>Go to <em>Invoicing &gt; Configuration &gt; Bank Accounts</em></li>
<li>Open bank account to configure and edit it</li>
<li>Set <em>Bank Feeds</em> to <em>Online</em></li>
<li>Select <em>PayPal.com</em> as online bank statements provider in
<em>Online Bank Statements (OCA)</em> section</li>
<li>Save the bank account</li>
<li>Click on provider and configure provider-specific settings.</li>
<li>Open <a class="reference external" href="https://developer.paypal.com/dashboard/">PayPal Developer</a>.</li>
<li>Login with your <em>PayPal for Business</em> account (upgrade your personal account to
a Business Account, if required).</li>
<li>Go to <em>Apps &amp; Credentials</em> and switch to <em>Live</em>.</li>
<li>Under <em>REST API apps</em>, click <em>Create App</em> to begin creating a new application.</li>
<li>Enter a descriptive name for your app (e.g. <em>Odoo-Statements</em>) and click <em>Create App</em>.</li>
<li>Copy the <em>Client ID</em> and <em>Secret</em> to use during provider configuration (instructions below).</li>
<li>Under <em>Features</em>, uncheck all optional features except <em>Transaction Search</em>.</li>
<li>Click <em>Save Changes</em>.</li>
</ol>
<p>or, alternatively:</p>
<p>To configure PayPal as an online bank statement provider, you will need to create a Bank Account &amp; Journal that
corresponds to your <em>PayPal for Business</em> account, and then configure the <em>PayPal.com</em> provider with the <em>Client ID</em>
and <em>Secret</em> obtained above:</p>
<ol class="arabic simple">
<li>Go to <em>Invoicing &gt; Overview</em></li>
<li>Open settings of the corresponding journal account</li>
<li>Switch to <em>Bank Account</em> tab</li>
<li>Set <em>Bank Feeds</em> to <em>Online</em></li>
<li>Select <em>PayPal.com</em> as online bank statements provider in
<em>Online Bank Statements (OCA)</em> section</li>
<li>Save the bank account</li>
<li>Click on provider and configure provider-specific settings.</li>
</ol>
<p>To obtain <em>Client ID</em> and <em>Secret</em>:</p>
<ol class="arabic simple">
<li>Open <a class="reference external" href="https://developer.paypal.com/developer/applications/">PayPal Developer</a></li>
<li>Go to <em>My Apps &amp; Credentials</em> and switch to <em>Live</em></li>
<li>Under <em>REST API apps</em>, click <em>Create App</em> to create new application (e.g. <em>Odoo</em>)</li>
<li>Copy <em>Client ID</em> and <em>Secret</em> to use during provider configuration</li>
<li>Under <em>Live App Settings</em>, uncheck all features except <em>Transaction Search</em></li>
<li>Click Save</li>
<li>Go to <em>Invoicing &gt; Configuration &gt; Banks &gt; Add a Bank Account</em>.</li>
<li>In the <em>Account Number</em> field, enter some descriptive text for the account, such as the email address or <em>PayPal
Merchant ID</em> of your <em>PayPal for Business</em> account. NOTE: This <em>Account Number</em> is not used in the authentication
with PayPal’s API, and is only used to distinguish this PayPal Bank Account/Journal from others you may have
configured.</li>
<li>Fill in the other fields for the Bank Account if desired, and then click <em>Create</em>.</li>
<li>Go to <em>Invoicing &gt; Configuration &gt; Accounting &gt; Journals</em>.</li>
<li>Open and <em>Edit</em> the Journal corresponding to the PayPal bank account (this Journal was created automatically
when you created the Bank Account above.</li>
<li>Set <em>Bank Feeds</em> to <em>Online (OCA)</em>.</li>
<li>Select <em>PayPal.com</em> as the provider in the <em>Online Bank Statements (OCA)</em> section.</li>
<li><em>Save</em> the Journal.</li>
<li>To configure provider-specific settings, click on the provider to open it and click <em>Edit</em>.</li>
<li>Fill in your desired <em>Configuration</em> and <em>Scheduled Pull</em> settings.</li>
<li>Leave the <em>API base</em> field empty, and fill in the <em>Client ID</em> and <em>Secret</em> from your PayPal
Developer account.</li>
<li>Click <em>Save</em>.</li>
</ol>
<p>NOTE: For development and testing purposes, you can create Sandbox credentials associated with your <em>PayPal
for Business</em> account. When configuring the provider-specific settings, enter the following in the <em>API base</em> field:
<a class="reference external" href="https://api.sandbox.paypal.com">https://api.sandbox.paypal.com</a></p>
</div>
<div class="section" id="usage">
<h1><a class="toc-backref" href="#id2">Usage</a></h1>
<p>To pull historical bank statements:</p>
<ol class="arabic simple">
<li>Go to <em>Invoicing &gt; Configuration &gt; Bank Accounts</em></li>
<li>Select specific bank accounts</li>
<li>Launch <em>Actions &gt; Online Bank Statements Pull Wizard</em></li>
<li>Configure date interval and click <em>Pull</em></li>
<li>Go to <em>Invoicing &gt; Configuration &gt; Accounting &gt; Journals</em>.</li>
<li>Open the Journal corresponding to the PayPal bank account.</li>
<li>Click the <em>Pull Online Bank Statement</em> button.</li>
<li>Configure a date interval and click <em>Pull</em>.</li>
</ol>
</div>
<div class="section" id="known-issues-roadmap">
@@ -435,7 +443,7 @@ ul.auto-toc {
can be imported manually, see <tt class="docutils literal">account_bank_statement_import_paypal</tt>. See
<a class="reference external" href="https://www.paypal.com/us/smarthelp/article/why-can't-i-access-transaction-history-greater-than-3-years-ts2241">PayPal Help Center article</a>
for details.</li>
<li><a class="reference external" href="https://developer.paypal.com/docs/api/sync/v1/#definition-transaction_info">PayPal Transaction Info</a>
<li><a class="reference external" href="https://developer.paypal.com/docs/api/transaction-search/v1/#definition-transaction_info">PayPal Transaction Info</a>
defines extra fields like <tt class="docutils literal">tip_amount</tt>, <tt class="docutils literal">shipping_amount</tt>, etc. that
could be useful to be decomposed from a single transaction.</li>
<li>There’s a known issue with PayPal API that on every Monday for couple of