11.0 - account_ebics - backport of 12.0 code to enable configuration of request types on FDL

account_ebics/README.rst

@@ -1,6 +1,6 @@
-.. image:: https://img.shields.io/badge/license-AGPL--3-blue.png
+.. image:: https://img.shields.io/badge/license-LGPL--3-blue.png
-   :target: https://www.gnu.org/licenses/agpl
+   :target: https://www.gnu.org/licenses/lpgl
-   :alt: License: AGPL-3
+   :alt: License: LGPL-3
 
 ======================
 EBICS banking protocol

account_ebics/__manifest__.py

@@ -1,10 +1,10 @@
 # Copyright 2009-2022 Noviat.
-# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+# License LGPL-3 or later (http://www.gnu.org/licenses/lpgl).
 
 {
     'name': 'EBICS banking protocol',
     'version': '11.0.1.8.0',
-    'license': 'AGPL-3',
+    'license': 'LGPL-3',
     'author': 'Noviat',
     'category': 'Accounting & Finance',
     'depends': ['account'],

account_ebics/data/ebics_file_format.xml

@@ -2,6 +2,8 @@
 <odoo>
   <data noupdate="1">
 
+    <!-- Download formats -->
+
     <record id="ebics_ff_C52" model="ebics.file.format">
       <field name="name">camt.052</field>
       <field name="type">down</field>
@@ -11,15 +13,30 @@
       <field name="suffix">c52.xml</field>
     </record>
 
-    <!--
+    <record id="ebics_ff_Z52" model="ebics.file.format">
-    File format tested with the following banks:
+      <field name="name">camt.052</field>
-    - GLS Gemeinschaftsbank (Germany)
+      <field name="type">down</field>
-    -->
+      <field name="order_type">Z52</field>
-    <record id="ebics_ff_camt_053_001_02_stm" model="ebics.file.format">
+      <field name="download_process_method">camt.052</field>
-      <field name="name">camt.053.001.02.stm</field>
+      <field name="description">bank to customer account report in format camt.052</field>
+      <field name="suffix">c52.xml</field>
+    </record>
+    
+    <record id="ebics_ff_C53" model="ebics.file.format">
+      <field name="name">camt.053</field>
       <field name="type">down</field>
       <field name="order_type">C53</field>
-      <field name="description">Bank Statement in Format camt.053</field>
+      <field name="download_process_method">camt.053</field>
+      <field name="description">Bank to customer statement report in format camt.053</field>
+      <field name="suffix">c53.xml</field>
+    </record>
+
+    <record id="ebics_ff_Z53" model="ebics.file.format">
+      <field name="name">camt.053</field>
+      <field name="type">down</field>
+      <field name="order_type">Z53</field>
+      <field name="download_process_method">camt.053</field>
+      <field name="description">Bank to customer statement report in format camt.053</field>
       <field name="suffix">c53.xml</field>
     </record>
     
@@ -29,91 +46,108 @@
       <field name="order_type">C54</field>
       <field name="download_process_method">camt.054</field>
       <field name="description">Bank to customer debit credit notification in format camt.054</field>
-      <field name="suffix">c54.xml</field>
+      <field name="suffix">c52.xml</field>
     </record>
 
-    <!--
+    <record id="ebics_ff_Z54" model="ebics.file.format">
-    File format tested with the following banks:
+      <field name="name">camt.054</field>
-    - GLS Gemeinschaftsbank (Germany)
-    -->
-    <record id="ebics_ff_pain_001_001_03_sct" model="ebics.file.format">
-      <field name="name">pain.001.001.03.sct</field>
-      <field name="type">up</field>
-      <field name="order_type">CCT</field>
-      <field name="description">Payment Order in Format pain.001.001.03</field>
-      <field name="suffix">xml</field>
-    </record>
-
-    <record id="ebics_ff_pain_008_001_02_sdd" model="ebics.file.format">
-      <field name="name">pain.008.001.02.sdd</field>
-      <field name="type">up</field>
-      <field name="order_type">CDD</field>
-      <field name="description">Sepa Core Direct Debit Order in Format pain.008.001.02</field>
-      <field name="suffix">xml</field>
-    </record>
-
-    <record id="ebics_ff_pain_008_001_02_sbb" model="ebics.file.format">
-      <field name="name">pain.008.001.02.sbb</field>
-      <field name="type">up</field>
-      <field name="order_type">CDB</field>
-      <field name="description">Sepa Direct Debit (B2B) Order in Format pain.008.001.02</field>
-      <field name="suffix">xml</field>
-    </record>
-    
-    <!--
-    File format tested with the following banks:
-    - Credit Suisse (Switzerland)
-    -->
-    <record id="ebics_ff_pain_001" model="ebics.file.format">
-      <field name="name">pain.001</field>
-      <field name="type">up</field>
-      <field name="order_type">XE2</field>
-      <field name="description">Payment Order in Format pain.001.001.03</field>
-      <field name="suffix">xml</field>
-    </record>
-
-    <!--
-    File format tested with the following banks:
-    - Credit Suisse (Switzerland)
-    -->
-    <record id="ebics_ff_pain_008" model="ebics.file.format">
-      <field name="name">pain.008</field>
-      <field name="type">up</field>
-      <field name="order_type">XE3</field>
-      <field name="description">Direct Debit Order in Format pain.008.001.02</field>
-      <field name="suffix">xml</field>
-    </record>
-
-    <record id="ebics_ff_camt_054_001_02_rdd" model="ebics.file.format">
-      <field name="name">camt.054.001.02.rdd</field>
       <field name="type">down</field>
-      <field name="order_type">FDL</field>
+      <field name="order_type">Z54</field>
-      <field name="description">Bank Statement in Format camt.054</field>
+      <field name="download_process_method">camt.054</field>
-      <field name="suffix">c54.xml</field>
+      <field name="description">Bank to customer debit credit notification in format camt.054</field>
+      <field name="suffix">c52.xml</field>
     </record>
 
-    <!--
+    <record id="ebics_ff_FDL_camt_xxx_cfonb120_stm" model="ebics.file.format">
-    File format tested with the following banks:
-    - CIC (France)
-    -->
-    <record id="ebics_ff_camt_xxx_cfonb120_stm" model="ebics.file.format">
       <field name="name">camt.xxx.cfonb120.stm</field>
       <field name="type">down</field>
       <field name="order_type">FDL</field>
-      <field name="description">Bank Statement in Format cfonb120</field>
+      <field name="download_process_method">cfonb120</field>
+      <field name="description">Bank to customer statement report in format cfonb120</field>
       <field name="suffix">cfonb120.dat</field>
     </record>
 
-    <!--
+    <record id="ebics_ff_CDZ" model="ebics.file.format">
-    File format tested with the following banks:
+      <field name="name">pain.002</field>
-    - CIC (France)
+      <field name="type">down</field>
-    -->
+      <field name="order_type">CDZ</field>
-    <record id="ebics_ff_pain_001_001_02_sct" model="ebics.file.format">
+      <field name="description">Payment status report for direct debit in format pain.002</field>
+      <field name="suffix">psr.xml</field>
+    </record>
+    
+    <record id="ebics_ff_Z01" model="ebics.file.format">
+      <field name="name">pain.002</field>
+      <field name="type">down</field>
+      <field name="order_type">Z01</field>
+      <field name="download_process_method">pain.002</field>
+      <field name="description">Payment status report for direct debit in format pain.002</field>
+      <field name="suffix">psr.xml</field>
+    </record>
+    
+    <!-- Upload formats -->
+
+    <record id="ebics_ff_CCT" model="ebics.file.format">
+      <field name="name">pain.001.001.03</field>
+      <field name="type">up</field>
+      <field name="order_type">CCT</field>
+      <field name="description">Payment Order in format pain.001.001.03</field>
+      <field name="suffix">cct.xml</field>
+    </record>
+
+    <record id="ebics_ff_XE2" model="ebics.file.format">
+      <field name="name">pain.001.001.03</field>
+      <field name="type">up</field>
+      <field name="order_type">XE2</field>
+      <field name="description">Payment Order in format pain.001.001.03</field>
+      <field name="suffix">cct.xml</field>
+    </record>
+
+    <record id="ebics_ff_CDD" model="ebics.file.format">
+      <field name="name">pain.008.001.02.sdd</field>
+      <field name="type">up</field>
+      <field name="order_type">CDD</field>
+      <field name="description">Sepa Core Direct Debit Order in format pain.008.001.02</field>
+      <field name="suffix">sdd.xml</field>
+    </record>
+
+    <record id="ebics_ff_CDD" model="ebics.file.format">
+      <field name="name">pain.008.001.02.sdd</field>
+      <field name="type">up</field>
+      <field name="order_type">CDD</field>
+      <field name="description">Sepa Core Direct Debit Order in format pain.008.001.02</field>
+      <field name="suffix">sdd.xml</field>
+    </record>
+
+    <record id="ebics_ff_XE3" model="ebics.file.format">
+      <field name="name">pain.008.001.02.sdd</field>
+      <field name="type">up</field>
+      <field name="order_type">XE3</field>
+      <field name="description">Sepa Core Direct Debit Order in format pain.008.001.02</field>
+      <field name="suffix">sdd.xml</field>
+    </record>
+    
+    <record id="ebics_ff_CDB" model="ebics.file.format">
+      <field name="name">pain.008.001.02.sbb</field>
+      <field name="type">up</field>
+      <field name="order_type">CDB</field>
+      <field name="description">Sepa Direct Debit (B2B) Order in format pain.008.001.02</field>
+      <field name="suffix">sbb.xml</field>
+    </record>
+
+    <record id="ebics_ff_XE4" model="ebics.file.format">
+      <field name="name">pain.008.001.02.sbb</field>
+      <field name="type">up</field>
+      <field name="order_type">XE4</field>
+      <field name="description">Sepa Direct Debit (B2B) Order in format pain.008.001.02</field>
+      <field name="suffix">sbb.xml</field>
+    </record>
+
+    <record id="ebics_ff_FUL_pain_001_001_02_sct" model="ebics.file.format">
       <field name="name">pain.001.001.02.sct</field>
       <field name="type">up</field>
       <field name="order_type">FUL</field>
-      <field name="description">Payment Order in Format pain.001.001.02</field>
+      <field name="description">Payment Order in format pain.001.001.02</field>
-      <field name="suffix">xml</field>
+      <field name="suffix">cct.xml</field>
     </record>
 
   </data>

account_ebics/models/account_bank_statement.py

@@ -1,5 +1,5 @@
-# Copyright 2009-2018 Noviat.
+# Copyright 2009-2022 Noviat.
-# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+# License LGPL-3 or later (http://www.gnu.org/licenses/lpgl).
 
 from odoo import fields, models
 

account_ebics/models/ebics_config.py

@@ -1,5 +1,5 @@
-# Copyright 2009-2019 Noviat.
+# Copyright 2009-2022 Noviat.
-# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+# License LGPL-3 or later (http://www.gnu.org/licenses/lpgl).
 
 """
 import logging

account_ebics/models/ebics_file.py

@@ -1,5 +1,5 @@
 # Copyright 2009-2022 Noviat.
-# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+# License LGPL-3 or later (http://www.gnu.org/licenses/lpgl).
 
 import logging
 
@@ -74,12 +74,11 @@ class EbicsFile(models.Model):
                 raise UserError(_(
                     "You can only remove EBICS files in state 'Draft'."))
             # execute format specific actions
-            ff = ebics_file.format_id.name
+            ff = ebics_file.format_id.download_process_method
             if ff in ff_methods:
                 if ff_methods[ff].get('unlink'):
                     ff_methods[ff]['unlink'](ebics_file)
-                elif ff[:7] == 'camt.05' and ff_methods[ff[:8]].get('unlink'):
+            # remove bank statements
-                    ff_methods[ff[:8]]['unlink'](self)
             ebics_file.bank_statement_ids.unlink()
         return super(EbicsFile, self).unlink()
 
@@ -96,16 +95,12 @@ class EbicsFile(models.Model):
         self.ensure_one()
         self.note_process = ''
         ff_methods = self._file_format_methods()
-        ff = self.format_id.name
+        ff = self.format_id.download_process_method
         if ff in ff_methods:
             if ff_methods[ff].get('process'):
                 res = ff_methods[ff]['process'](self)
                 self.state = 'done'
                 return res
-            elif ff[:7] == 'camt.05' and ff_methods[ff[:8]].get('process'):
-                res = ff_methods[ff[:8]]['process'](self)
-                self.state = 'done'
-                return res
         else:
             return self._process_undefined_format()
 
@@ -130,18 +125,21 @@ class EbicsFile(models.Model):
         for extra file formats.
         """
         res = {
-            'camt.xxx.cfonb120.stm':
+            'cfonb120':
                 {'process': self._process_cfonb120,
                  'unlink': self._unlink_cfonb120},
             'camt.052':
                 {'process': self._process_camt052,
                  'unlink': self._unlink_camt052},
-            'camt.053.001.02.stm':
+            'camt.053':
                 {'process': self._process_camt053,
                  'unlink': self._unlink_camt053},
             'camt.054':
                 {'process': self._process_camt054,
                  'unlink': self._unlink_camt054},
+            'pain.002':
+                {'process': self._process_pain002,
+                 'unlink': self._unlink_pain002},
         }
         return res
 
@@ -294,6 +292,23 @@ class EbicsFile(models.Model):
         """
         pass
 
+    @staticmethod
+    def _process_pain002(self):
+        """
+        Placeholder for processing pain.002 files.
+        TODO:
+        add import logic based upon OCA 'account_payment_return_import'
+        """
+        pass
+
+    @staticmethod
+    def _unlink_pain002(self):
+        """
+        Placeholder for pain.002 specific actions before removing the
+        EBICS data file.
+        """
+        raise NotImplementedError
+
     def _process_undefined_format(self):
         raise UserError(_(
             "The current version of the 'account_ebics' module "

account_ebics/models/ebics_file_format.py

@@ -1,5 +1,5 @@
 # Copyright 2009-2022 Noviat.
-# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+# License LGPL-3 or later (http://www.gnu.org/licenses/lpgl).
 
 from odoo import api, fields, models
 
@@ -7,21 +7,35 @@ from odoo import api, fields, models
 class EbicsFileFormat(models.Model):
     _name = 'ebics.file.format'
     _description = 'EBICS File Formats'
-    _order = 'type,name'
+    _order = 'type,name,order_type'
 
-    name = fields.Selection(
+    name = fields.Char(
-        selection=lambda self: self._selection_name(),
+        string='Request Type',
-        string='Request Type', required=True)
+        required=True,
+        help="E.g. camt.xxx.cfonb120.stm, pain.001.001.03.sct.\n"
+             "Specify camt.052, camt.053, camt.054 for camt "
+             "Order Types such as C53, Z53, C54, Z54.\n"
+             "This name has to match the 'Request Type' in your "
+             "EBICS contract for Order Type 'FDL' or 'FUL'.\n")
     type = fields.Selection(
         selection=[('down', 'Download'),
                    ('up', 'Upload')],
         required=True)
-    order_type = fields.Selection(
+    order_type = fields.Char(
-        selection=lambda self: self._selection_order_type(),
         string='Order Type',
-        help="For most banks is France you should use the "
+        required=True,
+        help="E.g. C53 (check your EBICS contract).\n"
+             "For most banks in France you should use the "
              "format neutral Order Types 'FUL' for upload "
              "and 'FDL' for download.")
+    download_process_method = fields.Selection(
+        selection='_selection_download_process_method',
+        help="Enable processing within Odoo of the downloaded file "
+             "via the 'Process' button."
+             "E.g. specify camt.053 to import a camt.053 file and create "
+             "a bank statement.")
+    # TODO:
+    # move signature_class parameter so that it can be set per EBICS config
     signature_class = fields.Selection(
         selection=[('E', 'Single signature'),
                    ('T', 'Transport signature')],
@@ -30,52 +44,19 @@ class EbicsFileFormat(models.Model):
              "ERP system when using class 'E' to prevent unauthorised "
              "users to make supplier payments."
              "\nLeave this field empty to use the default "
-             "defined for your bank connection.")
+             "defined for your EBICS Configuration.")
     description = fields.Char()
     suffix = fields.Char(
         required=True,
         help="Specify the filename suffix for this File Format."
-             "\nE.g. camt.053.xml")
+             "\nE.g. c53.xml")
 
     @api.model
-    def _selection_order_type(self):
+    def _selection_download_process_method(self):
-        up = self._supported_upload_order_types()
+        methods = self.env['ebics.file']._file_format_methods().keys()
-        down = self._supported_download_order_types()
+        return [(x, x) for x in methods]
-        selection = [(x, x) for x in up + down]
-        return selection
 
-    def _supported_upload_order_types(self):
+    @api.onchange('type')
-        return ['FUL', 'CCT', 'CDD', 'CDB', 'XE2', 'XE3']
+    def _onchange_type(self):
-
+        if self.type == 'up':
-    def _supported_download_order_types(self):
+            self.download_process_method = False
-        return ['FDL', 'C52', 'C53', 'C54']
-
-    @api.model
-    def _selection_name(self):
-        """
-        List of supported EBICS Request Types.
-        Extend this method via a custom module when testing
-        a new Request Type and make a PR for the
-        account_ebics module when this new Request Type
-        is working correctly.
-        This PR should include at least updates to
-        - 'data/ebics_file_format.xml'
-        - 'models/ebics_file_format.py'
-        An overview of the EBICS Request Types can be found in
-        the doc folder of this module (EBICS_Annex2).
-        """
-        request_types = [
-            'camt.053.001.02.stm',
-            'pain.001.001.03.sct',
-            'pain.008.001.02.sdd',
-            'pain.008.001.02.sbb',
-            'camt.xxx.cfonb120.stm',
-            'pain.001.001.02.sct',
-            'camt.052',
-            'camt.053',
-            'camt.054',
-            'pain.001',
-            'pain.008',
-        ]
-        selection = [(x, x) for x in request_types]
-        return selection

account_ebics/models/fintech_ebics_register.py

@@ -1,5 +1,5 @@
-# Copyright 2009-2019 Noviat.
+# Copyright 2009-2022 Noviat.
-# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+# License LGPL-3 or later (http://www.gnu.org/licenses/lpgl).
 
 import logging
 from sys import exc_info

account_ebics/wizard/account_bank_statement_import.py

@@ -1,5 +1,5 @@
-# Copyright 2009-2019 Noviat.
+# Copyright 2009-2022 Noviat.
-# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+# License LGPL-3 or later (http://www.gnu.org/licenses/lpgl).
 
 import logging
 

account_ebics/wizard/ebics_change_passphrase.py

@@ -1,5 +1,5 @@
-# Copyright 2009-2019 Noviat.
+# Copyright 2009-2022 Noviat.
-# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+# License LGPL-3 or later (http://www.gnu.org/licenses/lpgl).
 
 import logging
 

account_ebics/wizard/ebics_xfer.py

@@ -1,5 +1,5 @@
 # Copyright 2009-2022 Noviat.
-# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+# License LGPL-3 or later (http://www.gnu.org/licenses/lpgl).
 
 """
 import logging
@@ -64,10 +64,10 @@ class EbicsXfer(models.TransientModel):
         string='EBICS File Format',
         help="Select EBICS File Format to upload/download."
              "\nLeave blank to download all available files.")
