From f4449016e9499e1bd5aeedf3f1d7bd3329210a7b Mon Sep 17 00:00:00 2001 From: JasminSForgeFlow Date: Tue, 24 Jan 2023 14:31:22 +0530 Subject: [PATCH 1/8] [ADD] account_bank_statement_import_online_ofx --- .../README.rst | 110 ++++++++++++++ .../__init__.py | 4 + .../__manifest__.py | 20 +++ .../models/__init__.py | 4 + .../models/ofx_institution.py | 14 ++ .../online_bank_statement_provider_ofx.py | 140 ++++++++++++++++++ .../security/ir.model.access.csv | 5 + .../static/description/icon.png | Bin 0 -> 9455 bytes .../views/online_bank_statement_provider.xml | 45 ++++++ .../wizards/__init__.py | 3 + .../online_bank_statement_pull_wizard.py | 32 ++++ .../online_bank_statement_pull_wizard.xml | 22 +++ 12 files changed, 399 insertions(+) create mode 100644 account_statement_import_online_ofx/README.rst create mode 100644 account_statement_import_online_ofx/__init__.py create mode 100644 account_statement_import_online_ofx/__manifest__.py create mode 100644 account_statement_import_online_ofx/models/__init__.py create mode 100644 account_statement_import_online_ofx/models/ofx_institution.py create mode 100644 account_statement_import_online_ofx/models/online_bank_statement_provider_ofx.py create mode 100644 account_statement_import_online_ofx/security/ir.model.access.csv create mode 100644 account_statement_import_online_ofx/static/description/icon.png create mode 100644 account_statement_import_online_ofx/views/online_bank_statement_provider.xml create mode 100644 account_statement_import_online_ofx/wizards/__init__.py create mode 100644 account_statement_import_online_ofx/wizards/online_bank_statement_pull_wizard.py create mode 100644 account_statement_import_online_ofx/wizards/online_bank_statement_pull_wizard.xml 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 0000000000000000000000000000000000000000..3a0328b516c4980e8e44cdb63fd945757ddd132d GIT binary patch literal 9455 zcmW++2RxMjAAjx~&dlBk9S+%}OXg)AGE&Cb*&}d0jUxM@u(PQx^-s)697TX`ehR4?GS^qbkof1cslKgkU)h65qZ9Oc=ml_0temigYLJfnz{IDzUf>bGs4N!v3=Z3jMq&A#7%rM5eQ#dc?k~! zVpnB`o+K7|Al`Q_U;eD$B zfJtP*jH`siUq~{KE)`jP2|#TUEFGRryE2`i0**z#*^6~AI|YzIWy$Cu#CSLW3q=GA z6`?GZymC;dCPk~rBS%eCb`5OLr;RUZ;D`}um=H)BfVIq%7VhiMr)_#G0N#zrNH|__ zc+blN2UAB0=617@>_u;MPHN;P;N#YoE=)R#i$k_`UAA>WWCcEVMh~L_ zj--gtp&|K1#58Yz*AHCTMziU1Jzt_jG0I@qAOHsk$2}yTmVkBp_eHuY$A9)>P6o~I z%aQ?!(GqeQ-Y+b0I(m9pwgi(IIZZzsbMv+9w{PFtd_<_(LA~0H(xz{=FhLB@(1&qHA5EJw1>>=%q2f&^X>IQ{!GJ4e9U z&KlB)z(84HmNgm2hg2C0>WM{E(DdPr+EeU_N@57;PC2&DmGFW_9kP&%?X4}+xWi)( z;)z%wI5>D4a*5XwD)P--sPkoY(a~WBw;E~AW`Yue4kFa^LM3X`8x|}ZUeMnqr}>kH zG%WWW>3ml$Yez?i%)2pbKPI7?5o?hydokgQyZsNEr{a|mLdt;X2TX(#B1j35xPnPW z*bMSSOauW>o;*=kO8ojw91VX!qoOQb)zHJ!odWB}d+*K?#sY_jqPdg{Sm2HdYzdEx zOGVPhVRTGPtv0o}RfVP;Nd(|CB)I;*t&QO8h zFfekr30S!-LHmV_Su-W+rEwYXJ^;6&3|L$mMC8*bQptyOo9;>Qb9Q9`ySe3%V$A*9 zeKEe+b0{#KWGp$F+tga)0RtI)nhMa-K@JS}2krK~n8vJ=Ngm?R!9G<~RyuU0d?nz# z-5EK$o(!F?hmX*2Yt6+coY`6jGbb7tF#6nHA zuKk=GGJ;ZwON1iAfG$E#Y7MnZVmrY|j0eVI(DN_MNFJmyZ|;w4tf@=CCDZ#5N_0K= z$;R~bbk?}TpfDjfB&aiQ$VA}s?P}xPERJG{kxk5~R`iRS(SK5d+Xs9swCozZISbnS zk!)I0>t=A<-^z(cmSFz3=jZ23u13X><0b)P)^1T_))Kr`e!-pb#q&J*Q`p+B6la%C zuVl&0duN<;uOsB3%T9Fp8t{ED108<+W(nOZd?gDnfNBC3>M8WE61$So|P zVvqH0SNtDTcsUdzaMDpT=Ty0pDHHNL@Z0w$Y`XO z2M-_r1S+GaH%pz#Uy0*w$Vdl=X=rQXEzO}d6J^R6zjM1u&c9vYLvLp?W7w(?np9x1 zE_0JSAJCPB%i7p*Wvg)pn5T`8k3-uR?*NT|J`eS#_#54p>!p(mLDvmc-3o0mX*mp_ zN*AeS<>#^-{S%W<*mz^!X$w_2dHWpcJ6^j64qFBft-o}o_Vx80o0>}Du;>kLts;$8 zC`7q$QI(dKYG`Wa8#wl@V4jVWBRGQ@1dr-hstpQL)Tl+aqVpGpbSfN>5i&QMXfiZ> zaA?T1VGe?rpQ@;+pkrVdd{klI&jVS@I5_iz!=UMpTsa~mBga?1r}aRBm1WS;TT*s0f0lY=JBl66Upy)-k4J}lh=P^8(SXk~0xW=T9v*B|gzIhN z>qsO7dFd~mgxAy4V?&)=5ieYq?zi?ZEoj)&2o)RLy=@hbCRcfT5jigwtQGE{L*8<@Yd{zg;CsL5mvzfDY}P-wos_6PfprFVaeqNE%h zKZhLtcQld;ZD+>=nqN~>GvROfueSzJD&BE*}XfU|H&(FssBqY=hPCt`d zH?@s2>I(|;fcW&YM6#V#!kUIP8$Nkdh0A(bEVj``-AAyYgwY~jB zT|I7Bf@%;7aL7Wf4dZ%VqF$eiaC38OV6oy3Z#TER2G+fOCd9Iaoy6aLYbPTN{XRPz z;U!V|vBf%H!}52L2gH_+j;`bTcQRXB+y9onc^wLm5wi3-Be}U>k_u>2Eg$=k!(l@I zcCg+flakT2Nej3i0yn+g+}%NYb?ta;R?(g5SnwsQ49U8Wng8d|{B+lyRcEDvR3+`O{zfmrmvFrL6acVP%yG98X zo&+VBg@px@i)%o?dG(`T;n*$S5*rnyiR#=wW}}GsAcfyQpE|>a{=$Hjg=-*_K;UtD z#z-)AXwSRY?OPefw^iI+ z)AXz#PfEjlwTes|_{sB?4(O@fg0AJ^g8gP}ex9Ucf*@_^J(s_5jJV}c)s$`Myn|Kd z$6>}#q^n{4vN@+Os$m7KV+`}c%4)4pv@06af4-x5#wj!KKb%caK{A&Y#Rfs z-po?Dcb1({W=6FKIUirH&(yg=*6aLCekcKwyfK^JN5{wcA3nhO(o}SK#!CINhI`-I z1)6&n7O&ZmyFMuNwvEic#IiOAwNkR=u5it{B9n2sAJV5pNhar=j5`*N!Na;c7g!l$ z3aYBqUkqqTJ=Re-;)s!EOeij=7SQZ3Hq}ZRds%IM*PtM$wV z@;rlc*NRK7i3y5BETSKuumEN`Xu_8GP1Ri=OKQ$@I^ko8>H6)4rjiG5{VBM>B|%`&&s^)jS|-_95&yc=GqjNo{zFkw%%HHhS~e=s zD#sfS+-?*t|J!+ozP6KvtOl!R)@@-z24}`9{QaVLD^9VCSR2b`b!KC#o;Ki<+wXB6 zx3&O0LOWcg4&rv4QG0)4yb}7BFSEg~=IR5#ZRj8kg}dS7_V&^%#Do==#`u zpy6{ox?jWuR(;pg+f@mT>#HGWHAJRRDDDv~@(IDw&R>9643kK#HN`!1vBJHnC+RM&yIh8{gG2q zA%e*U3|N0XSRa~oX-3EAneep)@{h2vvd3Xvy$7og(sayr@95+e6~Xvi1tUqnIxoIH zVWo*OwYElb#uyW{Imam6f2rGbjR!Y3`#gPqkv57dB6K^wRGxc9B(t|aYDGS=m$&S!NmCtrMMaUg(c zc2qC=2Z`EEFMW-me5B)24AqF*bV5Dr-M5ig(l-WPS%CgaPzs6p_gnCIvTJ=Y<6!gT zVt@AfYCzjjsMEGi=rDQHo0yc;HqoRNnNFeWZgcm?f;cp(6CNylj36DoL(?TS7eU#+ z7&mfr#y))+CJOXQKUMZ7QIdS9@#-}7y2K1{8)cCt0~-X0O!O?Qx#E4Og+;A2SjalQ zs7r?qn0H044=sDN$SRG$arw~n=+T_DNdSrarmu)V6@|?1-ZB#hRn`uilTGPJ@fqEy zGt(f0B+^JDP&f=r{#Y_wi#AVDf-y!RIXU^0jXsFpf>=Ji*TeqSY!H~AMbJdCGLhC) zn7Rx+sXw6uYj;WRYrLd^5IZq@6JI1C^YkgnedZEYy<&4(z%Q$5yv#Boo{AH8n$a zhb4Y3PWdr269&?V%uI$xMcUrMzl=;w<_nm*qr=c3Rl@i5wWB;e-`t7D&c-mcQl7x! zZWB`UGcw=Y2=}~wzrfLx=uet<;m3~=8I~ZRuzvMQUQdr+yTV|ATf1Uuomr__nDf=X zZ3WYJtHp_ri(}SQAPjv+Y+0=fH4krOP@S&=zZ-t1jW1o@}z;xk8 z(Nz1co&El^HK^NrhVHa-_;&88vTU>_J33=%{if;BEY*J#1n59=07jrGQ#IP>@u#3A z;!q+E1Rj3ZJ+!4bq9F8PXJ@yMgZL;>&gYA0%_Kbi8?S=XGM~dnQZQ!yBSgcZhY96H zrWnU;k)qy`rX&&xlDyA%(a1Hhi5CWkmg(`Gb%m(HKi-7Z!LKGRP_B8@`7&hdDy5n= z`OIxqxiVfX@OX1p(mQu>0Ai*v_cTMiw4qRt3~NBvr9oBy0)r>w3p~V0SCm=An6@3n)>@z!|o-$HvDK z|3D2ZMJkLE5loMKl6R^ez@Zz%S$&mbeoqH5`Bb){Ei21q&VP)hWS2tjShfFtGE+$z zzCR$P#uktu+#!w)cX!lWN1XU%K-r=s{|j?)Akf@q#3b#{6cZCuJ~gCxuMXRmI$nGtnH+-h z+GEi!*X=AP<|fG`1>MBdTb?28JYc=fGvAi2I<$B(rs$;eoJCyR6_bc~p!XR@O-+sD z=eH`-ye})I5ic1eL~TDmtfJ|8`0VJ*Yr=hNCd)G1p2MMz4C3^Mj?7;!w|Ly%JqmuW zlIEW^Ft%z?*|fpXda>Jr^1noFZEwFgVV%|*XhH@acv8rdGxeEX{M$(vG{Zw+x(ei@ zmfXb22}8-?Fi`vo-YVrTH*C?a8%M=Hv9MqVH7H^J$KsD?>!SFZ;ZsvnHr_gn=7acz z#W?0eCdVhVMWN12VV^$>WlQ?f;P^{(&pYTops|btm6aj>_Uz+hqpGwB)vWp0Cf5y< zft8-je~nn?W11plq}N)4A{l8I7$!ks_x$PXW-2XaRFswX_BnF{R#6YIwMhAgd5F9X zGmwdadS6(a^fjHtXg8=l?Rc0Sm%hk6E9!5cLVloEy4eh(=FwgP`)~I^5~pBEWo+F6 zSf2ncyMurJN91#cJTy_u8Y}@%!bq1RkGC~-bV@SXRd4F{R-*V`bS+6;W5vZ(&+I<9$;-V|eNfLa5n-6% z2(}&uGRF;p92eS*sE*oR$@pexaqr*meB)VhmIg@h{uzkk$9~qh#cHhw#>O%)b@+(| z^IQgqzuj~Sk(J;swEM-3TrJAPCq9k^^^`q{IItKBRXYe}e0Tdr=Huf7da3$l4PdpwWDop%^}n;dD#K4s#DYA8SHZ z&1!riV4W4R7R#C))JH1~axJ)RYnM$$lIR%6fIVA@zV{XVyx}C+a-Dt8Y9M)^KU0+H zR4IUb2CJ{Hg>CuaXtD50jB(_Tcx=Z$^WYu2u5kubqmwp%drJ6 z?Fo40g!Qd<-l=TQxqHEOuPX0;^z7iX?Ke^a%XT<13TA^5`4Xcw6D@Ur&VT&CUe0d} z1GjOVF1^L@>O)l@?bD~$wzgf(nxX1OGD8fEV?TdJcZc2KoUe|oP1#=$$7ee|xbY)A zDZq+cuTpc(fFdj^=!;{k03C69lMQ(|>uhRfRu%+!k&YOi-3|1QKB z z?n?eq1XP>p-IM$Z^C;2L3itnbJZAip*Zo0aw2bs8@(s^~*8T9go!%dHcAz2lM;`yp zD=7&xjFV$S&5uDaiScyD?B-i1ze`+CoRtz`Wn+Zl&#s4&}MO{@N!ufrzjG$B79)Y2d3tBk&)TxUTw@QS0TEL_?njX|@vq?Uz(nBFK5Pq7*xj#u*R&i|?7+6# z+|r_n#SW&LXhtheZdah{ZVoqwyT{D>MC3nkFF#N)xLi{p7J1jXlmVeb;cP5?e(=f# zuT7fvjSbjS781v?7{)-X3*?>tq?)Yd)~|1{BDS(pqC zC}~H#WXlkUW*H5CDOo<)#x7%RY)A;ShGhI5s*#cRDA8YgqG(HeKDx+#(ZQ?386dv! zlXCO)w91~Vw4AmOcATuV653fa9R$fyK8ul%rG z-wfS zihugoZyr38Im?Zuh6@RcF~t1anQu7>#lPpb#}4cOA!EM11`%f*07RqOVkmX{p~KJ9 z^zP;K#|)$`^Rb{rnHGH{~>1(fawV0*Z#)}M`m8-?ZJV<+e}s9wE# z)l&az?w^5{)`S(%MRzxdNqrs1n*-=jS^_jqE*5XDrA0+VE`5^*p3CuM<&dZEeCjoz zR;uu_H9ZPZV|fQq`Cyw4nscrVwi!fE6ciMmX$!_hN7uF;jjKG)d2@aC4ropY)8etW=xJvni)8eHi`H$%#zn^WJ5NLc-rqk|u&&4Z6fD_m&JfSI1Bvb?b<*n&sfl0^t z=HnmRl`XrFvMKB%9}>PaA`m-fK6a0(8=qPkWS5bb4=v?XcWi&hRY?O5HdulRi4?fN zlsJ*N-0Qw+Yic@s0(2uy%F@ib;GjXt01Fmx5XbRo6+n|pP(&nodMoap^z{~q ziEeaUT@Mxe3vJSfI6?uLND(CNr=#^W<1b}jzW58bIfyWTDle$mmS(|x-0|2UlX+9k zQ^EX7Nw}?EzVoBfT(-LT|=9N@^hcn-_p&sqG z&*oVs2JSU+N4ZD`FhCAWaS;>|wH2G*Id|?pa#@>tyxX`+4HyIArWDvVrX)2WAOQff z0qyHu&-S@i^MS-+j--!pr4fPBj~_8({~e1bfcl0wI1kaoN>mJL6KUPQm5N7lB(ui1 zE-o%kq)&djzWJ}ob<-GfDlkB;F31j-VHKvQUGQ3sp`CwyGJk_i!y^sD0fqC@$9|jO zOqN!r!8-p==F@ZVP=U$qSpY(gQ0)59P1&t@y?5rvg<}E+GB}26NYPp4f2YFQrQtot5mn3wu_qprZ=>Ig-$ zbW26Ws~IgY>}^5w`vTB(G`PTZaDiGBo5o(tp)qli|NeV( z@H_=R8V39rt5J5YB2Ky?4eJJ#b`_iBe2ot~6%7mLt5t8Vwi^Jy7|jWXqa3amOIoRb zOr}WVFP--DsS`1WpN%~)t3R!arKF^Q$e12KEqU36AWwnCBICpH4XCsfnyrHr>$I$4 z!DpKX$OKLWarN7nv@!uIA+~RNO)l$$w}p(;b>mx8pwYvu;dD_unryX_NhT8*Tj>BTrTTL&!?O+%Rv;b?B??gSzdp?6Uug9{ zd@V08Z$BdI?fpoCS$)t4mg4rT8Q_I}h`0d-vYZ^|dOB*Q^S|xqTV*vIg?@fVFSmMpaw0qtTRbx} z({Pg?#{2`sc9)M5N$*N|4;^t$+QP?#mov zGVC@I*lBVrOU-%2y!7%)fAKjpEFsgQc4{amtiHb95KQEwvf<(3T<9-Zm$xIew#P22 zc2Ix|App^>v6(3L_MCU0d3W##AB0M~3D00EWoKZqsJYT(#@w$Y_H7G22M~ApVFTRHMI_3be)Lkn#0F*V8Pq zc}`Cjy$bE;FJ6H7p=0y#R>`}-m4(0F>%@P|?7fx{=R^uFdISRnZ2W_xQhD{YuR3t< z{6yxu=4~JkeA;|(J6_nv#>Nvs&FuLA&PW^he@t(UwFFE8)|a!R{`E`K`i^ZnyE4$k z;(749Ix|oi$c3QbEJ3b~D_kQsPz~fIUKym($a_7dJ?o+40*OLl^{=&oq$<#Q(yyrp z{J-FAniyAw9tPbe&IhQ|a`DqFTVQGQ&Gq3!C2==4x{6EJwiPZ8zub-iXoUtkJiG{} zPaR&}_fn8_z~(=;5lD-aPWD3z8PZS@AaUiomF!G8I}Mf>e~0g#BelA-5#`cj;O5>N Xviia!U7SGha1wx#SCgwmn*{w2TRX*I literal 0 HcmV?d00001 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 + + + + + + + + + From 6e1b366c6a04767c175c3de300b4f9a2a279865b Mon Sep 17 00:00:00 2001 From: JasminSForgeFlow Date: Thu, 23 Feb 2023 15:08:52 +0530 Subject: [PATCH 2/8] [IMP] account_bank_statement_import_online_ofx: Add Tests --- .../tests/__init__.py | 3 + ...est_account_statement_import_online_ofx.py | 101 ++++++++++++++++++ 2 files changed, 104 insertions(+) create mode 100644 account_statement_import_online_ofx/tests/__init__.py create mode 100644 account_statement_import_online_ofx/tests/test_account_statement_import_online_ofx.py diff --git a/account_statement_import_online_ofx/tests/__init__.py b/account_statement_import_online_ofx/tests/__init__.py new file mode 100644 index 00000000..249d8d9a --- /dev/null +++ b/account_statement_import_online_ofx/tests/__init__.py @@ -0,0 +1,3 @@ +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). + +from . import test_account_statement_import_online_ofx diff --git a/account_statement_import_online_ofx/tests/test_account_statement_import_online_ofx.py b/account_statement_import_online_ofx/tests/test_account_statement_import_online_ofx.py new file mode 100644 index 00000000..655a6473 --- /dev/null +++ b/account_statement_import_online_ofx/tests/test_account_statement_import_online_ofx.py @@ -0,0 +1,101 @@ +# Copyright 2023 ForgeFlow S.L. +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). + +from datetime import datetime +from unittest import mock + +from dateutil.relativedelta import relativedelta + +from odoo import fields +from odoo.tests import common + +_module_ns = "odoo.addons.account_statement_import_online_ofx" +_provider_class = ( + _module_ns + + ".models.online_bank_statement_provider_ofx" + + ".OnlineBankStatementProviderOFX" +) + + +class TestAccountBankAccountStatementImportOnlineOFX(common.TransactionCase): + def setUp(self): + super().setUp() + + self.now = fields.Datetime.now() + self.today = datetime(self.now.year, self.now.month, self.now.day) + self.yesterday = self.today - relativedelta(days=1) + self.AccountJournal = self.env["account.journal"] + self.OnlineBankStatementProvider = self.env["online.bank.statement.provider"] + self.AccountBankStatement = self.env["account.bank.statement"] + self.AccountBankStatementLine = self.env["account.bank.statement.line"] + self.OfxInstitutionLine = self.env["ofx.institution.line"] + self.ofx_institute = self.env["ofx.institution"].create( + {"name": "Test", "nickname": "Test", "ofxhome_id": 1} + ) + + def test_import_online_ofx(self): + # Create bank journal + journal = self.AccountJournal.create( + { + "name": "Bank", + "type": "bank", + "code": "BANK", + "bank_statements_source": "online", + "online_bank_statement_provider": "OFX", + } + ) + provider = journal.online_bank_statement_provider_id + # Create OFX institution line in OFX provider + self.OfxInstitutionLine.create( + { + "institution_id": self.ofx_institute.id, + "username": "Test", + "password": "Test", + "bankid": "1234", + "provider_id": provider.id, + "account_id": "1234", + } + ) + + # import statement + + mocked_response = [ + { + "date": self.today, + "payment_ref": "BANKCARD 12345678", + "amount": 5645.07, + "unique_import_id": "202302211", + }, + { + "date": self.today, + "payment_ref": "ELECTRONIC IMAGE DEPOSIT", + "amount": 2874.91, + "unique_import_id": "202302212", + }, + { + "date": self.today, + "payment_ref": "BANKCARD 567890123", + "amount": 1269.18, + "unique_import_id": "202302213", + }, + ], {} + with mock.patch( + _provider_class + "._obtain_statement_data", + return_value=mocked_response, + ): + data = provider._obtain_statement_data( + self.yesterday, + self.today, + ) + + self.assertEqual(len(data[0]), 3) + self.assertEqual( + data[0][1], + { + "date": self.today, + "payment_ref": "ELECTRONIC IMAGE DEPOSIT", + "amount": 2874.91, + "unique_import_id": "202302212", + }, + ) + self.assertEqual(data[1], {}) From addd76414d276cdf0b2709851d0f2e1c4d3d5c01 Mon Sep 17 00:00:00 2001 From: JasminSForgeFlow Date: Thu, 23 Mar 2023 13:20:02 +0530 Subject: [PATCH 3/8] [IMP] account_statement_import_online_ofx: Change way to import institution list --- .../models/online_bank_statement_provider_ofx.py | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) 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 index 5805aeb4..01360612 100644 --- 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 @@ -3,8 +3,10 @@ import io import time +import xml.etree.ElementTree as ET from datetime import datetime +import requests from ofxparse import OfxParser from ofxtools import ofxhome, utils from ofxtools.Client import OFXClient, StmtRq @@ -115,7 +117,16 @@ class OnlineBankStatementProviderOFX(models.Model): def import_ofx_institutions(self): OfxInstitution = self.env["ofx.institution"] - for ofxhome_id, name in ofxhome.list_institutions().items(): + try: + with requests.get("http://www.ofxhome.com/api.php?all=yes") as f: + response = f.text + institute_list = { + fi.get("id").strip(): fi.get("name").strip() + for fi in ET.fromstring(response) + } + except Exception as e: + raise UserError(_(e)) + for ofxhome_id, name in institute_list.items(): institute = OfxInstitution.search([("ofxhome_id", "=", ofxhome_id)]) vals = { "name": name, From 9d254bf6dc64e54a3d08436a0517ac566bb727d4 Mon Sep 17 00:00:00 2001 From: JasminSForgeFlow Date: Fri, 31 Mar 2023 14:47:28 +0530 Subject: [PATCH 4/8] [IMP] account_bank_statement_import_online_ofx: add filter on provider selection --- .../wizards/online_bank_statement_pull_wizard.py | 1 + 1 file changed, 1 insertion(+) 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 index 0c08874d..3d0b8a18 100644 --- 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 @@ -13,6 +13,7 @@ class OnlineBankStatementPullWizard(models.TransientModel): column1="wizard_id", column2="institution_line_id", relation="ofx_institution_line_pull_wizard_rel", + domain="[('provider_id','in',provider_ids)]", ) is_ofx_provider = fields.Boolean() From 613b4c3c80d5b28cfe9b099339f59026b2edf9b0 Mon Sep 17 00:00:00 2001 From: JasminSForgeFlow Date: Thu, 6 Apr 2023 16:38:22 +0530 Subject: [PATCH 5/8] [IMP] account_bank_statement_import_online_ofx: Delete statement without lines --- .../online_bank_statement_provider_ofx.py | 25 +++++++++++++++++++ 1 file changed, 25 insertions(+) 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 index 01360612..0c5d7ea6 100644 --- 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 @@ -137,6 +137,31 @@ class OnlineBankStatementProviderOFX(models.Model): else: OfxInstitution.create(vals) + def _create_or_update_statement( + self, data, statement_date_since, statement_date_until + ): + # deleting blank statement for OFX online import + res = super()._create_or_update_statement( + data, statement_date_since, statement_date_until + ) + if self.service == "OFX": + AccountBankStatement = self.env["account.bank.statement"] + statement_date = self._get_statement_date( + statement_date_since, + statement_date_until, + ) + statement = AccountBankStatement.search( + [ + ("journal_id", "=", self.journal_id.id), + ("state", "=", "open"), + ("date", "=", statement_date), + ], + limit=1, + ) + if not statement.line_ids: + statement.unlink() + return res + class OFXInstitutionLine(models.Model): _name = "ofx.institution.line" From bf54fa23b74f5527f0f5147f4e512fdedd4bb749 Mon Sep 17 00:00:00 2001 From: JasminSForgeFlow Date: Mon, 10 Jul 2023 16:18:46 +0530 Subject: [PATCH 6/8] [IMP] account_bank_statement_import_online_ofx: Update readme --- .../README.rst | 51 ++----------------- .../readme/CONFIGURE.rst | 9 ++++ .../readme/CONTRIBUTORS.rst | 3 ++ .../readme/DESCRIPTION.rst | 3 ++ .../readme/USAGE.rst | 6 +++ 5 files changed, 24 insertions(+), 48 deletions(-) create mode 100644 account_statement_import_online_ofx/readme/CONFIGURE.rst create mode 100644 account_statement_import_online_ofx/readme/CONTRIBUTORS.rst create mode 100644 account_statement_import_online_ofx/readme/DESCRIPTION.rst create mode 100644 account_statement_import_online_ofx/readme/USAGE.rst diff --git a/account_statement_import_online_ofx/README.rst b/account_statement_import_online_ofx/README.rst index efb2aa8d..8c9836b6 100644 --- a/account_statement_import_online_ofx/README.rst +++ b/account_statement_import_online_ofx/README.rst @@ -2,30 +2,10 @@ Online Bank Statements: OFX ================================== -.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! - !! This file is generated by oca-gen-addon-readme !! - !! changes will be overwritten. !! - !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! +This module provides online bank statements from Open Financial Exchange (OFX) institutions. +You can set-up your own provider, or import a list of supported providers. +https://ofxhome.com/ is used as a data source, currently over 300 institutions are supported. -.. |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** @@ -83,28 +63,3 @@ 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/readme/CONFIGURE.rst b/account_statement_import_online_ofx/readme/CONFIGURE.rst new file mode 100644 index 00000000..d5439af2 --- /dev/null +++ b/account_statement_import_online_ofx/readme/CONFIGURE.rst @@ -0,0 +1,9 @@ +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. diff --git a/account_statement_import_online_ofx/readme/CONTRIBUTORS.rst b/account_statement_import_online_ofx/readme/CONTRIBUTORS.rst new file mode 100644 index 00000000..73eeecf7 --- /dev/null +++ b/account_statement_import_online_ofx/readme/CONTRIBUTORS.rst @@ -0,0 +1,3 @@ +* `ForgeFlow `__ + + * Jasmin Solanki diff --git a/account_statement_import_online_ofx/readme/DESCRIPTION.rst b/account_statement_import_online_ofx/readme/DESCRIPTION.rst new file mode 100644 index 00000000..8527917b --- /dev/null +++ b/account_statement_import_online_ofx/readme/DESCRIPTION.rst @@ -0,0 +1,3 @@ +This module provides online bank statements from Open Financial Exchange (OFX) institutions. +You can set-up your own provider, or import a list of supported providers. +https://ofxhome.com/ is used as a data source, currently over 300 institutions are supported. diff --git a/account_statement_import_online_ofx/readme/USAGE.rst b/account_statement_import_online_ofx/readme/USAGE.rst new file mode 100644 index 00000000..49874cc2 --- /dev/null +++ b/account_statement_import_online_ofx/readme/USAGE.rst @@ -0,0 +1,6 @@ +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* From 1b6a178af5249ad6a185ab5779116fec44191f40 Mon Sep 17 00:00:00 2001 From: PauBForgeFlow Date: Fri, 28 Jul 2023 11:19:40 +0200 Subject: [PATCH 7/8] [IMP] account_statement_import_online_ofx: pre-commit stuff --- requirements.txt | 1 + .../odoo/addons/account_statement_import_online_ofx | 1 + setup/account_statement_import_online_ofx/setup.py | 6 ++++++ 3 files changed, 8 insertions(+) create mode 120000 setup/account_statement_import_online_ofx/odoo/addons/account_statement_import_online_ofx create mode 100644 setup/account_statement_import_online_ofx/setup.py diff --git a/requirements.txt b/requirements.txt index d3433a96..5225efd4 100644 --- a/requirements.txt +++ b/requirements.txt @@ -2,3 +2,4 @@ chardet ofxparse xlrd +ofxtools diff --git a/setup/account_statement_import_online_ofx/odoo/addons/account_statement_import_online_ofx b/setup/account_statement_import_online_ofx/odoo/addons/account_statement_import_online_ofx new file mode 120000 index 00000000..0551abde --- /dev/null +++ b/setup/account_statement_import_online_ofx/odoo/addons/account_statement_import_online_ofx @@ -0,0 +1 @@ +../../../../account_statement_import_online_ofx \ No newline at end of file diff --git a/setup/account_statement_import_online_ofx/setup.py b/setup/account_statement_import_online_ofx/setup.py new file mode 100644 index 00000000..28c57bb6 --- /dev/null +++ b/setup/account_statement_import_online_ofx/setup.py @@ -0,0 +1,6 @@ +import setuptools + +setuptools.setup( + setup_requires=['setuptools-odoo'], + odoo_addon=True, +) From f5fd86f3e8f02b2438d27debfaee05e92ef8ae68 Mon Sep 17 00:00:00 2001 From: PauBForgeFlow Date: Wed, 2 Aug 2023 10:29:59 +0200 Subject: [PATCH 8/8] [MIG] account_statement_import_online: Migration to 16.0 --- .../README.rst | 74 ++- .../__manifest__.py | 6 +- .../online_bank_statement_provider_ofx.py | 37 +- .../readme/CONFIGURE.rst | 16 +- .../static/description/index.html | 451 ++++++++++++++++++ ...est_account_statement_import_online_ofx.py | 16 +- .../online_bank_statement_pull_wizard.py | 16 +- .../online_bank_statement_pull_wizard.xml | 2 +- requirements.txt | 2 +- 9 files changed, 559 insertions(+), 61 deletions(-) create mode 100644 account_statement_import_online_ofx/static/description/index.html diff --git a/account_statement_import_online_ofx/README.rst b/account_statement_import_online_ofx/README.rst index 8c9836b6..8e63a8fe 100644 --- a/account_statement_import_online_ofx/README.rst +++ b/account_statement_import_online_ofx/README.rst @@ -1,11 +1,36 @@ -================================== +=========================== Online Bank Statements: OFX -================================== +=========================== + +.. + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! source digest: sha256:e6ebad00d6c39c92584c6ee76b5deae328742e8a81229971ce4ca37d2f1e4cb1 + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |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/16.0/account_statement_import_online_ofx + :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-16-0/bank-statement-import-16-0-account_statement_import_online_ofx + :alt: Translate me on Weblate +.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png + :target: https://runboat.odoo-community.org/builds?repo=OCA/bank-statement-import&target_branch=16.0 + :alt: Try me on Runboat + +|badge1| |badge2| |badge3| |badge4| |badge5| This module provides online bank statements from Open Financial Exchange (OFX) institutions. You can set-up your own provider, or import a list of supported providers. -https://ofxhome.com/ is used as a data source, currently over 300 institutions are supported. - +https://ofxhome.com/ is used as a data source, currently over 300 institutions are supported. **Table of contents** @@ -17,13 +42,15 @@ 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. +#. Go to *Invoicing > Configuration > Online Bank Statement Providers* +#. Create a provider and configure provider-specific settings. + +If you want to allow empty bank statements to be created every time the +information is pulled, you can check the option "Allow empty statements" +at the provider configuration level. + +**NOTE**: To access these features, user needs to belong to +*Show Full Accounting Features* group. Usage ===== @@ -35,17 +62,13 @@ To pull historical bank statements: #. 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 `_. +If you spotted it first, help us to smash it by providing a detailed and welcomed +`feedback `_. Do not contact contributors directly about support or help with technical issues. @@ -63,3 +86,20 @@ 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. + +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/__manifest__.py b/account_statement_import_online_ofx/__manifest__.py index b81154df..cdf2c210 100644 --- a/account_statement_import_online_ofx/__manifest__.py +++ b/account_statement_import_online_ofx/__manifest__.py @@ -3,13 +3,15 @@ { "name": "Online Bank Statements: OFX", - "version": "14.0.1.0.0", + "version": "16.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"], + "depends": [ + "account_statement_import_online", + ], "external_dependencies": {"python": ["ofxtools", "ofxparse"]}, "data": [ "security/ir.model.access.csv", 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 index 0c5d7ea6..5be103dc 100644 --- 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 @@ -97,7 +97,7 @@ class OnlineBankStatementProviderOFX(models.Model): except Exception as e: raise UserError( _("The following problem occurred during import.\n\n %s") % str(e) - ) + ) from e return lines, {} @api.model @@ -118,14 +118,17 @@ class OnlineBankStatementProviderOFX(models.Model): def import_ofx_institutions(self): OfxInstitution = self.env["ofx.institution"] try: - with requests.get("http://www.ofxhome.com/api.php?all=yes") as f: + with requests.get( + "http://www.ofxhome.com/api.php?all=yes", timeout=30 + ) as f: response = f.text institute_list = { fi.get("id").strip(): fi.get("name").strip() for fi in ET.fromstring(response) } except Exception as e: - raise UserError(_(e)) + raise UserError(_(e)) from e + for ofxhome_id, name in institute_list.items(): institute = OfxInstitution.search([("ofxhome_id", "=", ofxhome_id)]) vals = { @@ -145,19 +148,27 @@ class OnlineBankStatementProviderOFX(models.Model): data, statement_date_since, statement_date_until ) if self.service == "OFX": - AccountBankStatement = self.env["account.bank.statement"] - statement_date = self._get_statement_date( + unfiltered_lines, statement_values = data + if not unfiltered_lines: + unfiltered_lines = [] + if not statement_values: + statement_values = {} + statement_values["name"] = self.make_statement_name(statement_date_since) + filtered_lines = self._get_statement_filtered_lines( + unfiltered_lines, + statement_values, statement_date_since, statement_date_until, ) - statement = AccountBankStatement.search( - [ - ("journal_id", "=", self.journal_id.id), - ("state", "=", "open"), - ("date", "=", statement_date), - ], - limit=1, - ) + if not filtered_lines: + return + if filtered_lines: + statement_values.update( + {"line_ids": [[0, False, line] for line in filtered_lines]} + ) + self._update_statement_balances(statement_values) + statement = self._statement_create_or_write(statement_values) + self._journal_set_statement_source() if not statement.line_ids: statement.unlink() return res diff --git a/account_statement_import_online_ofx/readme/CONFIGURE.rst b/account_statement_import_online_ofx/readme/CONFIGURE.rst index d5439af2..562e6f22 100644 --- a/account_statement_import_online_ofx/readme/CONFIGURE.rst +++ b/account_statement_import_online_ofx/readme/CONFIGURE.rst @@ -1,9 +1,11 @@ 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. +#. Go to *Invoicing > Configuration > Online Bank Statement Providers* +#. Create a provider and configure provider-specific settings. + +If you want to allow empty bank statements to be created every time the +information is pulled, you can check the option "Allow empty statements" +at the provider configuration level. + +**NOTE**: To access these features, user needs to belong to +*Show Full Accounting Features* group. diff --git a/account_statement_import_online_ofx/static/description/index.html b/account_statement_import_online_ofx/static/description/index.html new file mode 100644 index 00000000..5e8e3a4e --- /dev/null +++ b/account_statement_import_online_ofx/static/description/index.html @@ -0,0 +1,451 @@ + + + + + + +Online Bank Statements: OFX + + + +
+

