# -*- coding: utf-8 -*- from odoo import models, tools, _ from odoo.addons.base.models.res_bank import sanitize_account_number from odoo.exceptions import UserError, RedirectWarning class AccountJournal(models.Model): _inherit = "account.journal" def _get_bank_statements_available_import_formats(self): """ Returns a list of strings representing the supported import formats. """ return [] def __get_bank_statements_available_sources(self): rslt = super(AccountJournal, self).__get_bank_statements_available_sources() formats_list = self._get_bank_statements_available_import_formats() if formats_list: formats_list.sort() import_formats_str = ', '.join(formats_list) rslt.append(("file_import", _("Manual (or import %(import_formats)s)", import_formats=import_formats_str))) return rslt def create_document_from_attachment(self, attachment_ids=None): journal = self or self.browse(self.env.context.get('default_journal_id')) if journal.type in ('bank', 'cash'): attachments = self.env['ir.attachment'].browse(attachment_ids) if not attachments: raise UserError(_("No attachment was provided")) return journal._import_bank_statement(attachments) return super().create_document_from_attachment(attachment_ids) def _import_bank_statement(self, attachments): """ Process the file chosen in the wizard, create bank statement(s) and go to reconciliation. """ if any(not a.raw for a in attachments): raise UserError(_("You uploaded an invalid or empty file.")) statement_ids_all = [] notifications_all = {} errors = {} # Let the appropriate implementation module parse the file and return the required data # The active_id is passed in context in case an implementation module requires information about the wizard state (see QIF) for attachment in attachments: try: currency_code, account_number, stmts_vals = self._parse_bank_statement_file(attachment) # Check raw data self._check_parsed_data(stmts_vals, account_number) # Try to find the currency and journal in odoo journal = self._find_additional_data(currency_code, account_number) # If no journal found, ask the user about creating one if not journal.default_account_id: raise UserError(_('You have to set a Default Account for the journal: %s', journal.name)) # Prepare statement data to be used for bank statements creation stmts_vals = self._complete_bank_statement_vals(stmts_vals, journal, account_number, attachment) # Create the bank statements statement_ids, dummy, notifications = self._create_bank_statements(stmts_vals) statement_ids_all.extend(statement_ids) # Now that the import worked out, set it as the bank_statements_source of the journal if journal.bank_statements_source != 'file_import': # Use sudo() because only 'account.group_account_manager' # has write access on 'account.journal', but 'account.group_account_user' # must be able to import bank statement files journal.sudo().bank_statements_source = 'file_import' msg = "" for notif in notifications: msg += ( f"{notif['message']}" ) if notifications: notifications_all[attachment.name] = msg except (UserError, RedirectWarning) as e: errors[attachment.name] = e.args[0] statements = self.env['account.bank.statement'].browse(statement_ids_all) line_to_reconcile = statements.line_ids if line_to_reconcile: # 'limit_time_real_cron' defaults to -1. # Manual fallback applied for non-POSIX systems where this key is disabled (set to None). cron_limit_time = tools.config['limit_time_real_cron'] or -1 limit_time = cron_limit_time if 0 < cron_limit_time < 180 else 180 line_to_reconcile._cron_try_auto_reconcile_statement_lines(limit_time=limit_time) result = self.env['account.bank.statement.line']._action_open_bank_reconciliation_widget( extra_domain=[('statement_id', 'in', statements.ids)], default_context={ 'search_default_not_matched': True, 'default_journal_id': statements[:1].journal_id.id, 'notifications': notifications_all, }, ) if errors: error_msg = _("The following files could not be imported:\n") error_msg += "\n".join([f"- {attachment_name}: {msg}" for attachment_name, msg in errors.items()]) if statements: self.env.cr.commit() # save the correctly uploaded statements to the db before raising the errors raise RedirectWarning(error_msg, result, _('View successfully imported statements')) else: raise UserError(error_msg) return result def _parse_bank_statement_file(self, attachment) -> tuple: """ Each module adding a file support must extends this method. It processes the file if it can, returns super otherwise, resulting in a chain of responsability. This method parses the given file and returns the data required by the bank statement import process, as specified below. rtype: triplet (if a value can't be retrieved, use None) - currency code: string (e.g: 'EUR') The ISO 4217 currency code, case insensitive - account number: string (e.g: 'BE1234567890') The number of the bank account which the statement belongs to - bank statements data: list of dict containing (optional items marked by o) : - 'name': string (e.g: '000000123') - 'date': date (e.g: 2013-06-26) -o 'balance_start': float (e.g: 8368.56) -o 'balance_end_real': float (e.g: 8888.88) - 'transactions': list of dict containing : - 'name': string (e.g: 'KBC-INVESTERINGSKREDIET 787-5562831-01') - 'date': date - 'amount': float - 'unique_import_id': string -o 'account_number': string Will be used to find/create the res.partner.bank in odoo -o 'note': string -o 'partner_name': string -o 'ref': string """ raise RedirectWarning( message=_("Could not make sense of the given file.\nDid you install the module to support this type of file?"), action=self.env.ref('base.open_module_tree').id, button_text=_("Go to Apps"), additional_context={ 'search_default_name': 'account_bank_statement_import', 'search_default_extra': True, }, ) def _check_parsed_data(self, stmts_vals, account_number): """ Basic and structural verifications """ extra_msg = _('If it contains transactions for more than one account, it must be imported on each of them.') if len(stmts_vals) == 0: raise UserError( _('This file doesn\'t contain any statement for account %s.', account_number) + '\n' + extra_msg ) no_st_line = True for vals in stmts_vals: if vals['transactions'] and len(vals['transactions']) > 0: no_st_line = False break if no_st_line: raise UserError( _('This file doesn\'t contain any transaction for account %s.', account_number) + '\n' + extra_msg ) def _statement_import_check_bank_account(self, account_number): # Needed for CH to accommodate for non-unique account numbers sanitized_acc_number = self.bank_account_id.sanitized_acc_number.split(" ")[0] # Needed for BNP France if len(sanitized_acc_number) == 27 and len(account_number) == 11 and sanitized_acc_number[:2].upper() == "FR": return sanitized_acc_number[14:-2] == account_number # Needed for Credit Lyonnais (LCL) if len(sanitized_acc_number) == 27 and len(account_number) == 7 and sanitized_acc_number[:2].upper() == "FR": return sanitized_acc_number[18:-2] == account_number return sanitized_acc_number == account_number def _find_additional_data(self, currency_code, account_number): """ Look for the account.journal using values extracted from the statement and make sure it's consistent. """ company_currency = self.env.company.currency_id currency = None sanitized_account_number = sanitize_account_number(account_number) if currency_code: currency = self.env['res.currency'].search([('name', '=ilike', currency_code)], limit=1) if not currency: raise UserError(_("No currency found matching '%s'.", currency_code)) if currency == company_currency: currency = False journal = self if account_number: # No bank account on the journal : create one from the account number of the statement if journal and not journal.bank_account_id: journal.set_bank_account(account_number) # No journal passed to the wizard : try to find one using the account number of the statement elif not journal: journal = self.search([('bank_account_id.sanitized_acc_number', '=', sanitized_account_number)]) if not journal: # Sometimes the bank returns only part of the full account number (e.g. local account number instead of full IBAN) partial_match = self.search([('bank_account_id.sanitized_acc_number', 'ilike', sanitized_account_number)]) if len(partial_match) == 1: journal = partial_match # Already a bank account on the journal : check it's the same as on the statement else: if not self._statement_import_check_bank_account(sanitized_account_number): raise UserError(_('The account of this statement (%s) is not the same as the journal (%s).', account_number, journal.bank_account_id.acc_number)) # If importing into an existing journal, its currency must be the same as the bank statement if journal: journal_currency = journal.currency_id or journal.company_id.currency_id if currency is None: currency = journal_currency if currency and currency != journal_currency: statement_cur_code = not currency and company_currency.name or currency.name journal_cur_code = not journal_currency and company_currency.name or journal_currency.name raise UserError(_('The currency of the bank statement (%s) is not the same as the currency of the journal (%s).', statement_cur_code, journal_cur_code)) if not journal: raise UserError(_('Cannot find in which journal import this statement. Please manually select a journal.')) return journal def _complete_bank_statement_vals(self, stmts_vals, journal, account_number, attachment): for st_vals in stmts_vals: if not st_vals.get('reference'): st_vals['reference'] = attachment.name for line_vals in st_vals['transactions']: line_vals['journal_id'] = journal.id unique_import_id = line_vals.get('unique_import_id') if unique_import_id: sanitized_account_number = sanitize_account_number(account_number) line_vals['unique_import_id'] = (sanitized_account_number and sanitized_account_number + '-' or '') + str(journal.id) + '-' + unique_import_id if not line_vals.get('partner_bank_id'): # Find the partner and his bank account or create the bank account. The partner selected during the # reconciliation process will be linked to the bank when the statement is closed. identifying_string = line_vals.get('account_number') if identifying_string: if line_vals.get('partner_id'): partner_bank = self.env['res.partner.bank'].search([ ('acc_number', '=', identifying_string), ('partner_id', '=', line_vals['partner_id']) ]) else: partner_bank = self.env['res.partner.bank'].search([ ('acc_number', '=', identifying_string), ('company_id', 'in', (False, journal.company_id.id)) ]) # If multiple partners share the same account number, do not try to guess and just avoid setting it if partner_bank and len(partner_bank) == 1: line_vals['partner_bank_id'] = partner_bank.id line_vals['partner_id'] = partner_bank.partner_id.id return stmts_vals def _create_bank_statements(self, stmts_vals, raise_no_imported_file=True): """ Create new bank statements from imported values, filtering out already imported transactions, and returns data used by the reconciliation widget """ BankStatement = self.env['account.bank.statement'] BankStatementLine = self.env['account.bank.statement.line'] # Filter out already imported transactions and create statements statement_ids = [] statement_line_ids = [] ignored_statement_lines_import_ids = [] for st_vals in stmts_vals: filtered_st_lines = [] for line_vals in st_vals['transactions']: if (line_vals['amount'] != 0 and ('unique_import_id' not in line_vals or not line_vals['unique_import_id'] or not bool(BankStatementLine.sudo().search([('unique_import_id', '=', line_vals['unique_import_id'])], limit=1)))): filtered_st_lines.append(line_vals) else: ignored_statement_lines_import_ids.append(line_vals['unique_import_id']) if st_vals.get('balance_start') is not None: st_vals['balance_start'] += float(line_vals['amount']) if len(filtered_st_lines) > 0: # Remove values that won't be used to create records st_vals.pop('transactions', None) # Create the statement st_vals['line_ids'] = [[0, False, line] for line in filtered_st_lines] statement = BankStatement.with_context(default_journal_id=self.id).create(st_vals) if not statement.name: statement.name = st_vals['reference'] statement_ids.append(statement.id) statement_line_ids.extend(statement.line_ids.ids) # Create the report. if statement.is_complete and not self._context.get('skip_pdf_attachment_generation'): statement.action_generate_attachment() if len(statement_line_ids) == 0 and raise_no_imported_file: raise UserError(_('You already have imported that file.')) # Prepare import feedback notifications = [] num_ignored = len(ignored_statement_lines_import_ids) if num_ignored > 0: notifications += [{ 'type': 'warning', 'message': _("%d transactions had already been imported and were ignored.", num_ignored) if num_ignored > 1 else _("1 transaction had already been imported and was ignored."), }] return statement_ids, statement_line_ids, notifications