mirror of
				https://github.com/brain-tec/account_ebics.git
				synced 2025-11-04 15:10:34 +00:00 
			
		
		
		
	
		
			
				
	
	
		
			220 lines
		
	
	
		
			4.9 KiB
		
	
	
	
		
			ReStructuredText
		
	
	
	
	
	
			
		
		
	
	
			220 lines
		
	
	
		
			4.9 KiB
		
	
	
	
		
			ReStructuredText
		
	
	
	
	
	
.. image:: https://img.shields.io/badge/license-LGPL--3-blue.png
 | 
						|
   :target: https://www.gnu.org/licenses/lgpl
 | 
						|
   :alt: License: LGPL-3
 | 
						|
 | 
						|
======================
 | 
						|
EBICS banking protocol
 | 
						|
======================
 | 
						|
 | 
						|
Implementation of the  EBICS banking protocol.
 | 
						|
 | 
						|
This module facilitates the exchange of files with banks via the EBICS protocol.
 | 
						|
 | 
						|
|
 | 
						|
 | 
						|
Installation
 | 
						|
============
 | 
						|
 | 
						|
The module depends upon
 | 
						|
 | 
						|
- https://pypi.python.org/pypi/fintech
 | 
						|
- https://pypi.python.org/pypi/cryptography
 | 
						|
 | 
						|
Remark:
 | 
						|
 | 
						|
The EBICS 'Test Mode' for uploading orders requires fintech 4.3.4 or higher for EBICS 2.x
 | 
						|
and fintech 7.2.7 or higher for EBICS 3.0.
 | 
						|
 | 
						|
SWIFT 3SKey support requires fintech 6.4 or higher.
 | 
						|
 | 
						|
|
 | 
						|
 | 
						|
We also recommend to consider the installation of the following modules:
 | 
						|
 | 
						|
|
 | 
						|
 | 
						|
- account_ebics_oe
 | 
						|
 | 
						|
  Required if you are running Odoo Enterprise
 | 
						|
 | 
						|
  Cf. https://github.com/Noviat/account_ebics
 | 
						|
 | 
						|
|
 | 
						|
 | 
						|
- account_ebics_batch
 | 
						|
 | 
						|
  This module adds a cron job for the automated import of EBICS files.
 | 
						|
 | 
						|
  Cf. https://github.com/Noviat/account_ebics
 | 
						|
 | 
						|
|
 | 
						|
 | 
						|
- account_ebics_batch_payment
 | 
						|
 | 
						|
  Recommended if you are using the Odoo Enterprise account_batch_payment module
 | 
						|
 | 
						|
  Cf. https://github.com/Noviat/account_ebics
 | 
						|
 | 
						|
|
 | 
						|
 | 
						|
- account_usability
 | 
						|
 | 
						|
  Recommended if you have multiple financial journals.
 | 
						|
  This module adds a number of accounting menu entries such as bank statement list view
 | 
						|
  which allows to see all statements downloaded via the ir.cron automated EBICS download.
 | 
						|
 | 
						|
  Cf. https://github.com/OCA/account-financial-tools
 | 
						|
 | 
						|
|
 | 
						|
 | 
						|
- account_ebics_payment_order
 | 
						|
 | 
						|
  Required if you are using the OCA account_payment_order module.
 | 
						|
 | 
						|
  Cf. https://github.com/OCA/bank-payment
 | 
						|
 | 
						|
|
 | 
						|
 | 
						|
- account_ebics_oca_statement_import
 | 
						|
 | 
						|
  Required if you are using the OCA Bank Statement import modules.
 | 
						|
 | 
						|
  https://github.com/OCA/bank-statement-import
 | 
						|
 | 
						|
|
 | 
						|
 | 
						|
- account_statement_import_fr_cfonb
 | 
						|
 | 
						|
  Required to handle french CFONB files.
 | 
						|
 | 
						|
  Cf. https://github.com/OCA/l10n_france
 | 
						|
 | 
						|
|
 | 
						|
 | 
						|
- account_statement_import_camt
 | 
						|
 | 
						|
  Required to handle camt.052 and camt.054 files.
 | 
						|
 | 
						|
  Cf. https://github.com/OCA/bank-statement-import
 | 
						|
 | 
						|
|
 | 
						|
 | 
						|
 | 
						|
Fintech license
 | 
						|
---------------
 | 
						|
 | 
						|
If you have a valid fintech.ebics license, you should add the following
 | 
						|
licensing parameters to the [options] section of the odoo server configuration file:
 | 
						|
 | 
						|
 | 
						|
