From 6a3845ce85fbef119a3081632791dc1514181bbc Mon Sep 17 00:00:00 2001 From: Jonathan <46810843+jcs-odoo@users.noreply.github.com> Date: Mon, 11 May 2020 14:26:36 +0200 Subject: [PATCH] [IMP] accounting: update doc about Sepa Direct Debit batch payments (#670) --- .../customer_payments/batch_sdd.rst | 166 ++++++++++-------- .../{batch_sdd05.png => batch-sdd-batch.png} | Bin ...{batch_sdd04.png => batch-sdd-collect.png} | Bin ....png => batch-sdd-creditor-identifier.png} | Bin ...h_sdd02.png => batch-sdd-mandate-form.png} | Bin ...h_sdd03.png => batch-sdd-revoke-close.png} | Bin .../{batch_sdd06.png => batch-sdd-xml.png} | Bin 7 files changed, 96 insertions(+), 70 deletions(-) rename accounting/receivables/customer_payments/media/{batch_sdd05.png => batch-sdd-batch.png} (100%) rename accounting/receivables/customer_payments/media/{batch_sdd04.png => batch-sdd-collect.png} (100%) rename accounting/receivables/customer_payments/media/{batch_sdd01.png => batch-sdd-creditor-identifier.png} (100%) rename accounting/receivables/customer_payments/media/{batch_sdd02.png => batch-sdd-mandate-form.png} (100%) rename accounting/receivables/customer_payments/media/{batch_sdd03.png => batch-sdd-revoke-close.png} (100%) rename accounting/receivables/customer_payments/media/{batch_sdd06.png => batch-sdd-xml.png} (100%) diff --git a/accounting/receivables/customer_payments/batch_sdd.rst b/accounting/receivables/customer_payments/batch_sdd.rst index 76265a7fd..b71ba4e56 100644 --- a/accounting/receivables/customer_payments/batch_sdd.rst +++ b/accounting/receivables/customer_payments/batch_sdd.rst @@ -1,117 +1,146 @@ ======================================= Batch Payments: SEPA Direct Debit (SDD) ======================================= -SEPA, the Single Euro Payments Area, is a payment-integration -initiative of the European Union for simplification of bank transfers -denominated in EURO. With **SEPA Direct Debit**, your customers can -sign a **mandate** that authorizes you to collect future payments -from their bank accounts automatically. -You can record your customer mandates in Odoo, and generate XML -files containing pending payments made with an SDD mandate. +SEPA, the Single Euro Payments Area, is a payment-integration initiative of the European Union for +simplification of bank transfers denominated in EURO. With **SEPA Direct Debit**, your customers can +sign a **mandate** that authorizes you to collect future payments from their bank accounts. This is +particularly useful for recurring payments based on a subscription. + +You can record customer mandates in Odoo, and generate XML files containing pending payments made +with an SDD mandate. .. note:: - | SDD is supported by all SEPA countries, which includes the 28 member states of the European Union as well as additional countries. - | `List of all SEPA countries `_. + | SDD is supported by all SEPA countries, which includes the 27 member states of the European + Union as well as additional countries. + | `List of all SEPA countries + `_. Configuration ============= -Go to :menuselection:`Accounting --> Configuration --> Settings` -nd activate the **SEPA Direct Debit (SDD)** feature. Enter the -**Creditor Identifier** of your company. This number is provided -by your bank, or the authority responsible for delivering them. -.. image:: media/batch_sdd01.png +Go to :menuselection:`Accounting --> Configuration --> Settings`, activate **SEPA Direct Debit +(SDD)** and click on *Save*. Enter your company's **Creditor Identifier**. This number is provided +by your bank institution, or the authority responsible for delivering them. + +.. image:: media/batch-sdd-creditor-identifier.png :align: center + :alt: Add a SEPA Creditor Identifier to Odoo Accounting SEPA Direct Debit Mandates ========================== + Create a mandate ---------------- -The SEPA Direct Debit Mandate is the document that your customers -sign to authorize you to collect money directly from their bank accounts. -To create a new one, go to :menuselection:`Accounting --> Customers ---> Direct Debit Mandates`, click on *Create*, and fill out the -new mandate’s form. +The SEPA Direct Debit Mandate is the document that your customers sign to authorize you to collect +money directly from their bank accounts. -.. image:: media/batch_sdd02.png +To create a new mandate, go to :menuselection:`Accounting --> Customers --> Direct Debit Mandates`, +click on *Create*, and fill out the form. + +.. image:: media/batch-sdd-mandate-form.png :align: center + :alt: Fill out SEPA Direct Debit in Odoo Accounting -First, export the PDF file by clicking on *Print*. -It is then up to your customer to sign this document. -Once done, upload the signed file in the **Original Document** -field, and click on *Validate* to start running the mandate. +Export the PDF file by clicking on *Print*. It is then up to your customer to sign this document. +Once done, upload the signed file in the **Original Document** field, and click on *Validate* to +start running the mandate. -.. tip:: - First, make sure, that the **IBAN bank accounts details** - are correctly recorded on the debtor’s contact form, under - the *Accounting* tab, and in your own *Bank Account* settings. +.. important:: + Make sure that the **IBAN bank accounts details** are correctly recorded on the debtor’s contact + form, under the *Accounting* tab, and in your own :doc:`Bank Account + <../../bank/setup/bank_accounts>` settings. + +SEPA Direct Debit as a Payment Method +------------------------------------- + +SEPA Direct Debit can be used as a payment method both on your **eCommerce** or on the **Customer +Portal** by activating SDD as a **Payment Acquirer**. With this method, your customers can create +and sign their mandates themselves. + +To do so, go to :menuselection:`Accounting --> Configuration --> Payment Acquirers`, click on *SEPA +Direct Debit*, and set it up according to your needs. + +.. important:: + Make sure to change the **State** field to *Enabled*, and to check **Online Signature**, as this + is necessary to let your customers sign their mandates. + +Customers using SDD as payment method get prompted to add their IBAN, email address, and to sign +their SEPA Direct Debit mandate. + +.. todo:: + Add link to future **Payment Acquirer** documentation. Close or revoke a mandate ------------------------- -Direct Debit mandates are closed automatically after their *End Date*. -If this field is left blank, then the mandate keeps being *Active* -until it is *Closed* or *Revoked*. -.. image:: media/batch_sdd03.png +Direct Debit mandates are closed automatically after their *End Date*. If this field is left blank, +the mandate keeps being *Active* until it is *Closed* or *Revoked*. + +.. image:: media/batch-sdd-revoke-close.png :align: center + :alt: Close or Revoke an SDD Mandate in Odoo Accounting -Clicking on **Close** updates the mandate’s end day to the current day. -This means that invoices made after the present day won’t be processed -automatically with an SDD payment. +Clicking on **Close** updates the mandate’s end day to the current day. This means that invoices +issued after the present day will not be processed with an SDD payment. -Clicking on **Revoke** disables the mandate immediately. No SDD -payment can be registered anymore, regardless of the invoice’s date. -However, payments that have already been registered will still be -included to the next SDD XML file. +Clicking on **Revoke** disables the mandate immediately. No SDD payment can be registered anymore, +regardless of the invoice’s date. However, payments that have already been registered are still +included in the next SDD XML file. -.. note:: - Once a mandate has been *closed* or *revoked*, it cannot be reactivated. - If a customer requires to pay with SDD payments again, you will have - to create a new mandate from scratch. +.. warning:: + Once a mandate has been *closed* or *revoked*, it cannot be reactivated. Get paid with SDD Batch Payments ================================ + Customer Invoices ----------------- -All new posted invoice issued to customers with an active mandate -will automatically register payment and have their status marked as *Paid*. -.. tip:: - If you have unpaid invoices that could be paid with a new mandate, - it is still possible to do it. Go on the invoice, click on *Register Payment* - and choose *SEPA Direct Debit* as payment method. +You can register SDD payments for invoices issued to customers who have an active SDD mandate. + +To do so, open the invoice, click on *Register Payment*, and choose *SEPA Direct Debit* as payment +method. + +.. note:: + In previous versions, Odoo used SDD payment as the default payment for all customers with an + active mandate. Your customers can still activate automatic SDD for their subscriptions with a + recurring payment. Generate SEPA Direct Debit XML files to submit payments ------------------------------------------------------- -To submit your SDD payments to your bank, you will first generate an -**XML file** that can be uploaded directly to your bank interface. -The files generated by Odoo follow the SEPA Direct Debit **PAIN.008.001.02** -specifications as required by the SEPA customer-to-bank Implementation Guidelines, -which ensures compatibility with the banks. +**XML files** with all SDD payment instructions can be uploaded to your online banking interface to +process all payments at once. -To generate your XML file for the pending SDD payments, go to the related -*bank journal* on your *Accounting dashboard*, then click on -*Direct Debit Payments to Collect*. +.. note:: + The files generated by Odoo follow the SEPA Direct Debit **PAIN.008.001.02** specifications, as + required by the SEPA customer-to-bank Implementation Guidelines, which ensures compatibility with + the banks. -.. image:: media/batch_sdd04.png +To generate your XML file for the pending SDD payments, go to the related *bank journal* on your +*Accounting dashboard*, then click on *Direct Debit Payments to Collect*. + +.. image:: media/batch-sdd-collect.png :align: center + :alt: Start the SDD payments collection in Odoo Accounting -Select all the payments in the list that you want to include in -your SDD XML file, then click on *Action* and select *Create Batch Payment*. +Select all the payments you want to include in your SDD XML file, then click on *Action* and select +*Create Batch Payment*. -.. image:: media/batch_sdd05.png +.. image:: media/batch-sdd-batch.png :align: center + :alt: Create a batch payment with all the SDD payments in Odoo Accounting -Odoo then takes you to your *Batch Payment*’s form. Click on *Validate* -and then download the SDD XML file. +Odoo then takes you to your *Batch Payment*’s form. Click on *Validate* and download the SDD XML +file. -.. image:: media/batch_sdd06.png +.. image:: media/batch-sdd-xml.png :align: center + :alt: Generate an XML file for your SDD payments in Odoo Accounting -Finally, upload this file to your bank to process the payments. +Finally, upload this file to your online banking interface to process the payments. .. tip:: You can retrieve all the generated SDD XML files by going to @@ -120,8 +149,5 @@ Finally, upload this file to your bank to process the payments. .. seealso:: * :doc:`../../bank/setup/bank_accounts` * `Odoo Academy: SEPA Direct Debit Mandates (SDD) `_ - * `List of all SEPA countries `_. - - - - + * `List of all SEPA countries + `_ \ No newline at end of file diff --git a/accounting/receivables/customer_payments/media/batch_sdd05.png b/accounting/receivables/customer_payments/media/batch-sdd-batch.png similarity index 100% rename from accounting/receivables/customer_payments/media/batch_sdd05.png rename to accounting/receivables/customer_payments/media/batch-sdd-batch.png diff --git a/accounting/receivables/customer_payments/media/batch_sdd04.png b/accounting/receivables/customer_payments/media/batch-sdd-collect.png similarity index 100% rename from accounting/receivables/customer_payments/media/batch_sdd04.png rename to accounting/receivables/customer_payments/media/batch-sdd-collect.png diff --git a/accounting/receivables/customer_payments/media/batch_sdd01.png b/accounting/receivables/customer_payments/media/batch-sdd-creditor-identifier.png similarity index 100% rename from accounting/receivables/customer_payments/media/batch_sdd01.png rename to accounting/receivables/customer_payments/media/batch-sdd-creditor-identifier.png diff --git a/accounting/receivables/customer_payments/media/batch_sdd02.png b/accounting/receivables/customer_payments/media/batch-sdd-mandate-form.png similarity index 100% rename from accounting/receivables/customer_payments/media/batch_sdd02.png rename to accounting/receivables/customer_payments/media/batch-sdd-mandate-form.png diff --git a/accounting/receivables/customer_payments/media/batch_sdd03.png b/accounting/receivables/customer_payments/media/batch-sdd-revoke-close.png similarity index 100% rename from accounting/receivables/customer_payments/media/batch_sdd03.png rename to accounting/receivables/customer_payments/media/batch-sdd-revoke-close.png diff --git a/accounting/receivables/customer_payments/media/batch_sdd06.png b/accounting/receivables/customer_payments/media/batch-sdd-xml.png similarity index 100% rename from accounting/receivables/customer_payments/media/batch_sdd06.png rename to accounting/receivables/customer_payments/media/batch-sdd-xml.png