Online Bank Statements: OFX

+ + +

Beta License: AGPL-3 OCA/bank-statement-import Translate me on Weblate Try me on Runboat

+

This module provides online bank statements from Open Financial Exchange (OFX) institutions. +You can set-up your own provider, or import a list of supported providers. +https://ofxhome.com/ is used as a data source, currently over 300 institutions are supported.

+

Table of contents

+ +
+

Configuration

+

To configure online bank statements provider:

+
    +
  1. Go to Invoicing > Configuration > Online Bank Statement Providers
    2. +
  2. Create a provider and configure provider-specific settings.
    3. +
+

If you want to allow empty bank statements to be created every time the +information is pulled, you can check the option “Allow empty statements” +at the provider configuration level.

+

NOTE: To access these features, user needs to belong to +Show Full Accounting Features group.

+
+
+

Usage

+

To pull historical bank statements:

+
    +
  1. Go to Invoicing > Configuration > Journals
    2. +
  2. Select specific bank accounts
    3. +
  3. Launch Actions > Online Bank Statements Pull Wizard
    4. +
  4. Configure date interval and click Pull
    5. +
+
+
+

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 to smash it by providing a detailed and welcomed +feedback.

+

Do not contact contributors directly about support or help with technical issues.

+
+
+

Credits

+
+