- fintech_register_name
 | 
						|
 | 
						|
The name of the licensee.
 | 
						|
 | 
						|
- fintech_register_keycode
 | 
						|
 | 
						|
The keycode of the licensed version.
 | 
						|
 | 
						|
|
 | 
						|
| Example:
 | 
						|
|
 | 
						|
 | 
						|
::
 | 
						|
 | 
						|
 ; fintech
 | 
						|
 fintech_register_name = MyCompany
 | 
						|
 fintech_register_keycode = AB1CD-E2FG-3H-IJ4K-5L
 | 
						|
 | 
						|
|
 | 
						|
 | 
						|
Cf. https://www.joonis.de/en/fintech/prices/
 | 
						|
 | 
						|
|
 | 
						|
 | 
						|
Configuration
 | 
						|
=============
 | 
						|
 | 
						|
Go to **Settings > Users**
 | 
						|
 | 
						|
Add the users that are authorised to maintain the EBICS configuration to the 'EBICS Manager' Group.
 | 
						|
 | 
						|
|
 | 
						|
 | 
						|
Go to **Accounting > Configuration > Miscellaneous > EBICS > EBICS File Formats**
 | 
						|
 | 
						|
Check if the EBICS File formats that you want to process in Odoo are defined.
 | 
						|
 | 
						|
Most commonly used formats for which support is available in Odoo should be there already.
 | 
						|
 | 
						|
Please open an issue on https://github.com/Noviat/account_ebics to report missing EBICS File Formats.
 | 
						|
 | 
						|
For File Formats of type 'Downloads' you can also specify a 'Download Process Method'.
 | 
						|
 | 
						|
This is the method that will be executed when hitting the 'Process' button on the downloaded file.
 | 
						|
 | 
						|
The following methods are currently available:
 | 
						|
 | 
						|
- cfonb120
 | 
						|
- camt.053
 | 
						|
- camt.052
 | 
						|
- camt.054
 | 
						|
 | 
						|
All these methods require complimentary modules to be installed (cf. Installation section supra).
 | 
						|
 | 
						|
You'll get an error message when the required module is not installed on your Odoo instance.
 | 
						|
 | 
						|
|
 | 
						|
 | 
						|
Go to **Accounting > Configuration > Miscellaneous > EBICS > EBICS Configuration**
 | 
						|
 | 
						|
Configure your EBICS configuration according to the contract with your bank.
 | 
						|
 | 
						|
|
 | 
						|
 | 
						|
Usage
 | 
						|
=====
 | 
						|
 | 
						|
Go to **Accounting > Bank and Cash > EBICS Processing**
 | 
						|
 | 
						|
|
 | 
						|
 | 
						|
Diagnostics
 | 
						|
===========
 | 
						|
 | 
						|
Add the following to your Odoo config file in order to diagnose
 | 
						|
issues with the EBICS connection with your bank:
 | 
						|
 | 
						|
log_handler = fintech.ebics:DEBUG
 | 
						|
 | 
						|
|
 | 
						|
 | 
						|
EBICS Return Codes
 | 
						|
------------------
 | 
						|
 | 
						|
During the processing of your EBICS upload/download, your bank may return an Error Code, e.g.
 | 
						|
 | 
						|
EBICS Functional Error:
 | 
						|
EBICS_NO_DOWNLOAD_DATA_AVAILABLE (code: 90005)
 | 
						|
 | 
						|
A detailed explanation of the codes can be found on http://www.ebics.org.
 | 
						|
You can also find this information in the doc folder of this module (file EBICS_Annex1_ReturnCodes).
 | 
						|
 | 
						|
|
 | 
						|
 | 
						|
Electronic Distributed Signature (EDS)
 | 
						|
--------------------------------------
 | 
						|
 | 
						|
This is supported via external signing apps, e.g. BankingVEU:
 | 
						|
 | 
						|
- https://play.google.com/store/apps/details?id=subsembly.bankingveu
 | 
						|
- https://apps.apple.com/de/app/bankingveu/id1578694190
 | 
						|
 | 
						|
 | 
						|
Known Issues / Roadmap
 | 
						|
======================
 | 
						|
 | 
						|
- The end user is currently not able to change his passphrases (only the users with 'EBICS Manager' rights can do so).
 | 
						|
- Add support to import externally generated keys & certificates (currently only 3SKey signature certificate).
 | 
						|
- Add support for SWIFT 3SKey signing javascript lib (SConnect, cf https://www2.swift.com/3skey/help/sconnect.html).
 | 
						|
 |