diff --git a/account_bank_statement_import_split/README.rst b/account_bank_statement_import_split/README.rst new file mode 100644 index 00000000..fb850de0 --- /dev/null +++ b/account_bank_statement_import_split/README.rst @@ -0,0 +1,87 @@ +============================================ +Account Bank Statement Import: Split by date +============================================ + +.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! 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/12.0/account_bank_statement_import_split + :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-12-0/bank-statement-import-12-0-account_bank_statement_import_split + :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/12.0 + :alt: Try me on Runbot + +|badge1| |badge2| |badge3| |badge4| |badge5| + +This module allows splitting statements by date during import: + +* as daily statements +* as weekly statements +* as monthly statements + +**Table of contents** + +.. contents:: + :local: + +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 +~~~~~~~ + +* CorporateHub + +Contributors +~~~~~~~~~~~~ + +* `CorporateHub `__ + + * Alexey Pelykh + +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_bank_statement_import_split/__init__.py b/account_bank_statement_import_split/__init__.py new file mode 100644 index 00000000..31660d6a --- /dev/null +++ b/account_bank_statement_import_split/__init__.py @@ -0,0 +1,3 @@ +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). + +from . import models diff --git a/account_bank_statement_import_split/__manifest__.py b/account_bank_statement_import_split/__manifest__.py new file mode 100644 index 00000000..a3ada7b8 --- /dev/null +++ b/account_bank_statement_import_split/__manifest__.py @@ -0,0 +1,17 @@ +# Copyright 2019-2020 Brainbean Apps (https://brainbeanapps.com) +# Copyright 2020-2021 CorporateHub (https://corporatehub.eu) +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). + +{ + "name": "Account Bank Statement Import: Split by date", + "version": "13.0.1.0.0", + "author": "CorporateHub, Odoo Community Association (OCA)", + "maintainers": ["alexey-pelykh"], + "website": "https://github.com/OCA/bank-statement-import", + "license": "AGPL-3", + "category": "Accounting", + "summary": "Split statements by date during import", + "depends": ["account_bank_statement_import"], + "data": ["views/account_bank_statement_import.xml"], + "installable": True, +} diff --git a/account_bank_statement_import_split/i18n/account_bank_statement_import_split.pot b/account_bank_statement_import_split/i18n/account_bank_statement_import_split.pot new file mode 100644 index 00000000..41f92b49 --- /dev/null +++ b/account_bank_statement_import_split/i18n/account_bank_statement_import_split.pot @@ -0,0 +1,50 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * account_bank_statement_import_split +# +msgid "" +msgstr "" +"Project-Id-Version: Odoo Server 12.0\n" +"Report-Msgid-Bugs-To: \n" +"Last-Translator: <>\n" +"Language-Team: \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: \n" +"Plural-Forms: \n" + +#. module: account_bank_statement_import_split +#: selection:account.bank.statement.import,import_mode:0 +msgid "Daily statements" +msgstr "" + +#. module: account_bank_statement_import_split +#: model:ir.model,name:account_bank_statement_import_split.model_account_bank_statement_import +msgid "Import Bank Statement" +msgstr "" + +#. module: account_bank_statement_import_split +#: model:ir.model.fields,field_description:account_bank_statement_import_split.field_account_bank_statement_import__import_mode +msgid "Import Mode" +msgstr "" + +#. module: account_bank_statement_import_split +#: selection:account.bank.statement.import,import_mode:0 +msgid "Monthly statements" +msgstr "" + +#. module: account_bank_statement_import_split +#: model_terms:ir.ui.view,arch_db:account_bank_statement_import_split.account_bank_statement_import_view +msgid "Please select how you'd like to split the imported statement file:" +msgstr "" + +#. module: account_bank_statement_import_split +#: selection:account.bank.statement.import,import_mode:0 +msgid "Single statement" +msgstr "" + +#. module: account_bank_statement_import_split +#: selection:account.bank.statement.import,import_mode:0 +msgid "Weekly statements" +msgstr "" + diff --git a/account_bank_statement_import_split/models/__init__.py b/account_bank_statement_import_split/models/__init__.py new file mode 100644 index 00000000..89d280ce --- /dev/null +++ b/account_bank_statement_import_split/models/__init__.py @@ -0,0 +1,3 @@ +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). + +from . import account_bank_statement_import diff --git a/account_bank_statement_import_split/models/account_bank_statement_import.py b/account_bank_statement_import_split/models/account_bank_statement_import.py new file mode 100644 index 00000000..7263a6d3 --- /dev/null +++ b/account_bank_statement_import_split/models/account_bank_statement_import.py @@ -0,0 +1,136 @@ +# Copyright 2019 Brainbean Apps (https://brainbeanapps.com) +# Copyright 2021 CorporateHub (https://corporatehub.eu) +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html). + +from decimal import Decimal + +from dateutil.relativedelta import MO, relativedelta + +from odoo import fields, models + + +class AccountBankStatementImport(models.TransientModel): + _inherit = "account.bank.statement.import" + + import_mode = fields.Selection( + selection=[ + ("single", "Single statement"), + ("daily", "Daily statements"), + ("weekly", "Weekly statements"), + ("monthly", "Monthly statements"), + ], + default="single", + ) + + def _complete_stmts_vals(self, stmts_vals, journal, account_number): + stmts_vals = super()._complete_stmts_vals(stmts_vals, journal, account_number) + if not self.import_mode or self.import_mode == "single": + return stmts_vals + statements = [] + for st_vals in stmts_vals: + transactions = list( + sorted( + map( + lambda transaction: self._prepare_transaction(transaction), + st_vals["transactions"], + ), + key=lambda transaction: transaction["date"], + ) + ) + if not transactions: + continue + del st_vals["transactions"] + + balance_start = ( + Decimal(st_vals["balance_start"]) + if "balance_start" in st_vals + else None + ) + balance_end = ( + Decimal(st_vals["balance_end_real"]) + if "balance_end_real" in st_vals + else None + ) + statement_date_since = self._get_statement_date_since( + transactions[0]["date"] + ) + while transactions: + statement_date_until = ( + statement_date_since + self._get_statement_date_step() + ) + + last_transaction_index = None + for index, transaction in enumerate(transactions): + if transaction["date"] >= statement_date_until: + break + last_transaction_index = index + if last_transaction_index is None: + # NOTE: No transactions for current period + statement_date_since = statement_date_until + continue + + statement_transactions = transactions[0 : last_transaction_index + 1] + transactions = transactions[last_transaction_index + 1 :] + + statement_values = dict(st_vals) + statement_values.update( + { + "name": self._get_statement_name( + journal, statement_date_since, statement_date_until, + ), + "date": self._get_statement_date( + statement_date_since, statement_date_until, + ), + "transactions": statement_transactions, + } + ) + if balance_start is not None: + statement_values.update({"balance_start": float(balance_start)}) + for transaction in statement_transactions: + balance_start += Decimal(transaction["amount"]) + if balance_end is not None: + statement_balance_end = balance_end + for transaction in transactions: + statement_balance_end -= Decimal(transaction["amount"]) + statement_values.update( + {"balance_end_real": float(statement_balance_end)} + ) + + statements.append(statement_values) + statement_date_since = statement_date_until + return statements + + def _prepare_transaction(self, transaction): + transaction.update({"date": fields.Date.from_string(transaction["date"])}) + return transaction + + def _get_statement_date_since(self, date): + self.ensure_one() + if self.import_mode == "daily": + return date + elif self.import_mode == "weekly": + return date + relativedelta(weekday=MO(-1)) + elif self.import_mode == "monthly": + return date.replace(day=1,) + + def _get_statement_date_step(self): + self.ensure_one() + if self.import_mode == "daily": + return relativedelta(days=1,) + elif self.import_mode == "weekly": + return relativedelta(weeks=1, weekday=MO,) + elif self.import_mode == "monthly": + return relativedelta(months=1, day=1,) + + def _get_statement_date(self, date_since, date_until): + self.ensure_one() + # NOTE: Statement date is treated by Odoo as start of period. Details + # - addons/account/models/account_journal_dashboard.py + # - def get_line_graph_datas() + return date_since + + def _get_statement_name(self, journal, date_since, date_until): + self.ensure_one() + return journal.sequence_id.with_context( + ir_sequence_date=self._get_statement_date(date_since, date_until) + ).next_by_id() diff --git a/account_bank_statement_import_split/readme/CONTRIBUTORS.rst b/account_bank_statement_import_split/readme/CONTRIBUTORS.rst new file mode 100644 index 00000000..724bc1d0 --- /dev/null +++ b/account_bank_statement_import_split/readme/CONTRIBUTORS.rst @@ -0,0 +1,3 @@ +* `CorporateHub `__ + + * Alexey Pelykh diff --git a/account_bank_statement_import_split/readme/DESCRIPTION.rst b/account_bank_statement_import_split/readme/DESCRIPTION.rst new file mode 100644 index 00000000..492d6413 --- /dev/null +++ b/account_bank_statement_import_split/readme/DESCRIPTION.rst @@ -0,0 +1,5 @@ +This module allows splitting statements by date during import: + +* as daily statements +* as weekly statements +* as monthly statements diff --git a/account_bank_statement_import_split/static/description/icon.png b/account_bank_statement_import_split/static/description/icon.png new file mode 100644 index 00000000..3a0328b5 Binary files /dev/null and b/account_bank_statement_import_split/static/description/icon.png differ diff --git a/account_bank_statement_import_split/static/description/index.html b/account_bank_statement_import_split/static/description/index.html new file mode 100644 index 00000000..e559b9f5 --- /dev/null +++ b/account_bank_statement_import_split/static/description/index.html @@ -0,0 +1,429 @@ + + + + + + +Account Bank Statement Import: Split by date + + + +
+