Authors

+
    +
  • ForgeFlow
    • +
+
+
+

Contributors

+ +
+
+

Maintainers

+

This module is maintained by the OCA.

+Odoo Community Association +

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.

+

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/tests/test_account_statement_import_online_ofx.py b/account_statement_import_online_ofx/tests/test_account_statement_import_online_ofx.py index 655a6473..c0c2dcf5 100644 --- a/account_statement_import_online_ofx/tests/test_account_statement_import_online_ofx.py +++ b/account_statement_import_online_ofx/tests/test_account_statement_import_online_ofx.py @@ -34,17 +34,11 @@ class TestAccountBankAccountStatementImportOnlineOFX(common.TransactionCase): ) def test_import_online_ofx(self): - # Create bank journal - journal = self.AccountJournal.create( - { - "name": "Bank", - "type": "bank", - "code": "BANK", - "bank_statements_source": "online", - "online_bank_statement_provider": "OFX", - } - ) - provider = journal.online_bank_statement_provider_id + + provider_model = self.env["online.bank.statement.provider"] + active_id = self.env.context.get("active_id") + provider = provider_model.browse(active_id) + # Create OFX institution line in OFX provider self.OfxInstitutionLine.create( { 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 index 3d0b8a18..af85425e 100644 --- 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 @@ -13,18 +13,16 @@ class OnlineBankStatementPullWizard(models.TransientModel): column1="wizard_id", column2="institution_line_id", relation="ofx_institution_line_pull_wizard_rel", - domain="[('provider_id','in',provider_ids)]", ) + 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 + @api.onchange("date_since") + def _compute_is_ofx_provider(self): + provider_model = self.env["online.bank.statement.provider"] + active_id = self.env.context.get("active_id") + provider = provider_model.browse(active_id) + self.is_ofx_provider = provider.service == "OFX" def action_pull(self): return super( 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 index ade08671..45a5483a 100644 --- 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 @@ -8,7 +8,7 @@ ref="account_statement_import_online.online_bank_statement_pull_wizard_form" /> - +