william-andre
d8d47f9ff8
TLDR:
* invoices are implemented using computed methods instead of onchange
* the synchronization only happens when switching tabs in the Form view
to improve perfs.
_______________________________________________________________________
The whole engine of the synchronization of Invoices to the Journal
Entries has been refactored
* by using computed fields instead of onchange functions
* by synchronizing only from invoice to journal entry in `create` and
`write`
* by saving when switching tabs on the Invoice form, to synchronize
before showing the values
This comes with numerous advantages:
* no need to call the onchange methods manually
* no need to use the Form emulator to build invoices (i.e. EDI, OCR,
intercompany, ...)
* the performance for invoices with many lines improves drastically, going
from 2 minutes to 4 seconds to create an invoice with 500 lines
* the model is more declarative, we can now see how the values are computed
instead of having the values being copied from various places.
* remove the hack in `onchange` that disabled the recursivity of it,
which was unexpected and needed to be managed manually in all the
onchange methods
This means that:
* Some fields need to be exclusively computed on journal entries values
or invoice values, more specifically the Tax Summary widget.
It is now
- computed from entry lines, when opening the view
- computed from invoice lines when changing those, because the tax lines
will need to be recomputed anyways, erasing previously set values
- set with an inverse function when saving; after the sync has been done
* Some possible operations previously possible have been dropped.
(i.e. look at the removed test test_in_invoice_line_onchange_accounting_fields_1)
This is because such a behavior was undefined (how is changing the balance going
to affect the unit price? How is the amount currency going to affect it?)
_______________________________________________________________________
Implementation Details
----------------------
The "dynamic lines", meaning the payment terms and the tax lines are now
only created in the `create` and `write` functions.
In order to reduce code duplication, it has been implemented using
context managers used in both `account.move` and `account.move.line`
These context managers help comparing the values before/after, acting
like a local `onchange`, but getting benefit from the dirty flags from
the `compute` dependences.
This is relying on computed fields on the move (`needed_terms`) and on
the lines (`compute_all_tax`) which contain the values needed for the
related move.
Depending on the needed values and the existing values (`term_key` and
`tax_key`, respectively) the context manager will determine what needs
to be created/updated/deleted.
Some related changes are to produce a `dict` instead of a `str` for the
`tax_totals` (previously `tax_totals_json`) fields, by simplicity to
reduce the complexity of IO, and simplicity of debugging, because the
logic of the field needed to change (cannot be computed at the same time
anymore since it needed the lines to be synced)
By simplicity, and also because it makes more sense, some boolean fields
have been merged into `display_type`:
* `is_rounding_line`
* `exclude_from_invoice_tab`
* `is_anglo_saxon_line`
The `price_unit`, `quantity` and other "invoice fields" are now not set
anymore on lines that are not product lines since it didn't make any
sense to have it.
Performances
------------
You have to keep in mind that a simple `create` didn't compute a lot of
fields, for instance not taxes were set, no payment terms,...
Now it does.
```python
import random
from timeit import timeit
from odoo import Command
domain = [('company_id', 'in', (False, self.env.company.id))]
products = self.env['product.product'].search(domain).ids
partners = self.env['res.partner'].search(domain).ids
taxes = self.env['account.tax'].search(domain).ids
def create(nmove, nline):
self.env['account.move'].create([
{
'move_type': 'out_invoice',
'partner_id': random.choice(partners),
'invoice_line_ids': [
Command.create({
'name': f'line{i}',
'product_id': random.choice(products),
'tax_ids': [Command.set([random.choice(taxes)])],
})
for i in range(nline)
]
}
for j in range(nmove)
])
# After | Before
print(timeit("create(1, 1)", globals=globals(), number=1)) # 0.11 | 0.09
print(timeit("create(100, 1)", globals=globals(), number=1)) # 2.76 | 2.50
print(timeit("create(500, 1)", globals=globals(), number=1)) # 14.56 | 12.34
print(timeit("create(1, 100)", globals=globals(), number=1)) # 1.03 | 5.52
print(timeit("create(1, 500)", globals=globals(), number=1)) # 3.99 | 125.02
print(timeit("create(50, 50)", globals=globals(), number=1)) # 19.44 | 79.55
```
Another metric that can be used is running the test suite with
`--test-tags=/account` (only `account` installed)
* before: 404s, 267127 queries (366 tests)
* after: 318s, 232125 queries (362 tests)
Why this commit title?
----------------------
Someone told me that this was the perfect way of naming your commits.
c04065abd8
task-2711317
closes odoo/odoo#96134
Related: odoo/upgrade#3715
Related: odoo/enterprise#29758
Signed-off-by: Laurent Smet <las@odoo.com>
714 lines
36 KiB
Python
714 lines
36 KiB
Python
# -*- coding: utf-8 -*-
|
|
# Part of Odoo. See LICENSE file for full copyright and licensing details.
|
|
|
|
from collections import defaultdict
|
|
|
|
from odoo import api, fields, models, _
|
|
from odoo.exceptions import UserError
|
|
|
|
|
|
class AccountMove(models.Model):
|
|
_inherit = 'account.move'
|
|
|
|
edi_document_ids = fields.One2many(
|
|
comodel_name='account.edi.document',
|
|
inverse_name='move_id')
|
|
edi_state = fields.Selection(
|
|
selection=[('to_send', 'To Send'), ('sent', 'Sent'), ('to_cancel', 'To Cancel'), ('cancelled', 'Cancelled')],
|
|
string="Electronic invoicing",
|
|
store=True,
|
|
compute='_compute_edi_state',
|
|
help='The aggregated state of all the EDIs with web-service of this move')
|
|
edi_error_count = fields.Integer(
|
|
compute='_compute_edi_error_count',
|
|
help='How many EDIs are in error for this move ?')
|
|
edi_blocking_level = fields.Selection(
|
|
selection=[('info', 'Info'), ('warning', 'Warning'), ('error', 'Error')],
|
|
compute='_compute_edi_error_message')
|
|
edi_error_message = fields.Html(
|
|
compute='_compute_edi_error_message')
|
|
# Technical field to display the documents that will be processed by the CRON
|
|
edi_web_services_to_process = fields.Text(
|
|
compute='_compute_edi_web_services_to_process')
|
|
edi_show_cancel_button = fields.Boolean(
|
|
compute='_compute_edi_show_cancel_button')
|
|
edi_show_abandon_cancel_button = fields.Boolean(
|
|
compute='_compute_edi_show_abandon_cancel_button')
|
|
|
|
@api.depends('edi_document_ids.state')
|
|
def _compute_edi_state(self):
|
|
for move in self:
|
|
all_states = set(move.edi_document_ids.filtered(lambda d: d.edi_format_id._needs_web_services()).mapped('state'))
|
|
if all_states == {'sent'}:
|
|
move.edi_state = 'sent'
|
|
elif all_states == {'cancelled'}:
|
|
move.edi_state = 'cancelled'
|
|
elif 'to_send' in all_states:
|
|
move.edi_state = 'to_send'
|
|
elif 'to_cancel' in all_states:
|
|
move.edi_state = 'to_cancel'
|
|
else:
|
|
move.edi_state = False
|
|
|
|
@api.depends('edi_document_ids.error')
|
|
def _compute_edi_error_count(self):
|
|
for move in self:
|
|
move.edi_error_count = len(move.edi_document_ids.filtered(lambda d: d.error))
|
|
|
|
@api.depends('edi_error_count', 'edi_document_ids.error', 'edi_document_ids.blocking_level')
|
|
def _compute_edi_error_message(self):
|
|
for move in self:
|
|
if move.edi_error_count == 0:
|
|
move.edi_error_message = None
|
|
move.edi_blocking_level = None
|
|
elif move.edi_error_count == 1:
|
|
error_doc = move.edi_document_ids.filtered(lambda d: d.error)
|
|
move.edi_error_message = error_doc.error
|
|
move.edi_blocking_level = error_doc.blocking_level
|
|
else:
|
|
error_levels = set([doc.blocking_level for doc in move.edi_document_ids])
|
|
if 'error' in error_levels:
|
|
move.edi_error_message = str(move.edi_error_count) + _(" Electronic invoicing error(s)")
|
|
move.edi_blocking_level = 'error'
|
|
elif 'warning' in error_levels:
|
|
move.edi_error_message = str(move.edi_error_count) + _(" Electronic invoicing warning(s)")
|
|
move.edi_blocking_level = 'warning'
|
|
else:
|
|
move.edi_error_message = str(move.edi_error_count) + _(" Electronic invoicing info(s)")
|
|
move.edi_blocking_level = 'info'
|
|
|
|
@api.depends(
|
|
'edi_document_ids',
|
|
'edi_document_ids.state',
|
|
'edi_document_ids.blocking_level',
|
|
'edi_document_ids.edi_format_id',
|
|
'edi_document_ids.edi_format_id.name')
|
|
def _compute_edi_web_services_to_process(self):
|
|
for move in self:
|
|
to_process = move.edi_document_ids.filtered(lambda d: d.state in ['to_send', 'to_cancel'] and d.blocking_level != 'error')
|
|
format_web_services = to_process.edi_format_id.filtered(lambda f: f._needs_web_services())
|
|
move.edi_web_services_to_process = ', '.join(f.name for f in format_web_services)
|
|
|
|
@api.depends(
|
|
'state',
|
|
'edi_document_ids.state')
|
|
def _compute_show_reset_to_draft_button(self):
|
|
# OVERRIDE
|
|
super()._compute_show_reset_to_draft_button()
|
|
|
|
for move in self:
|
|
for doc in move.edi_document_ids:
|
|
if doc.edi_format_id._needs_web_services() \
|
|
and doc.state in ('sent', 'to_cancel') \
|
|
and move.is_invoice(include_receipts=True) \
|
|
and doc.edi_format_id._is_required_for_invoice(move):
|
|
move.show_reset_to_draft_button = False
|
|
break
|
|
|
|
@api.depends(
|
|
'state',
|
|
'edi_document_ids.state')
|
|
def _compute_edi_show_cancel_button(self):
|
|
for move in self:
|
|
if move.state != 'posted':
|
|
move.edi_show_cancel_button = False
|
|
continue
|
|
|
|
move.edi_show_cancel_button = any([doc.edi_format_id._needs_web_services()
|
|
and doc.state == 'sent'
|
|
and move.is_invoice(include_receipts=True)
|
|
and doc.edi_format_id._is_required_for_invoice(move)
|
|
for doc in move.edi_document_ids])
|
|
|
|
@api.depends(
|
|
'state',
|
|
'edi_document_ids.state')
|
|
def _compute_edi_show_abandon_cancel_button(self):
|
|
for move in self:
|
|
move.edi_show_abandon_cancel_button = any(doc.edi_format_id._needs_web_services()
|
|
and doc.state == 'to_cancel'
|
|
and move.is_invoice(include_receipts=True)
|
|
and doc.edi_format_id._is_required_for_invoice(move)
|
|
for doc in move.edi_document_ids)
|
|
|
|
####################################################
|
|
# Export Electronic Document
|
|
####################################################
|
|
|
|
@api.model
|
|
def _add_edi_tax_values(self, results, grouping_key, serialized_grouping_key, tax_values, key_by_tax=None):
|
|
# Add to global results.
|
|
results['tax_amount'] += tax_values['tax_amount']
|
|
results['tax_amount_currency'] += tax_values['tax_amount_currency']
|
|
# Add to tax details.
|
|
if serialized_grouping_key not in results['tax_details']:
|
|
tax_details = results['tax_details'][serialized_grouping_key]
|
|
tax_details.update(grouping_key)
|
|
tax_details.update({
|
|
'base_amount': tax_values['base_amount'],
|
|
'base_amount_currency': tax_values['base_amount_currency'],
|
|
})
|
|
else:
|
|
tax_details = results['tax_details'][serialized_grouping_key]
|
|
if key_by_tax:
|
|
add_to_base_amount = key_by_tax[tax_values['tax_id']] != key_by_tax.get(tax_values['src_line_id'].tax_line_id)
|
|
else:
|
|
add_to_base_amount = tax_values['base_line_id'] not in set(x['base_line_id'] for x in tax_details['group_tax_details'])
|
|
if add_to_base_amount:
|
|
tax_details['base_amount'] += tax_values['base_amount']
|
|
tax_details['base_amount_currency'] += tax_values['base_amount_currency']
|
|
tax_details['tax_amount'] += tax_values['tax_amount']
|
|
tax_details['tax_amount_currency'] += tax_values['tax_amount_currency']
|
|
tax_details['group_tax_details'].append(tax_values)
|
|
|
|
def _prepare_edi_tax_details(self, filter_to_apply=None, filter_invl_to_apply=None, grouping_key_generator=None, compute_mode='tax_details'):
|
|
''' Compute amounts related to taxes for the current invoice.
|
|
|
|
:param filter_to_apply: Optional filter to exclude some tax values from the final results.
|
|
The filter is defined as a method getting a dictionary as parameter
|
|
representing the tax values for a single repartition line.
|
|
This dictionary contains:
|
|
|
|
'base_line_id': An account.move.line record.
|
|
'tax_id': An account.tax record.
|
|
'tax_repartition_line_id': An account.tax.repartition.line record.
|
|
'base_amount': The tax base amount expressed in company currency.
|
|
'tax_amount': The tax amount expressed in company currency.
|
|
'base_amount_currency': The tax base amount expressed in foreign currency.
|
|
'tax_amount_currency': The tax amount expressed in foreign currency.
|
|
|
|
If the filter is returning False, it means the current tax values will be
|
|
ignored when computing the final results.
|
|
|
|
:param filter_invl_to_apply: Optional filter to exclude some invoice lines.
|
|
|
|
:param grouping_key_generator: Optional method used to group tax values together. By default, the tax values
|
|
are grouped by tax. This parameter is a method getting a dictionary as parameter
|
|
(same signature as 'filter_to_apply').
|
|
|
|
This method must returns a dictionary where values will be used to create the
|
|
grouping_key to aggregate tax values together. The returned dictionary is added
|
|
to each tax details in order to retrieve the full grouping_key later.
|
|
|
|
:param compute_mode: Optional parameter to specify the method used to allocate the tax line amounts
|
|
among the invoice lines:
|
|
'tax_details' (the default) uses the AccountMove._get_query_tax_details method.
|
|
'compute_all' uses the AccountTax._compute_all method.
|
|
|
|
The 'tax_details' method takes the tax line balance and allocates it among the
|
|
invoice lines to which that tax applies, proportionately to the invoice lines'
|
|
base amounts. This always ensures that the sum of the tax amounts equals the
|
|
tax line's balance, which, depending on the constraints of a particular
|
|
localization, can be more appropriate when 'Round Globally' is set.
|
|
|
|
The 'compute_all' method returns, for each invoice line, the exact tax amounts
|
|
corresponding to the taxes applied to the invoice line. Depending on the
|
|
constraints of the particular localization, this can be more appropriate when
|
|
'Round per Line' is set.
|
|
|
|
:return: The full tax details for the current invoice and for each invoice line
|
|
separately. The returned dictionary is the following:
|
|
|
|
'base_amount': The total tax base amount in company currency for the whole invoice.
|
|
'tax_amount': The total tax amount in company currency for the whole invoice.
|
|
'base_amount_currency': The total tax base amount in foreign currency for the whole invoice.
|
|
'tax_amount_currency': The total tax amount in foreign currency for the whole invoice.
|
|
'tax_details': A mapping of each grouping key (see 'grouping_key_generator') to a dictionary
|
|
containing:
|
|
|
|
'base_amount': The tax base amount in company currency for the current group.
|
|
'tax_amount': The tax amount in company currency for the current group.
|
|
'base_amount_currency': The tax base amount in foreign currency for the current group.
|
|
'tax_amount_currency': The tax amount in foreign currency for the current group.
|
|
'group_tax_details': The list of all tax values aggregated into this group.
|
|
|
|
'invoice_line_tax_details': A mapping of each invoice line to a dictionary containing:
|
|
|
|
'base_amount': The total tax base amount in company currency for the whole invoice line.
|
|
'tax_amount': The total tax amount in company currency for the whole invoice line.
|
|
'base_amount_currency': The total tax base amount in foreign currency for the whole invoice line.
|
|
'tax_amount_currency': The total tax amount in foreign currency for the whole invoice line.
|
|
'tax_details': A mapping of each grouping key (see 'grouping_key_generator') to a dictionary
|
|
containing:
|
|
|
|
'base_amount': The tax base amount in company currency for the current group.
|
|
'tax_amount': The tax amount in company currency for the current group.
|
|
'base_amount_currency': The tax base amount in foreign currency for the current group.
|
|
'tax_amount_currency': The tax amount in foreign currency for the current group.
|
|
'group_tax_details': The list of all tax values aggregated into this group.
|
|
|
|
'''
|
|
self.ensure_one()
|
|
|
|
def _serialize_python_dictionary(vals):
|
|
return '-'.join(str(vals[k]) for k in sorted(vals.keys()))
|
|
|
|
def default_grouping_key_generator(tax_values):
|
|
return {'tax': tax_values['tax_id']}
|
|
|
|
def compute_invoice_lines_tax_values_dict_from_tax_details(invoice_lines):
|
|
invoice_lines_tax_values_dict = defaultdict(list)
|
|
tax_details_query, tax_details_params = invoice_lines._get_query_tax_details_from_domain([('move_id', '=', self.id)])
|
|
self._cr.execute(tax_details_query, tax_details_params)
|
|
for row in self._cr.dictfetchall():
|
|
invoice_line = invoice_lines.browse(row['base_line_id'])
|
|
tax_line = invoice_lines.browse(row['tax_line_id'])
|
|
src_line = invoice_lines.browse(row['src_line_id'])
|
|
tax = self.env['account.tax'].browse(row['tax_id'])
|
|
src_tax = self.env['account.tax'].browse(row['group_tax_id']) if row['group_tax_id'] else tax
|
|
|
|
invoice_lines_tax_values_dict[invoice_line].append({
|
|
'base_line_id': invoice_line,
|
|
'tax_line_id': tax_line,
|
|
'src_line_id': src_line,
|
|
'tax_id': tax,
|
|
'src_tax_id': src_tax,
|
|
'tax_repartition_line_id': tax_line.tax_repartition_line_id,
|
|
'base_amount': row['base_amount'],
|
|
'tax_amount': row['tax_amount'],
|
|
'base_amount_currency': row['base_amount_currency'],
|
|
'tax_amount_currency': row['tax_amount_currency'],
|
|
})
|
|
return invoice_lines_tax_values_dict
|
|
|
|
def compute_invoice_lines_tax_values_dict_from_compute_all(invoice_lines):
|
|
invoice_lines_tax_values_dict = {}
|
|
sign = -1 if self.is_inbound() else 1
|
|
for invoice_line in invoice_lines:
|
|
taxes_res = invoice_line.tax_ids.compute_all(
|
|
invoice_line.price_unit * (1 - (invoice_line.discount / 100.0)),
|
|
currency=invoice_line.currency_id,
|
|
quantity=invoice_line.quantity,
|
|
product=invoice_line.product_id,
|
|
partner=invoice_line.partner_id,
|
|
is_refund=invoice_line.move_id.move_type in ('in_refund', 'out_refund'),
|
|
)
|
|
invoice_lines_tax_values_dict[invoice_line] = []
|
|
rate = abs(invoice_line.balance) / abs(invoice_line.amount_currency) if invoice_line.amount_currency else 0.0
|
|
for tax_res in taxes_res['taxes']:
|
|
invoice_lines_tax_values_dict[invoice_line].append({
|
|
'base_line_id': invoice_line,
|
|
'tax_id': self.env['account.tax'].browse(tax_res['id']),
|
|
'tax_repartition_line_id': self.env['account.tax.repartition.line'].browse(tax_res['tax_repartition_line_id']),
|
|
'base_amount': sign * invoice_line.company_currency_id.round(tax_res['base'] * rate),
|
|
'tax_amount': sign * invoice_line.company_currency_id.round(tax_res['amount'] * rate),
|
|
'base_amount_currency': sign * tax_res['base'],
|
|
'tax_amount_currency': sign * tax_res['amount'],
|
|
})
|
|
return invoice_lines_tax_values_dict
|
|
|
|
# Compute the taxes values for each invoice line.
|
|
invoice_lines = self.invoice_line_ids.filtered(lambda line: line.display_type == 'product')
|
|
if filter_invl_to_apply:
|
|
invoice_lines = invoice_lines.filtered(filter_invl_to_apply)
|
|
|
|
if compute_mode == 'compute_all':
|
|
invoice_lines_tax_values_dict = compute_invoice_lines_tax_values_dict_from_compute_all(invoice_lines)
|
|
else:
|
|
invoice_lines_tax_values_dict = compute_invoice_lines_tax_values_dict_from_tax_details(invoice_lines)
|
|
|
|
grouping_key_generator = grouping_key_generator or default_grouping_key_generator
|
|
|
|
# Apply 'filter_to_apply'.
|
|
|
|
if self.move_type in ('out_refund', 'in_refund'):
|
|
tax_rep_lines_field = 'refund_repartition_line_ids'
|
|
else:
|
|
tax_rep_lines_field = 'invoice_repartition_line_ids'
|
|
|
|
filtered_invoice_lines_tax_values_dict = {}
|
|
for invoice_line in invoice_lines:
|
|
tax_values_list = invoice_lines_tax_values_dict.get(invoice_line, [])
|
|
filtered_invoice_lines_tax_values_dict[invoice_line] = []
|
|
|
|
# Search for unhandled taxes.
|
|
taxes_set = set(invoice_line.tax_ids.flatten_taxes_hierarchy())
|
|
for tax_values in tax_values_list:
|
|
taxes_set.discard(tax_values['tax_id'])
|
|
|
|
if not filter_to_apply or filter_to_apply(tax_values):
|
|
filtered_invoice_lines_tax_values_dict[invoice_line].append(tax_values)
|
|
|
|
# Restore zero-tax tax details.
|
|
for zero_tax in taxes_set:
|
|
|
|
affect_base_amount = 0.0
|
|
affect_base_amount_currency = 0.0
|
|
for tax_values in tax_values_list:
|
|
if zero_tax in tax_values['tax_line_id'].tax_ids:
|
|
affect_base_amount += tax_values['tax_amount']
|
|
affect_base_amount_currency += tax_values['tax_amount_currency']
|
|
|
|
for tax_rep in zero_tax[tax_rep_lines_field].filtered(lambda x: x.repartition_type == 'tax'):
|
|
tax_values = {
|
|
'base_line_id': invoice_line,
|
|
'tax_line_id': self.env['account.move.line'],
|
|
'src_line_id': invoice_line,
|
|
'tax_id': zero_tax,
|
|
'src_tax_id': zero_tax,
|
|
'tax_repartition_line_id': tax_rep,
|
|
'base_amount': invoice_line.balance + affect_base_amount,
|
|
'tax_amount': 0.0,
|
|
'base_amount_currency': invoice_line.amount_currency + affect_base_amount_currency,
|
|
'tax_amount_currency': 0.0,
|
|
}
|
|
|
|
if not filter_to_apply or filter_to_apply(tax_values):
|
|
filtered_invoice_lines_tax_values_dict[invoice_line].append(tax_values)
|
|
|
|
# Initialize the results dict.
|
|
|
|
invoice_global_tax_details = {
|
|
'base_amount': 0.0,
|
|
'tax_amount': 0.0,
|
|
'base_amount_currency': 0.0,
|
|
'tax_amount_currency': 0.0,
|
|
'tax_details': defaultdict(lambda: {
|
|
'base_amount': 0.0,
|
|
'tax_amount': 0.0,
|
|
'base_amount_currency': 0.0,
|
|
'tax_amount_currency': 0.0,
|
|
'group_tax_details': [],
|
|
}),
|
|
'invoice_line_tax_details': defaultdict(lambda: {
|
|
'base_amount': 0.0,
|
|
'tax_amount': 0.0,
|
|
'base_amount_currency': 0.0,
|
|
'tax_amount_currency': 0.0,
|
|
'tax_details': defaultdict(lambda: {
|
|
'base_amount': 0.0,
|
|
'tax_amount': 0.0,
|
|
'base_amount_currency': 0.0,
|
|
'tax_amount_currency': 0.0,
|
|
'group_tax_details': [],
|
|
}),
|
|
}),
|
|
}
|
|
|
|
# Apply 'grouping_key_generator' to 'invoice_lines_tax_values_list' and add all values to the final results.
|
|
|
|
for invoice_line in invoice_lines:
|
|
tax_values_list = filtered_invoice_lines_tax_values_dict[invoice_line]
|
|
|
|
key_by_tax = {}
|
|
|
|
# Add to invoice global tax amounts.
|
|
invoice_global_tax_details['base_amount'] += invoice_line.balance
|
|
invoice_global_tax_details['base_amount_currency'] += invoice_line.amount_currency
|
|
|
|
for tax_values in tax_values_list:
|
|
grouping_key = grouping_key_generator(tax_values)
|
|
serialized_grouping_key = _serialize_python_dictionary(grouping_key)
|
|
key_by_tax[tax_values['tax_id']] = serialized_grouping_key
|
|
|
|
# Add to invoice line global tax amounts.
|
|
if serialized_grouping_key not in invoice_global_tax_details['invoice_line_tax_details'][invoice_line]:
|
|
invoice_line_global_tax_details = invoice_global_tax_details['invoice_line_tax_details'][invoice_line]
|
|
invoice_line_global_tax_details.update({
|
|
'base_amount': invoice_line.balance,
|
|
'base_amount_currency': invoice_line.amount_currency,
|
|
})
|
|
else:
|
|
invoice_line_global_tax_details = invoice_global_tax_details['invoice_line_tax_details'][invoice_line]
|
|
|
|
self._add_edi_tax_values(invoice_global_tax_details, grouping_key, serialized_grouping_key, tax_values,
|
|
key_by_tax=key_by_tax if compute_mode == 'tax_details' else None)
|
|
self._add_edi_tax_values(invoice_line_global_tax_details, grouping_key, serialized_grouping_key, tax_values,
|
|
key_by_tax=key_by_tax if compute_mode == 'tax_details' else None)
|
|
|
|
return invoice_global_tax_details
|
|
|
|
def _prepare_edi_vals_to_export(self):
|
|
''' The purpose of this helper is to prepare values in order to export an invoice through the EDI system.
|
|
This includes the computation of the tax details for each invoice line that could be very difficult to
|
|
handle regarding the computation of the base amount.
|
|
|
|
:return: A python dict containing default pre-processed values.
|
|
'''
|
|
self.ensure_one()
|
|
|
|
res = {
|
|
'record': self,
|
|
'balance_multiplicator': -1 if self.is_inbound() else 1,
|
|
'invoice_line_vals_list': [],
|
|
}
|
|
|
|
# Invoice lines details.
|
|
for index, line in enumerate(self.invoice_line_ids.filtered(lambda line: line.display_type == 'product'), start=1):
|
|
line_vals = line._prepare_edi_vals_to_export()
|
|
line_vals['index'] = index
|
|
res['invoice_line_vals_list'].append(line_vals)
|
|
|
|
# Totals.
|
|
res.update({
|
|
'total_price_subtotal_before_discount': sum(x['price_subtotal_before_discount'] for x in res['invoice_line_vals_list']),
|
|
'total_price_discount': sum(x['price_discount'] for x in res['invoice_line_vals_list']),
|
|
})
|
|
|
|
return res
|
|
|
|
def _update_payments_edi_documents(self):
|
|
''' Update the edi documents linked to the current journal entries. These journal entries must be linked to an
|
|
account.payment of an account.bank.statement.line. This additional method is needed because the payment flow is
|
|
not the same as the invoice one. Indeed, the edi documents must be updated when the reconciliation with some
|
|
invoices is changing.
|
|
'''
|
|
edi_document_vals_list = []
|
|
for payment in self:
|
|
edi_formats = payment._get_reconciled_invoices().journal_id.edi_format_ids + payment.edi_document_ids.edi_format_id
|
|
edi_formats = self.env['account.edi.format'].browse(edi_formats.ids) # Avoid duplicates
|
|
for edi_format in edi_formats:
|
|
existing_edi_document = payment.edi_document_ids.filtered(lambda x: x.edi_format_id == edi_format)
|
|
|
|
if edi_format._is_required_for_payment(payment):
|
|
if existing_edi_document:
|
|
existing_edi_document.write({
|
|
'state': 'to_send',
|
|
'error': False,
|
|
'blocking_level': False,
|
|
})
|
|
else:
|
|
edi_document_vals_list.append({
|
|
'edi_format_id': edi_format.id,
|
|
'move_id': payment.id,
|
|
'state': 'to_send',
|
|
})
|
|
elif existing_edi_document:
|
|
existing_edi_document.write({
|
|
'state': False,
|
|
'error': False,
|
|
'blocking_level': False,
|
|
})
|
|
|
|
self.env['account.edi.document'].create(edi_document_vals_list)
|
|
self.edi_document_ids._process_documents_no_web_services()
|
|
|
|
def _is_ready_to_be_sent(self):
|
|
# OVERRIDE
|
|
# Prevent a mail to be sent to the customer if the EDI document is not sent.
|
|
res = super()._is_ready_to_be_sent()
|
|
|
|
if not res:
|
|
return False
|
|
|
|
edi_documents_to_send = self.edi_document_ids.filtered(lambda x: x.state == 'to_send')
|
|
return not bool(edi_documents_to_send)
|
|
|
|
def _post(self, soft=True):
|
|
# OVERRIDE
|
|
# Set the electronic document to be posted and post immediately for synchronous formats.
|
|
posted = super()._post(soft=soft)
|
|
|
|
edi_document_vals_list = []
|
|
for move in posted:
|
|
for edi_format in move.journal_id.edi_format_ids:
|
|
is_edi_needed = move.is_invoice(include_receipts=False) and edi_format._is_required_for_invoice(move)
|
|
|
|
if is_edi_needed:
|
|
errors = edi_format._check_move_configuration(move)
|
|
if errors:
|
|
raise UserError(_("Invalid invoice configuration:\n\n%s") % '\n'.join(errors))
|
|
|
|
existing_edi_document = move.edi_document_ids.filtered(lambda x: x.edi_format_id == edi_format)
|
|
if existing_edi_document:
|
|
existing_edi_document.write({
|
|
'state': 'to_send',
|
|
'attachment_id': False,
|
|
})
|
|
else:
|
|
edi_document_vals_list.append({
|
|
'edi_format_id': edi_format.id,
|
|
'move_id': move.id,
|
|
'state': 'to_send',
|
|
})
|
|
|
|
self.env['account.edi.document'].create(edi_document_vals_list)
|
|
posted.edi_document_ids._process_documents_no_web_services()
|
|
self.env.ref('account_edi.ir_cron_edi_network')._trigger()
|
|
return posted
|
|
|
|
def button_cancel(self):
|
|
# OVERRIDE
|
|
# Set the electronic document to be canceled and cancel immediately for synchronous formats.
|
|
res = super().button_cancel()
|
|
|
|
self.edi_document_ids.filtered(lambda doc: doc.state != 'sent').write({'state': 'cancelled', 'error': False, 'blocking_level': False})
|
|
self.edi_document_ids.filtered(lambda doc: doc.state == 'sent').write({'state': 'to_cancel', 'error': False, 'blocking_level': False})
|
|
self.edi_document_ids._process_documents_no_web_services()
|
|
self.env.ref('account_edi.ir_cron_edi_network')._trigger()
|
|
|
|
return res
|
|
|
|
def button_draft(self):
|
|
# OVERRIDE
|
|
for move in self:
|
|
if move.edi_show_cancel_button:
|
|
raise UserError(_(
|
|
"You can't edit the following journal entry %s because an electronic document has already been "
|
|
"sent. Please use the 'Request EDI Cancellation' button instead."
|
|
) % move.display_name)
|
|
|
|
res = super().button_draft()
|
|
|
|
self.edi_document_ids.write({'error': False, 'blocking_level': False})
|
|
|
|
return res
|
|
|
|
def button_cancel_posted_moves(self):
|
|
'''Mark the edi.document related to this move to be canceled.
|
|
'''
|
|
to_cancel_documents = self.env['account.edi.document']
|
|
for move in self:
|
|
is_move_marked = False
|
|
for doc in move.edi_document_ids:
|
|
if doc.edi_format_id._needs_web_services() \
|
|
and doc.attachment_id \
|
|
and doc.state == 'sent' \
|
|
and move.is_invoice(include_receipts=True) \
|
|
and doc.edi_format_id._is_required_for_invoice(move):
|
|
to_cancel_documents |= doc
|
|
is_move_marked = True
|
|
if is_move_marked:
|
|
move.message_post(body=_("A cancellation of the EDI has been requested."))
|
|
|
|
to_cancel_documents.write({'state': 'to_cancel', 'error': False, 'blocking_level': False})
|
|
|
|
def button_abandon_cancel_posted_posted_moves(self):
|
|
'''Cancel the request for cancellation of the EDI.
|
|
'''
|
|
documents = self.env['account.edi.document']
|
|
for move in self:
|
|
is_move_marked = False
|
|
for doc in move.edi_document_ids:
|
|
if doc.state == 'to_cancel' \
|
|
and move.is_invoice(include_receipts=True) \
|
|
and doc.edi_format_id._is_required_for_invoice(move):
|
|
documents |= doc
|
|
is_move_marked = True
|
|
if is_move_marked:
|
|
move.message_post(body=_("A request for cancellation of the EDI has been called off."))
|
|
|
|
documents.write({'state': 'sent'})
|
|
|
|
def _get_edi_document(self, edi_format):
|
|
return self.edi_document_ids.filtered(lambda d: d.edi_format_id == edi_format)
|
|
|
|
def _get_edi_attachment(self, edi_format):
|
|
return self._get_edi_document(edi_format).attachment_id
|
|
|
|
####################################################
|
|
# Import Electronic Document
|
|
####################################################
|
|
|
|
def _get_create_document_from_attachment_decoders(self):
|
|
# OVERRIDE
|
|
res = super()._get_create_document_from_attachment_decoders()
|
|
res.append((10, self.env['account.edi.format'].search([])._create_document_from_attachment))
|
|
return res
|
|
|
|
def _get_update_invoice_from_attachment_decoders(self, invoice):
|
|
# OVERRIDE
|
|
res = super()._get_update_invoice_from_attachment_decoders(invoice)
|
|
res.append((10, self.env['account.edi.format'].search([])._update_invoice_from_attachment))
|
|
return res
|
|
|
|
####################################################
|
|
# Business operations
|
|
####################################################
|
|
|
|
def action_process_edi_web_services(self, with_commit=True):
|
|
docs = self.edi_document_ids.filtered(lambda d: d.state in ('to_send', 'to_cancel') and d.blocking_level != 'error')
|
|
docs._process_documents_web_services(with_commit=with_commit)
|
|
|
|
def _retry_edi_documents_error_hook(self):
|
|
''' Hook called when edi_documents are retried. For example, when it's needed to clean a field.
|
|
TO OVERRIDE
|
|
'''
|
|
return
|
|
|
|
def action_retry_edi_documents_error(self):
|
|
self._retry_edi_documents_error_hook()
|
|
self.edi_document_ids.write({'error': False, 'blocking_level': False})
|
|
self.action_process_edi_web_services()
|
|
|
|
|
|
class AccountMoveLine(models.Model):
|
|
_inherit = 'account.move.line'
|
|
|
|
####################################################
|
|
# Export Electronic Document
|
|
####################################################
|
|
|
|
def _prepare_edi_vals_to_export(self):
|
|
''' The purpose of this helper is the same as '_prepare_edi_vals_to_export' but for a single invoice line.
|
|
This includes the computation of the tax details for each invoice line or the management of the discount.
|
|
Indeed, in some EDI, we need to provide extra values depending the discount such as:
|
|
- the discount as an amount instead of a percentage.
|
|
- the price_unit but after subtraction of the discount.
|
|
|
|
:return: A python dict containing default pre-processed values.
|
|
'''
|
|
self.ensure_one()
|
|
|
|
if self.discount == 100.0:
|
|
gross_price_subtotal = self.currency_id.round(self.price_unit * self.quantity)
|
|
else:
|
|
gross_price_subtotal = self.currency_id.round(self.price_subtotal / (1 - self.discount / 100.0))
|
|
|
|
res = {
|
|
'line': self,
|
|
'price_unit_after_discount': self.currency_id.round(self.price_unit * (1 - (self.discount / 100.0))),
|
|
'price_subtotal_before_discount': gross_price_subtotal,
|
|
'price_subtotal_unit': self.currency_id.round(self.price_subtotal / self.quantity) if self.quantity else 0.0,
|
|
'price_total_unit': self.currency_id.round(self.price_total / self.quantity) if self.quantity else 0.0,
|
|
'price_discount': gross_price_subtotal - self.price_subtotal,
|
|
'price_discount_unit': (gross_price_subtotal - self.price_subtotal) / self.quantity if self.quantity else 0.0,
|
|
'gross_price_total_unit': self.currency_id.round(gross_price_subtotal / self.quantity) if self.quantity else 0.0,
|
|
'unece_uom_code': self.product_id.product_tmpl_id.uom_id._get_unece_code(),
|
|
}
|
|
return res
|
|
|
|
def reconcile(self):
|
|
# OVERRIDE
|
|
# In some countries, the payments must be sent to the government under some condition. One of them could be
|
|
# there is at least one reconciled invoice to the payment. Then, we need to update the state of the edi
|
|
# documents during the reconciliation.
|
|
all_lines = self + self.matched_debit_ids.debit_move_id + self.matched_credit_ids.credit_move_id
|
|
payments = all_lines.move_id.filtered(lambda move: move.payment_id or move.statement_line_id)
|
|
|
|
invoices_per_payment_before = {pay: pay._get_reconciled_invoices() for pay in payments}
|
|
res = super().reconcile()
|
|
invoices_per_payment_after = {pay: pay._get_reconciled_invoices() for pay in payments}
|
|
|
|
changed_payments = self.env['account.move']
|
|
for payment, invoices_after in invoices_per_payment_after.items():
|
|
invoices_before = invoices_per_payment_before[payment]
|
|
|
|
if set(invoices_after.ids) != set(invoices_before.ids):
|
|
changed_payments |= payment
|
|
changed_payments._update_payments_edi_documents()
|
|
|
|
return res
|
|
|
|
def remove_move_reconcile(self):
|
|
# OVERRIDE
|
|
# When a payment has been sent to the government, it usually contains some information about reconciled
|
|
# invoices. If the user breaks a reconciliation, the related payments must be cancelled properly and then, a new
|
|
# electronic document must be generated.
|
|
all_lines = self + self.matched_debit_ids.debit_move_id + self.matched_credit_ids.credit_move_id
|
|
payments = all_lines.move_id.filtered(lambda move: move.payment_id or move.statement_line_id)
|
|
|
|
invoices_per_payment_before = {pay: pay._get_reconciled_invoices() for pay in payments}
|
|
res = super().remove_move_reconcile()
|
|
invoices_per_payment_after = {pay: pay._get_reconciled_invoices() for pay in payments}
|
|
|
|
changed_payments = self.env['account.move']
|
|
for payment, invoices_after in invoices_per_payment_after.items():
|
|
invoices_before = invoices_per_payment_before[payment]
|
|
|
|
if set(invoices_after.ids) != set(invoices_before.ids):
|
|
changed_payments |= payment
|
|
changed_payments._update_payments_edi_documents()
|
|
|
|
return res
|