Account Bank Statement Import: Split by date

+ + +

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

+

This module allows splitting statements by date during import:

+
    +
  • as daily statements
    • +
  • as weekly statements
    • +
  • as monthly statements
    • +
+

Table of contents

+ +
+

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

+
    +
  • CorporateHub
    • +
+
+
+

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.

+

Current 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_bank_statement_import_split/tests/__init__.py b/account_bank_statement_import_split/tests/__init__.py new file mode 100644 index 00000000..edaecbe0 --- /dev/null +++ b/account_bank_statement_import_split/tests/__init__.py @@ -0,0 +1,3 @@ +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). + +from . import test_account_bank_statement_import_split diff --git a/account_bank_statement_import_split/tests/test_account_bank_statement_import_split.py b/account_bank_statement_import_split/tests/test_account_bank_statement_import_split.py new file mode 100644 index 00000000..7a49cf35 --- /dev/null +++ b/account_bank_statement_import_split/tests/test_account_bank_statement_import_split.py @@ -0,0 +1,332 @@ +# Copyright 2019 Brainbean Apps (https://brainbeanapps.com) +# Copyright 2021 CorporateHub (https://corporatehub.eu) +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). + +from base64 import b64encode +from unittest import mock + +from odoo import fields +from odoo.tests import common + +_parse_file_method = ( + "odoo.addons.account_bank_statement_import" + ".account_bank_statement_import.AccountBankStatementImport._parse_file" +) + + +class TestAccountBankAccountStatementImportSplit(common.TransactionCase): + def setUp(self): + super().setUp() + + self.now = fields.Datetime.now() + self.currency_usd = self.env.ref("base.USD") + self.empty_data_file = b64encode(b"TestAccountBankAccountStatementImportSplit") + self.AccountJournal = self.env["account.journal"] + self.AccountBankStatement = self.env["account.bank.statement"] + self.AccountBankStatementImport = self.env["account.bank.statement.import"] + + def test_default_import_mode(self): + journal = self.AccountJournal.create( + { + "name": "Bank", + "type": "bank", + "code": "BANK", + "currency_id": self.currency_usd.id, + } + ) + wizard = self.AccountBankStatementImport.with_context( + {"journal_id": journal.id} + ).create( + { + "attachment_ids": [ + ( + 0, + 0, + { + "name": "fixtures/statement_en.csv", + "datas": self.empty_data_file, + }, + ) + ], + } + ) + data = ( + journal.currency_id.name, + journal.bank_account_id.acc_number, + [ + { + "name": "STATEMENT", + "date": "2019-01-01", + "balance_start": 0.0, + "balance_end_real": 100.0, + "transactions": [ + { + "name": "TRANSACTION", + "amount": "100.0", + "date": "2019-01-01", + "note": "NOTE", + "unique_import_id": "TRANSACTION-ID", + } + ], + } + ], + ) + with mock.patch(_parse_file_method, return_value=data): + wizard.with_context({"journal_id": journal.id}).import_file() + statement = self.AccountBankStatement.search([("journal_id", "=", journal.id)]) + self.assertEqual(len(statement), 1) + self.assertEqual(len(statement.line_ids), 1) + + def test_single_import_mode(self): + journal = self.AccountJournal.create( + { + "name": "Bank", + "type": "bank", + "code": "BANK", + "currency_id": self.currency_usd.id, + } + ) + wizard = self.AccountBankStatementImport.with_context( + {"journal_id": journal.id} + ).create( + { + "attachment_ids": [ + ( + 0, + 0, + { + "name": "fixtures/statement_en.csv", + "datas": self.empty_data_file, + }, + ) + ], + "import_mode": "single", + } + ) + data = ( + journal.currency_id.name, + journal.bank_account_id.acc_number, + [ + { + "name": "STATEMENT", + "date": "2019-01-01", + "balance_start": 0.0, + "balance_end_real": 100.0, + "transactions": [ + { + "name": "TRANSACTION", + "amount": "100.0", + "date": "2019-01-01", + "note": "NOTE", + "unique_import_id": "TRANSACTION-ID", + } + ], + } + ], + ) + with mock.patch(_parse_file_method, return_value=data): + wizard.with_context({"journal_id": journal.id}).import_file() + statement = self.AccountBankStatement.search([("journal_id", "=", journal.id)]) + self.assertEqual(len(statement), 1) + self.assertEqual(len(statement.line_ids), 1) + + def test_daily_import_mode(self): + journal = self.AccountJournal.create( + { + "name": "Bank", + "type": "bank", + "code": "BANK", + "currency_id": self.currency_usd.id, + } + ) + wizard = self.AccountBankStatementImport.with_context( + {"journal_id": journal.id} + ).create( + { + "attachment_ids": [ + ( + 0, + 0, + { + "name": "fixtures/statement_en.csv", + "datas": self.empty_data_file, + }, + ) + ], + "import_mode": "daily", + } + ) + data = ( + journal.currency_id.name, + journal.bank_account_id.acc_number, + [ + { + "name": "STATEMENT", + "date": "2019-01-01", + "balance_start": 0.0, + "balance_end_real": 100.0, + "transactions": [ + { + "name": "TRANSACTION-1", + "amount": "50.0", + "date": "2019-01-01", + "note": "NOTE", + "unique_import_id": "TRANSACTION-ID-1", + }, + { + "name": "TRANSACTION-2", + "amount": "50.0", + "date": "2019-01-03", + "note": "NOTE", + "unique_import_id": "TRANSACTION-ID-2", + }, + ], + } + ], + ) + with mock.patch(_parse_file_method, return_value=data): + wizard.with_context({"journal_id": journal.id}).import_file() + statements = self.AccountBankStatement.search( + [("journal_id", "=", journal.id)] + ).sorted(key=lambda statement: statement.date) + self.assertEqual(len(statements), 2) + self.assertEqual(len(statements[0].line_ids), 1) + self.assertEqual(statements[0].balance_start, 0.0) + self.assertEqual(statements[0].balance_end_real, 50.0) + self.assertEqual(len(statements[1].line_ids), 1) + self.assertEqual(statements[1].balance_start, 50.0) + self.assertEqual(statements[1].balance_end_real, 100.0) + + def test_weekly_import_mode(self): + journal = self.AccountJournal.create( + { + "name": "Bank", + "type": "bank", + "code": "BANK", + "currency_id": self.currency_usd.id, + } + ) + wizard = self.AccountBankStatementImport.with_context( + {"journal_id": journal.id} + ).create( + { + "attachment_ids": [ + ( + 0, + 0, + { + "name": "fixtures/statement_en.csv", + "datas": self.empty_data_file, + }, + ) + ], + "import_mode": "weekly", + } + ) + data = ( + journal.currency_id.name, + journal.bank_account_id.acc_number, + [ + { + "name": "STATEMENT", + "date": "2019-01-01", + "balance_start": 0.0, + "balance_end_real": 100.0, + "transactions": [ + { + "name": "TRANSACTION-1", + "amount": "50.0", + "date": "2019-01-01", + "note": "NOTE", + "unique_import_id": "TRANSACTION-ID-1", + }, + { + "name": "TRANSACTION-2", + "amount": "50.0", + "date": "2019-01-15", + "note": "NOTE", + "unique_import_id": "TRANSACTION-ID-2", + }, + ], + } + ], + ) + with mock.patch(_parse_file_method, return_value=data): + wizard.with_context({"journal_id": journal.id}).import_file() + statements = self.AccountBankStatement.search( + [("journal_id", "=", journal.id)] + ).sorted(key=lambda statement: statement.date) + self.assertEqual(len(statements), 2) + self.assertEqual(len(statements[0].line_ids), 1) + self.assertEqual(statements[0].balance_start, 0.0) + self.assertEqual(statements[0].balance_end_real, 50.0) + self.assertEqual(len(statements[1].line_ids), 1) + self.assertEqual(statements[1].balance_start, 50.0) + self.assertEqual(statements[1].balance_end_real, 100.0) + + def test_monthly_import_mode(self): + journal = self.AccountJournal.create( + { + "name": "Bank", + "type": "bank", + "code": "BANK", + "currency_id": self.currency_usd.id, + } + ) + wizard = self.AccountBankStatementImport.with_context( + {"journal_id": journal.id} + ).create( + { + "attachment_ids": [ + ( + 0, + 0, + { + "name": "fixtures/statement_en.csv", + "datas": self.empty_data_file, + }, + ) + ], + "import_mode": "monthly", + } + ) + data = ( + journal.currency_id.name, + journal.bank_account_id.acc_number, + [ + { + "name": "STATEMENT", + "date": "2019-01-01", + "balance_start": 0.0, + "balance_end_real": 100.0, + "transactions": [ + { + "name": "TRANSACTION-1", + "amount": "50.0", + "date": "2019-01-01", + "note": "NOTE", + "unique_import_id": "TRANSACTION-ID-1", + }, + { + "name": "TRANSACTION-2", + "amount": "50.0", + "date": "2019-03-01", + "note": "NOTE", + "unique_import_id": "TRANSACTION-ID-2", + }, + ], + } + ], + ) + with mock.patch(_parse_file_method, return_value=data): + wizard.with_context({"journal_id": journal.id}).import_file() + statements = self.AccountBankStatement.search( + [("journal_id", "=", journal.id)] + ).sorted(key=lambda statement: statement.date) + self.assertEqual(len(statements), 2) + self.assertEqual(len(statements[0].line_ids), 1) + self.assertEqual(statements[0].balance_start, 0.0) + self.assertEqual(statements[0].balance_end_real, 50.0) + self.assertEqual(len(statements[1].line_ids), 1) + self.assertEqual(statements[1].balance_start, 50.0) + self.assertEqual(statements[1].balance_end_real, 100.0) diff --git a/account_bank_statement_import_split/views/account_bank_statement_import.xml b/account_bank_statement_import_split/views/account_bank_statement_import.xml new file mode 100644 index 00000000..c1c4541c --- /dev/null +++ b/account_bank_statement_import_split/views/account_bank_statement_import.xml @@ -0,0 +1,21 @@ + + + + + account.bank.statement.import + + + +

Please select how you'd like to split the imported statement file:

+ + + + + diff --git a/setup/account_bank_statement_import_split/odoo/addons/account_bank_statement_import_split b/setup/account_bank_statement_import_split/odoo/addons/account_bank_statement_import_split new file mode 120000 index 00000000..2687a326 --- /dev/null +++ b/setup/account_bank_statement_import_split/odoo/addons/account_bank_statement_import_split @@ -0,0 +1 @@ +../../../../account_bank_statement_import_split \ No newline at end of file diff --git a/setup/account_bank_statement_import_split/setup.py b/setup/account_bank_statement_import_split/setup.py new file mode 100644 index 00000000..28c57bb6 --- /dev/null +++ b/setup/account_bank_statement_import_split/setup.py @@ -0,0 +1,6 @@ +import setuptools + +setuptools.setup( + setup_requires=['setuptools-odoo'], + odoo_addon=True, +)