-    order_type = fields.Selection(
+    order_type = fields.Char(
-        selection=lambda self: self._selection_order_type(),
+        related='format_id.order_type',
         string='Order Type',
-        help="For most banks is France you should use the "
+        help="For most banks in France you should use the "
              "format neutral Order Types 'FUL' for upload "
              "and 'FDL' for download.")
     test_mode = fields.Boolean(
@@ -89,10 +89,6 @@ class EbicsXfer(models.TransientModel):
         else:
             return cfg_mod
 
-    @api.model
-    def _selection_order_type(self):
-        return self.env['ebics.file.format']._selection_order_type()
-
     @api.onchange('ebics_config_id')
     def _onchange_ebics_config_id(self):
         domain = {}
@@ -156,25 +152,28 @@ class EbicsXfer(models.TransientModel):
         self.note = ''
         client = self._setup_client()
         if client:
-            download_formats = self.format_id \
+            download_formats = (
+                self.format_id
                 or self.ebics_config_id.ebics_file_format_ids.filtered(
-                    lambda r: r.type == 'down')
+                    lambda r: r.type == 'down'
+                )
+            )
             ebics_files = self.env['ebics.file']
             for df in download_formats:
-                success = False
-                order_type = df.order_type or 'FDL'
-                params = {}
-                if order_type == 'FDL':
-                    params['filetype'] = df.name
-                if order_type in ['FDL', 'C52', 'C53', 'C54']:
-                    params.update({
-                        'start': self.date_from or None,
-                        'end': self.date_to or None,
-                    })
-                kwargs = {k: v for k, v in params.items() if v}
                 try:
-                    method = getattr(client, order_type)
+                    success = False
-                    data = method(**kwargs)
+                    if df.order_type == 'FDL':
+                        data = client.FDL(
+                            df.name, self.date_from or None, self.date_to or None
+                        )
+                    else:
+                        params = None
+                        if self.date_from and self.date_to:
+                            params = {'DateRange': {
+                                'Start': self.date_from or None,
+                                'End': self.date_to or None,
+                            }}
+                        data = client.download(df.order_type, params=params)
                     ebics_files += self._handle_download_data(data, df)
                     success = True
                 except EbicsFunctionalError:
@@ -259,9 +258,7 @@ class EbicsXfer(models.TransientModel):
             ef_format = self.format_id
             OrderID = False
             try:
-                order_type = ef_format.order_type or 'FUL'
+                order_type = self.order_type
-                method = hasattr(client, order_type) \
-                    and getattr(client, order_type)
                 if order_type == 'FUL':
                     kwargs = {}
                     # bank = self.ebics_config_id.bank_id.bank v8.0
@@ -270,15 +267,9 @@ class EbicsXfer(models.TransientModel):
                         kwargs['country'] = bank.country.code
                     if self.test_mode:
                         kwargs['TEST'] = 'TRUE'
-                    OrderID = method(ef_format.name, upload_data, **kwargs)
+                    OrderID = client.FUL(ef_format.name, upload_data, **kwargs)
-                elif order_type in ['CCT', 'CDD', 'CDB']:
-                    OrderID = method(upload_data)
-                elif order_type in ['XE2', 'XE3']:
-                    OrderID = client.upload(order_type, upload_data)
                 else:
-                    # TODO: investigate if it makes sense to support
+                    OrderID = client.upload(order_type, upload_data)
-                    # a generic upload for a non-predefined order_type
-                    pass
                 if OrderID:
                     self.note += '\n'
                     self.note += _(