diff --git a/account_statement_import_online_ofx/README.rst b/account_statement_import_online_ofx/README.rst new file mode 100644 index 00000000..efb2aa8d --- /dev/null +++ b/account_statement_import_online_ofx/README.rst @@ -0,0 +1,110 @@ +================================== +Online Bank Statements: OFX +================================== + +.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png + :target: https://odoo-community.org/page/development-status + :alt: Beta +.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png + :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/14.0/account_statement_import_online_paypal + :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-14-0/bank-statement-import-14-0-account_statement_import_online_paypal + :alt: Translate me on Weblate +.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png + :target: https://runbot.odoo-community.org/runbot/174/14.0 + :alt: Try me on Runbot + +|badge1| |badge2| |badge3| |badge4| |badge5| + +This module provides online bank statements from OFX instutitons + +**Table of contents** + +.. contents:: + :local: + +Configuration +============= + +To configure online bank statements provider: + +#. Go to *Invoicing > Configuration > Journals* +#. Open bank journal to configure and edit it +#. Set *Bank Feeds* to *Online* +#. Select *OFX* as online bank statements provider in + *Online Bank Statements (OCA)* section +#. Save the bank journal +#. Click on provider and configure provider-specific settings. + +Usage +===== + +To pull historical bank statements: + +#. Go to *Invoicing > Configuration > Journals* +#. Select specific bank accounts +#. Launch *Actions > Online Bank Statements Pull Wizard* +#. Configure date interval and click *Pull* + +Known issues / Roadmap +====================== + + +Bug Tracker +=========== + +Bugs are tracked on `GitHub Issues `_. +In case of trouble, please check there if your issue has already been reported. +If you spotted it first, help us smashing it by providing a detailed and welcomed +`feedback `_. + +Do not contact contributors directly about support or help with technical issues. + +Credits +======= + +Authors +~~~~~~~ + +* ForgeFlow + +Contributors +~~~~~~~~~~~~ + +* `ForgeFlow `__ + + * Jasmin Solanki + +Maintainers +~~~~~~~~~~~ + +This module is maintained by the OCA. + +.. image:: https://odoo-community.org/logo.png + :alt: Odoo Community Association + :target: https://odoo-community.org + +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. + +.. |maintainer-alexey-pelykh| image:: https://github.com/alexey-pelykh.png?size=40px + :target: https://github.com/alexey-pelykh + :alt: alexey-pelykh + +Current `maintainer `__: + +|maintainer-alexey-pelykh| + +This module is part of the `OCA/bank-statement-import `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/account_statement_import_online_ofx/__init__.py b/account_statement_import_online_ofx/__init__.py new file mode 100644 index 00000000..adc6207f --- /dev/null +++ b/account_statement_import_online_ofx/__init__.py @@ -0,0 +1,4 @@ +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). + +from . import models +from . import wizards diff --git a/account_statement_import_online_ofx/__manifest__.py b/account_statement_import_online_ofx/__manifest__.py new file mode 100644 index 00000000..b81154df --- /dev/null +++ b/account_statement_import_online_ofx/__manifest__.py @@ -0,0 +1,20 @@ +# Copyright 2023 ForgeFlow S.L. +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html). + +{ + "name": "Online Bank Statements: OFX", + "version": "14.0.1.0.0", + "author": "ForgeFlow, Odoo Community Association (OCA)", + "website": "https://github.com/OCA/bank-statement-import", + "license": "AGPL-3", + "category": "Accounting", + "summary": "Online bank statements for OFX", + "depends": ["account_statement_import_online"], + "external_dependencies": {"python": ["ofxtools", "ofxparse"]}, + "data": [ + "security/ir.model.access.csv", + "views/online_bank_statement_provider.xml", + "wizards/online_bank_statement_pull_wizard.xml", + ], + "installable": True, +} diff --git a/account_statement_import_online_ofx/models/__init__.py b/account_statement_import_online_ofx/models/__init__.py new file mode 100644 index 00000000..88e0ba17 --- /dev/null +++ b/account_statement_import_online_ofx/models/__init__.py @@ -0,0 +1,4 @@ +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). + +from . import ofx_institution +from . import online_bank_statement_provider_ofx diff --git a/account_statement_import_online_ofx/models/ofx_institution.py b/account_statement_import_online_ofx/models/ofx_institution.py new file mode 100644 index 00000000..f1feb0dc --- /dev/null +++ b/account_statement_import_online_ofx/models/ofx_institution.py @@ -0,0 +1,14 @@ +# Copyright 2023 ForgeFlow S.L. +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html). + + +from odoo import fields, models + + +class OFXInstitution(models.Model): + _name = "ofx.institution" + _description = "OFX Institution" + + name = fields.Char() + nickname = fields.Char() + ofxhome_id = fields.Integer() diff --git a/account_statement_import_online_ofx/models/online_bank_statement_provider_ofx.py b/account_statement_import_online_ofx/models/online_bank_statement_provider_ofx.py new file mode 100644 index 00000000..5805aeb4 --- /dev/null +++ b/account_statement_import_online_ofx/models/online_bank_statement_provider_ofx.py @@ -0,0 +1,140 @@ +# Copyright 2023 ForgeFlow S.L. +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html). + +import io +import time +from datetime import datetime + +from ofxparse import OfxParser +from ofxtools import ofxhome, utils +from ofxtools.Client import OFXClient, StmtRq + +from odoo import _, api, fields, models +from odoo.exceptions import UserError + + +class OnlineBankStatementProviderOFX(models.Model): + _inherit = "online.bank.statement.provider" + + ofx_institution_line_ids = fields.One2many("ofx.institution.line", "provider_id") + + @api.model + def _get_available_services(self): + return super()._get_available_services() + [ + ("OFX", "OFX"), + ] + + def get_statements(self, client, password, s1, try_no=1): + statements = client.request_statements(password, s1, skip_profile=True) + file_data = statements.read() + if b"Request unsuccessful. Incapsula incident ID" in file_data and try_no <= 3: + time.sleep(3) + return self.get_statements(client, password, s1, try_no + 1) + ofx = OfxParser.parse(io.BytesIO(file_data)) + if ofx.status.get("code") != 0: + raise UserError(file_data) + return ofx + + def _obtain_statement_data(self, date_since, date_until): + self.ensure_one() + is_scheduled = self.env.context.get("scheduled") + # set date_until as today's date if its greter than today's date + # to avoid failure of request. + today = datetime.now() + today = today.replace(hour=0, minute=0, second=0, microsecond=0) + if date_until > today: + date_until = today + if self.service != "OFX": + return super()._obtain_statement_data( + date_since, + date_until, + ) # pragma: no cover + + lines = [] + if is_scheduled: + ofx_institution_lines = self.ofx_institution_line_ids + else: + ofx_institution_lines = self.env["ofx.institution.line"].browse( + self._context.get("ofx_institution_ids") + ) + for ofx_institution_line in ofx_institution_lines: + try: + username = ofx_institution_line.username + password = ofx_institution_line.password + bankid = ofx_institution_line.bankid + ofxhome_id = ofx_institution_line.institution_id.ofxhome_id + acctid = ofx_institution_line.account_id + + institute = ofxhome.lookup(ofxhome_id) + if institute is None or institute.url is None: + raise UserError(_("OFX Data is not available")) + ofxhome_id = institute.id + client = OFXClient( + institute.url, + userid=username, + org=institute.org, + fid=institute.fid, + bankid=bankid, + ) + dtstart = date_since.replace(tzinfo=utils.UTC) + dtend = date_until.replace(tzinfo=utils.UTC) + s1 = StmtRq( + acctid=acctid, + dtstart=dtstart, + dtend=dtend, + accttype="CHECKING", + ) + ofx = self.get_statements(client, password, s1) + for account in ofx.accounts: + if not account.statement.transactions: + continue + for transaction in account.statement.transactions: + vals = self._prepare_ofx_transaction_line(transaction) + if vals: + lines.append(vals) + except Exception as e: + raise UserError( + _("The following problem occurred during import.\n\n %s") % str(e) + ) + return lines, {} + + @api.model + def _prepare_ofx_transaction_line(self, transaction): + payment_ref = transaction.payee + if transaction.checknum: + payment_ref += " " + transaction.checknum + if transaction.memo: + payment_ref += " : " + transaction.memo + vals = { + "date": transaction.date, + "payment_ref": payment_ref, + "amount": float(transaction.amount), + "unique_import_id": transaction.id, + } + return vals + + def import_ofx_institutions(self): + OfxInstitution = self.env["ofx.institution"] + for ofxhome_id, name in ofxhome.list_institutions().items(): + institute = OfxInstitution.search([("ofxhome_id", "=", ofxhome_id)]) + vals = { + "name": name, + "ofxhome_id": ofxhome_id, + } + if institute: + institute.write(vals) + else: + OfxInstitution.create(vals) + + +class OFXInstitutionLine(models.Model): + _name = "ofx.institution.line" + _description = "OFX Institution Line" + _rec_name = "institution_id" + + institution_id = fields.Many2one("ofx.institution", "Institution") + username = fields.Char() + password = fields.Char() + bankid = fields.Char() + provider_id = fields.Many2one("online.bank.statement.provider") + account_id = fields.Char() diff --git a/account_statement_import_online_ofx/security/ir.model.access.csv b/account_statement_import_online_ofx/security/ir.model.access.csv new file mode 100644 index 00000000..aa84efa4 --- /dev/null +++ b/account_statement_import_online_ofx/security/ir.model.access.csv @@ -0,0 +1,5 @@ +id,name,model_id:id,group_id:id,perm_read,perm_write,perm_create,perm_unlink +access_ofx_institution_manager,ofx_institution,model_ofx_institution,account.group_account_user,1,1,1,1 +access_ofx_institution_user,ofx_institution,model_ofx_institution,base.group_user,1,0,0,0 +access_ofx_institution_line_user,access_ofx_institution_line,model_ofx_institution_line,base.group_user,1,0,0,0 +access_ofx_institution_line_manager,access_ofx_institution_line,model_ofx_institution_line,account.group_account_user,1,1,1,1 diff --git a/account_statement_import_online_ofx/static/description/icon.png b/account_statement_import_online_ofx/static/description/icon.png new file mode 100644 index 00000000..3a0328b5 Binary files /dev/null and b/account_statement_import_online_ofx/static/description/icon.png differ diff --git a/account_statement_import_online_ofx/views/online_bank_statement_provider.xml b/account_statement_import_online_ofx/views/online_bank_statement_provider.xml new file mode 100644 index 00000000..d3c9ed23 --- /dev/null +++ b/account_statement_import_online_ofx/views/online_bank_statement_provider.xml @@ -0,0 +1,45 @@ + + + + online.bank.statement.provider.form + online.bank.statement.provider + + + +
+
+
+ + + + + + + + + + + + + + + +
+
+
diff --git a/account_statement_import_online_ofx/wizards/__init__.py b/account_statement_import_online_ofx/wizards/__init__.py new file mode 100644 index 00000000..a8ac6626 --- /dev/null +++ b/account_statement_import_online_ofx/wizards/__init__.py @@ -0,0 +1,3 @@ +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). + +from . import online_bank_statement_pull_wizard diff --git a/account_statement_import_online_ofx/wizards/online_bank_statement_pull_wizard.py b/account_statement_import_online_ofx/wizards/online_bank_statement_pull_wizard.py new file mode 100644 index 00000000..0c08874d --- /dev/null +++ b/account_statement_import_online_ofx/wizards/online_bank_statement_pull_wizard.py @@ -0,0 +1,32 @@ +# Copyright 2023 ForgeFlow S.L. +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html). + +from odoo import api, fields, models + + +class OnlineBankStatementPullWizard(models.TransientModel): + _inherit = "online.bank.statement.pull.wizard" + + ofx_institution_ids = fields.Many2many( + string="OFX Institutions", + comodel_name="ofx.institution.line", + column1="wizard_id", + column2="institution_line_id", + relation="ofx_institution_line_pull_wizard_rel", + ) + is_ofx_provider = fields.Boolean() + + @api.onchange("provider_ids") + def onchange_provider_ids(self): + for rec in self: + rec.is_ofx_provider = False + for provider in rec.provider_ids: + if provider.service == "OFX": + rec.is_ofx_provider = True + break + + def action_pull(self): + return super( + OnlineBankStatementPullWizard, + self.with_context(ofx_institution_ids=self.ofx_institution_ids.ids), + ).action_pull() diff --git a/account_statement_import_online_ofx/wizards/online_bank_statement_pull_wizard.xml b/account_statement_import_online_ofx/wizards/online_bank_statement_pull_wizard.xml new file mode 100644 index 00000000..ade08671 --- /dev/null +++ b/account_statement_import_online_ofx/wizards/online_bank_statement_pull_wizard.xml @@ -0,0 +1,22 @@ + + + + online.bank.statement.pull.wizard.form + online.bank.statement.pull.wizard + + + + + + + + +