1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788
|
from collections import defaultdict
from lxml import etree
from odoo import _, models, Command
from odoo.tools import html2plaintext, cleanup_xml_node
UBL_NAMESPACES = {
'cbc': "urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2",
'cac': "urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2",
}
class AccountEdiXmlUBL20(models.AbstractModel):
_name = "account.edi.xml.ubl_20"
_inherit = 'account.edi.common'
_description = "UBL 2.0"
def _find_value(self, xpath, tree, nsmap=False):
# EXTENDS account.edi.common
return super()._find_value(xpath, tree, UBL_NAMESPACES)
# -------------------------------------------------------------------------
# EXPORT
# -------------------------------------------------------------------------
def _export_invoice_filename(self, invoice):
return f"{invoice.name.replace('/', '_')}_ubl_20.xml"
def _export_invoice_ecosio_schematrons(self):
return {
'invoice': 'org.oasis-open:invoice:2.0',
'credit_note': 'org.oasis-open:creditnote:2.0',
}
def _get_country_vals(self, country):
return {
'country': country,
'identification_code': country.code,
'name': country.name,
}
def _get_partner_party_identification_vals_list(self, partner):
return []
def _get_partner_address_vals(self, partner):
return {
'street_name': partner.street,
'additional_street_name': partner.street2,
'city_name': partner.city,
'postal_zone': partner.zip,
'country_subentity': partner.state_id.name,
'country_subentity_code': partner.state_id.code,
'country_vals': self._get_country_vals(partner.country_id),
}
def _get_partner_party_tax_scheme_vals_list(self, partner, role):
return [{
'registration_name': partner.name,
'company_id': partner.vat,
'registration_address_vals': self._get_partner_address_vals(partner),
'tax_scheme_vals': {'id': 'VAT'},
}]
def _get_partner_party_legal_entity_vals_list(self, partner):
return [{
'commercial_partner': partner,
'registration_name': partner.name,
'company_id': partner.vat,
'registration_address_vals': self._get_partner_address_vals(partner),
}]
def _get_partner_contact_vals(self, partner):
return {
'id': partner.id,
'name': partner.name,
'telephone': partner.phone or partner.mobile,
'electronic_mail': partner.email,
}
def _get_partner_party_vals(self, partner, role):
return {
'partner': partner,
'party_identification_vals': self._get_partner_party_identification_vals_list(partner.commercial_partner_id),
'party_name_vals': [{'name': partner.display_name}],
'postal_address_vals': self._get_partner_address_vals(partner),
'party_tax_scheme_vals': self._get_partner_party_tax_scheme_vals_list(partner.commercial_partner_id, role),
'party_legal_entity_vals': self._get_partner_party_legal_entity_vals_list(partner.commercial_partner_id),
'contact_vals': self._get_partner_contact_vals(partner),
}
def _get_invoice_period_vals_list(self, invoice):
"""
For now, we cannot fill this data from an invoice
This corresponds to the 'delivery or invoice period'. For UBL Bis 3, in the case of intra-community supply,
the Actual delivery date (BT-72) or the Invoicing period (BG-14) should be present under the form:
{
'start_date': str,
'end_date': str,
}.
"""
return []
def _get_delivery_vals_list(self, invoice):
# the data is optional, except for ubl bis3 (see the override, where we need to set a default delivery address)
return [{
'actual_delivery_date': None,
'delivery_location_vals': {
'delivery_address_vals': self._get_partner_address_vals(invoice.partner_shipping_id),
},
}]
def _get_bank_address_vals(self, bank):
return {
'street_name': bank.street,
'additional_street_name': bank.street2,
'city_name': bank.city,
'postal_zone': bank.zip,
'country_subentity': bank.state.name,
'country_subentity_code': bank.state.code,
'country_vals': self._get_country_vals(bank.country),
}
def _get_financial_institution_vals(self, bank):
return {
'bank': bank,
'id': bank.bic,
'id_attrs': {'schemeID': 'BIC'},
'name': bank.name,
'address_vals': self._get_bank_address_vals(bank),
}
def _get_financial_institution_branch_vals(self, bank):
return {
'bank': bank,
'id': bank.bic,
'id_attrs': {'schemeID': 'BIC'},
'financial_institution_vals': self._get_financial_institution_vals(bank),
}
def _get_financial_account_vals(self, partner_bank):
vals = {
'bank_account': partner_bank,
'id': partner_bank.acc_number.replace(' ', ''),
}
if partner_bank.bank_id:
vals['financial_institution_branch_vals'] = self._get_financial_institution_branch_vals(partner_bank.bank_id)
return vals
def _get_invoice_payment_means_vals_list(self, invoice):
# in Denmark payment code 30 is not allowed. we hardcode it to 1 ("unknown") for now
# as we cannot deduce this information from the invoice
payment_means_code, payment_means_name = 30, 'credit transfer'
if invoice.partner_id.country_code == 'DK':
payment_means_code, payment_means_name = 1, 'unknown'
vals = {
'payment_means_code': payment_means_code,
'payment_means_code_attrs': {'name': payment_means_name},
'payment_due_date': invoice.invoice_date_due or invoice.invoice_date,
'instruction_id': invoice.payment_reference,
'payment_id_vals': [invoice.payment_reference or invoice.name],
}
if invoice.partner_bank_id:
vals['payee_financial_account_vals'] = self._get_financial_account_vals(invoice.partner_bank_id)
return [vals]
def _get_invoice_payment_terms_vals_list(self, invoice):
payment_term = invoice.invoice_payment_term_id
if payment_term:
# The payment term's note is automatically embedded in a <p> tag in Odoo
return [{'note_vals': [{'note': html2plaintext(payment_term.note)}]}]
else:
return []
def _get_invoice_tax_totals_vals_list(self, invoice, taxes_vals):
tax_totals_vals = {
'currency': invoice.currency_id,
'currency_dp': self._get_currency_decimal_places(invoice.currency_id),
'tax_amount': taxes_vals['tax_amount_currency'],
'tax_subtotal_vals': [],
}
epd_tax_to_discount = self._get_early_payment_discount_grouped_by_tax_rate(invoice)
for grouping_key, vals in taxes_vals['tax_details'].items():
if grouping_key['tax_amount_type'] != 'fixed' or not self._context.get('convert_fixed_taxes'):
subtotal = {
'currency': invoice.currency_id,
'currency_dp': self._get_currency_decimal_places(invoice.currency_id),
'taxable_amount': vals['base_amount_currency'],
'tax_amount': vals['tax_amount_currency'],
'percent': vals['_tax_category_vals_']['percent'],
'tax_category_vals': vals['_tax_category_vals_'],
}
if epd_tax_to_discount:
# early payment discounts: need to recompute the tax/taxable amounts
taxable_amount_after_epd = subtotal['taxable_amount'] - epd_tax_to_discount.get(subtotal['percent'], 0)
tax_amount_after_epd = taxable_amount_after_epd * subtotal['tax_category_vals']['percent'] / 100
subtotal.update({
'taxable_amount': taxable_amount_after_epd,
'tax_amount': tax_amount_after_epd,
})
tax_totals_vals['tax_subtotal_vals'].append(subtotal)
if epd_tax_to_discount:
# early payment discounts: hence, need to recompute the total tax amount...
tax_totals_vals['tax_amount'] = sum([subtot['tax_amount'] for subtot in tax_totals_vals['tax_subtotal_vals']])
# ... and add a subtotal section
tax_totals_vals['tax_subtotal_vals'].append({
'currency': invoice.currency_id,
'currency_dp': invoice.currency_id.decimal_places,
'taxable_amount': sum(epd_tax_to_discount.values()),
'tax_amount': 0.0,
'tax_category_vals': {
'id': 'E',
'percent': 0.0,
'tax_scheme_vals': {
'id': "VAT",
},
'tax_exemption_reason': "Exempt from tax",
},
})
return [tax_totals_vals]
def _get_invoice_line_item_vals(self, line, taxes_vals):
""" Method used to fill the cac:InvoiceLine/cac:Item node.
It provides information about what the product you are selling.
:param line: An invoice line.
:param taxes_vals: The tax details for the current invoice line.
:return: A python dictionary.
"""
product = line.product_id
taxes = line.tax_ids.flatten_taxes_hierarchy()
if self._context.get('convert_fixed_taxes'):
taxes = taxes.filtered(lambda t: t.amount_type != 'fixed')
customer = line.move_id.commercial_partner_id
supplier = line.move_id.company_id.partner_id.commercial_partner_id
tax_category_vals_list = self._get_tax_category_list(customer, supplier, taxes)
description = line.name and line.name.replace('\n', ' ')
return {
'description': description,
'name': product.name or description,
'sellers_item_identification_vals': {'id': product.code},
'classified_tax_category_vals': tax_category_vals_list,
}
def _get_document_allowance_charge_vals_list(self, invoice):
"""
https://docs.peppol.eu/poacc/billing/3.0/bis/#_document_level_allowance_or_charge
Usage for early payment discounts:
* Add one document level Allowance per tax rate (VAT included)
* Add one document level Charge (VAT excluded) with amount = the total sum of the early payment discount
The difference between these is the cash discount in case of early payment.
"""
vals_list = []
# Early Payment Discount
epd_tax_to_discount = self._get_early_payment_discount_grouped_by_tax_rate(invoice)
if epd_tax_to_discount:
# One Allowance per tax rate (VAT included)
for tax_amount, discount_amount in epd_tax_to_discount.items():
vals_list.append({
'charge_indicator': 'false',
'allowance_charge_reason_code': '66',
'allowance_charge_reason': _("Conditional cash/payment discount"),
'amount': discount_amount,
'currency_dp': 2,
'currency_name': invoice.currency_id.name,
'tax_category_vals': [{
'id': 'S',
'percent': tax_amount,
'tax_scheme_vals': {'id': 'VAT'},
}],
})
# One global Charge (VAT exempted)
vals_list.append({
'charge_indicator': 'true',
'allowance_charge_reason_code': 'ZZZ',
'allowance_charge_reason': _("Conditional cash/payment discount"),
'amount': sum(epd_tax_to_discount.values()),
'currency_dp': 2,
'currency_name': invoice.currency_id.name,
'tax_category_vals': [{
'id': 'E',
'percent': 0.0,
'tax_scheme_vals': {'id': 'VAT'},
}],
})
return vals_list
def _get_invoice_line_allowance_vals_list(self, line, tax_values_list=None):
""" Method used to fill the cac:{Invoice,CreditNote,DebitNote}Line>cac:AllowanceCharge node.
Allowances are distinguished from charges using the ChargeIndicator node with 'false' as value.
Note that allowance charges do not exist for credit notes in UBL 2.0, so if we apply discount in Odoo
the net price will not be consistent with the unit price, but we cannot do anything about it
:param line: An invoice line.
:return: A list of python dictionaries.
"""
if self._context.get('convert_fixed_taxes'):
fixed_tax_charge_vals_list = []
for grouping_key, tax_details in tax_values_list['tax_details'].items():
if grouping_key['tax_amount_type'] == 'fixed':
fixed_tax_charge_vals_list.append({
'currency_name': line.currency_id.name,
'currency_dp': self._get_currency_decimal_places(line.currency_id),
'charge_indicator': 'true',
'allowance_charge_reason_code': 'AEO',
'allowance_charge_reason': grouping_key['tax_name'],
'amount': tax_details['tax_amount_currency'],
})
if not line.discount:
return fixed_tax_charge_vals_list
# Price subtotal with discount subtracted:
net_price_subtotal = line.price_subtotal
# Price subtotal without discount subtracted:
if line.discount == 100.0:
gross_price_subtotal = 0.0
else:
gross_price_subtotal = line.currency_id.round(net_price_subtotal / (1.0 - (line.discount or 0.0) / 100.0))
allowance_vals = {
'currency_name': line.currency_id.name,
'currency_dp': self._get_currency_decimal_places(line.currency_id),
# Must be 'false' since this method is for allowances.
'charge_indicator': 'false',
# A reason should be provided. In Odoo, we only manage discounts.
# Full code list is available here:
# https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL5189/
'allowance_charge_reason_code': 95,
# The discount should be provided as an amount.
'amount': gross_price_subtotal - net_price_subtotal,
}
return [allowance_vals] + fixed_tax_charge_vals_list
def _get_invoice_line_price_vals(self, line):
""" Method used to fill the cac:InvoiceLine/cac:Price node.
It provides information about the price applied for the goods and services invoiced.
:param line: An invoice line.
:return: A python dictionary.
"""
# Price subtotal without discount:
net_price_subtotal = line.price_subtotal
# Price subtotal with discount:
if line.discount == 100.0:
gross_price_subtotal = 0.0
else:
gross_price_subtotal = net_price_subtotal / (1.0 - (line.discount or 0.0) / 100.0)
# Price subtotal with discount / quantity:
gross_price_unit = gross_price_subtotal / line.quantity if line.quantity else 0.0
uom = super()._get_uom_unece_code(line.product_uom_id)
return {
'currency': line.currency_id,
'currency_dp': self._get_currency_decimal_places(line.currency_id),
# The price of an item, exclusive of VAT, after subtracting item price discount.
'price_amount': round(gross_price_unit, 10),
'product_price_dp': self.env['decimal.precision'].precision_get('Product Price'),
# The number of item units to which the price applies.
# setting to None -> the xml will not comprise the BaseQuantity (it's not mandatory)
'base_quantity': None,
'base_quantity_attrs': {'unitCode': uom},
}
def _get_invoice_line_tax_totals_vals_list(self, line, taxes_vals):
""" Method used to fill the cac:TaxTotal node on a line level.
Uses the same method as the invoice TaxTotal, but can be overridden in other formats.
"""
return self._get_invoice_tax_totals_vals_list(line.move_id, taxes_vals)
def _get_invoice_line_vals(self, line, line_id, taxes_vals):
""" Method used to fill the cac:{Invoice,CreditNote,DebitNote}Line node.
It provides information about the document line.
:param line: A document line.
:return: A python dictionary.
"""
allowance_charge_vals_list = self._get_invoice_line_allowance_vals_list(line, tax_values_list=taxes_vals)
uom = super()._get_uom_unece_code(line.product_uom_id)
total_fixed_tax_amount = sum(
vals['amount']
for vals in allowance_charge_vals_list
if vals.get('charge_indicator') == 'true'
)
return {
'currency': line.currency_id,
'currency_dp': self._get_currency_decimal_places(line.currency_id),
'id': line_id + 1,
'line_quantity': line.quantity,
'line_quantity_attrs': {'unitCode': uom},
'line_extension_amount': line.price_subtotal + total_fixed_tax_amount,
'allowance_charge_vals': allowance_charge_vals_list,
'tax_total_vals': self._get_invoice_line_tax_totals_vals_list(line, taxes_vals),
'item_vals': self._get_invoice_line_item_vals(line, taxes_vals),
'price_vals': self._get_invoice_line_price_vals(line),
}
def _get_invoice_monetary_total_vals(self, invoice, taxes_vals, line_extension_amount, allowance_total_amount, charge_total_amount):
""" Method used to fill the cac:{Legal,Requested}MonetaryTotal node"""
return {
'currency': invoice.currency_id,
'currency_dp': self._get_currency_decimal_places(invoice.currency_id),
'line_extension_amount': line_extension_amount,
'tax_exclusive_amount': taxes_vals['base_amount_currency'],
'tax_inclusive_amount': invoice.amount_total,
'allowance_total_amount': allowance_total_amount or None,
'charge_total_amount': charge_total_amount or None,
'prepaid_amount': invoice.amount_total - invoice.amount_residual,
'payable_amount': invoice.amount_residual,
}
def _apply_invoice_tax_filter(self, base_line, tax_values):
"""
To be overridden to apply a specific tax filter
"""
return True
def _apply_invoice_line_filter(self, invoice_line):
"""
To be overridden to apply a specific invoice line filter
"""
return True
def _get_early_payment_discount_grouped_by_tax_rate(self, invoice):
"""
Get the early payment discounts grouped by the tax rate of the product it is linked to
:returns {float: float}: mapping tax amounts to early payment discount amounts
"""
if invoice.invoice_payment_term_id.early_pay_discount_computation != 'mixed':
return {}
tax_to_discount = defaultdict(lambda: 0)
for line in invoice.line_ids.filtered(lambda l: l.display_type == 'epd'):
for tax in line.tax_ids:
tax_to_discount[tax.amount] += line.amount_currency
return tax_to_discount
def _get_tax_grouping_key(self, base_line, tax_data):
tax = tax_data['tax']
customer = base_line['record'].move_id.commercial_partner_id
supplier = base_line['record'].move_id.company_id.partner_id.commercial_partner_id
tax_category_vals = self._get_tax_category_list(customer, supplier, tax)[0]
grouping_key = {
'tax_category_id': tax_category_vals['id'],
'tax_category_percent': tax_category_vals['percent'],
'_tax_category_vals_': tax_category_vals,
'tax_amount_type': tax.amount_type,
}
# If the tax is fixed, we want to have one group per tax
# s.t. when the invoice is imported, we can try to guess the fixed taxes
if tax.amount_type == 'fixed':
grouping_key['tax_name'] = tax.name
return grouping_key
def _export_invoice_vals(self, invoice):
# Validate the structure of the taxes
self._validate_taxes(invoice.invoice_line_ids.tax_ids)
# Compute the tax details for the whole invoice and each invoice line separately.
taxes_vals = invoice._prepare_invoice_aggregated_taxes(
grouping_key_generator=self._get_tax_grouping_key,
filter_tax_values_to_apply=self._apply_invoice_tax_filter,
filter_invl_to_apply=self._apply_invoice_line_filter,
round_from_tax_lines=True,
)
# Fixed Taxes: filter them on the document level, and adapt the totals
# Fixed taxes are not supposed to be taxes in real live. However, this is the way in Odoo to manage recupel
# taxes in Belgium. Since only one tax is allowed, the fixed tax is removed from totals of lines but added
# as an extra charge/allowance.
if self._context.get('convert_fixed_taxes'):
fixed_taxes_keys = [k for k in taxes_vals['tax_details'] if k['tax_amount_type'] == 'fixed']
for key in fixed_taxes_keys:
fixed_tax_details = taxes_vals['tax_details'].pop(key)
taxes_vals['tax_amount_currency'] -= fixed_tax_details['tax_amount_currency']
taxes_vals['tax_amount'] -= fixed_tax_details['tax_amount']
taxes_vals['base_amount_currency'] += fixed_tax_details['tax_amount_currency']
taxes_vals['base_amount'] += fixed_tax_details['tax_amount']
# Compute values for invoice lines.
line_extension_amount = 0.0
invoice_lines = invoice.invoice_line_ids.filtered(lambda line: line.display_type not in ('line_note', 'line_section') and line._check_edi_line_tax_required())
document_allowance_charge_vals_list = self._get_document_allowance_charge_vals_list(invoice)
invoice_line_vals_list = []
for line_id, line in enumerate(invoice_lines):
line_taxes_vals = taxes_vals['tax_details_per_record'][line]
line_vals = self._get_invoice_line_vals(line, line_id, line_taxes_vals)
invoice_line_vals_list.append(line_vals)
line_extension_amount += line_vals['line_extension_amount']
# Compute the total allowance/charge amounts.
allowance_total_amount = 0.0
charge_total_amount = 0.0
for allowance_charge_vals in document_allowance_charge_vals_list:
if allowance_charge_vals['charge_indicator'] == 'false':
allowance_total_amount += allowance_charge_vals['amount']
else:
charge_total_amount += allowance_charge_vals['amount']
supplier = invoice.company_id.partner_id.commercial_partner_id
customer = invoice.partner_id
# OrderReference/SalesOrderID (sales_order_id) is optional
sales_order_id = 'sale_line_ids' in invoice.invoice_line_ids._fields \
and ",".join(invoice.invoice_line_ids.sale_line_ids.order_id.mapped('name'))
# OrderReference/ID (order_reference) is mandatory inside the OrderReference node !
order_reference = invoice.ref or invoice.name
vals = {
'builder': self,
'invoice': invoice,
'supplier': supplier,
'customer': customer,
'taxes_vals': taxes_vals,
'format_float': self.format_float,
'AddressType_template': 'account_edi_ubl_cii.ubl_20_AddressType',
'ContactType_template': 'account_edi_ubl_cii.ubl_20_ContactType',
'PartyType_template': 'account_edi_ubl_cii.ubl_20_PartyType',
'PaymentMeansType_template': 'account_edi_ubl_cii.ubl_20_PaymentMeansType',
'PaymentTermsType_template': 'account_edi_ubl_cii.ubl_20_PaymentTermsType',
'TaxCategoryType_template': 'account_edi_ubl_cii.ubl_20_TaxCategoryType',
'TaxTotalType_template': 'account_edi_ubl_cii.ubl_20_TaxTotalType',
'AllowanceChargeType_template': 'account_edi_ubl_cii.ubl_20_AllowanceChargeType',
'SignatureType_template': 'account_edi_ubl_cii.ubl_20_SignatureType',
'ResponseType_template': 'account_edi_ubl_cii.ubl_20_ResponseType',
'DeliveryType_template': 'account_edi_ubl_cii.ubl_20_DeliveryType',
'InvoicePeriodType_template': 'account_edi_ubl_cii.ubl_20_InvoicePeriodType',
'MonetaryTotalType_template': 'account_edi_ubl_cii.ubl_20_MonetaryTotalType',
'InvoiceLineType_template': 'account_edi_ubl_cii.ubl_20_InvoiceLineType',
'CreditNoteLineType_template': 'account_edi_ubl_cii.ubl_20_CreditNoteLineType',
'DebitNoteLineType_template': 'account_edi_ubl_cii.ubl_20_DebitNoteLineType',
'InvoiceType_template': 'account_edi_ubl_cii.ubl_20_InvoiceType',
'CreditNoteType_template': 'account_edi_ubl_cii.ubl_20_CreditNoteType',
'DebitNoteType_template': 'account_edi_ubl_cii.ubl_20_DebitNoteType',
'vals': {
'ubl_version_id': 2.0,
'id': invoice.name,
'issue_date': invoice.invoice_date,
'due_date': invoice.invoice_date_due,
'note_vals': self._get_note_vals_list(invoice),
'document_currency_code': invoice.currency_id.name,
'order_reference': order_reference,
'sales_order_id': sales_order_id,
'accounting_supplier_party_vals': {
'party_vals': self._get_partner_party_vals(supplier, role='supplier'),
},
'accounting_customer_party_vals': {
'party_vals': self._get_partner_party_vals(customer, role='customer'),
},
'invoice_period_vals_list': self._get_invoice_period_vals_list(invoice),
'delivery_vals_list': self._get_delivery_vals_list(invoice),
'payment_means_vals_list': self._get_invoice_payment_means_vals_list(invoice),
'payment_terms_vals': self._get_invoice_payment_terms_vals_list(invoice),
# allowances at the document level, the allowances on invoices (eg. discount) are on line_vals
'allowance_charge_vals': document_allowance_charge_vals_list,
'tax_total_vals': self._get_invoice_tax_totals_vals_list(invoice, taxes_vals),
'monetary_total_vals': self._get_invoice_monetary_total_vals(
invoice,
taxes_vals,
line_extension_amount,
allowance_total_amount,
charge_total_amount,
),
'line_vals': invoice_line_vals_list,
'currency_dp': self._get_currency_decimal_places(invoice.currency_id), # currency decimal places
},
}
# Document type specific settings
if 'debit_origin_id' in self.env['account.move']._fields and invoice.debit_origin_id:
vals['document_type'] = 'debit_note'
vals['main_template'] = 'account_edi_ubl_cii.ubl_20_DebitNote'
vals['vals']['document_type_code'] = 383
elif invoice.move_type == 'out_refund':
vals['document_type'] = 'credit_note'
vals['main_template'] = 'account_edi_ubl_cii.ubl_20_CreditNote'
vals['vals']['document_type_code'] = 381
else: # invoice.move_type == 'out_invoice'
vals['document_type'] = 'invoice'
vals['main_template'] = 'account_edi_ubl_cii.ubl_20_Invoice'
vals['vals']['document_type_code'] = 380
return vals
def _get_note_vals_list(self, invoice):
return [{'note': html2plaintext(invoice.narration)}] if invoice.narration else []
def _export_invoice_constraints(self, invoice, vals):
constraints = self._invoice_constraints_common(invoice)
constraints.update({
'ubl20_supplier_name_required': self._check_required_fields(vals['supplier'], 'name'),
'ubl20_customer_name_required': self._check_required_fields(vals['customer'].commercial_partner_id, 'name'),
'ubl20_invoice_name_required': self._check_required_fields(invoice, 'name'),
'ubl20_invoice_date_required': self._check_required_fields(invoice, 'invoice_date'),
})
return constraints
def _export_invoice(self, invoice, convert_fixed_taxes=True):
""" Generates an UBL 2.0 xml for a given invoice.
:param convert_fixed_taxes: whether the fixed taxes are converted into AllowanceCharges on the InvoiceLines
"""
vals = self \
.with_context(convert_fixed_taxes=convert_fixed_taxes) \
._export_invoice_vals(invoice.with_context(lang=invoice.partner_id.lang))
errors = [constraint for constraint in self._export_invoice_constraints(invoice, vals).values() if constraint]
xml_content = self.env['ir.qweb']._render(vals['main_template'], vals)
return etree.tostring(cleanup_xml_node(xml_content), xml_declaration=True, encoding='UTF-8'), set(errors)
def _get_document_type_code_vals(self, invoice, invoice_data):
"""Returns the values used for the `DocumentTypeCode` node"""
# To be overriden by custom format if required
return {'attrs': {}, 'value': None}
# -------------------------------------------------------------------------
# IMPORT
# -------------------------------------------------------------------------
def _import_retrieve_partner_vals(self, tree, role):
""" Returns a dict of values that will be used to retrieve the partner """
return {
'vat': self._find_value(f'.//cac:{role}Party/cac:Party//cbc:CompanyID[string-length(text()) > 5]', tree),
'phone': self._find_value(f'.//cac:{role}Party/cac:Party//cbc:Telephone', tree),
'email': self._find_value(f'.//cac:{role}Party/cac:Party//cbc:ElectronicMail', tree),
'name': self._find_value(f'.//cac:{role}Party/cac:Party//cbc:Name', tree) or
self._find_value(f'.//cac:{role}Party/cac:Party//cbc:RegistrationName', tree),
'country_code': self._find_value(f'.//cac:{role}Party/cac:Party//cac:Country//cbc:IdentificationCode', tree),
}
def _import_fill_invoice(self, invoice, tree, qty_factor):
logs = []
invoice_values = {}
if qty_factor == -1:
logs.append(_("The invoice has been converted into a credit note and the quantities have been reverted."))
role = "AccountingCustomer" if invoice.journal_id.type == 'sale' else "AccountingSupplier"
partner, partner_logs = self._import_partner(invoice.company_id, **self._import_retrieve_partner_vals(tree, role))
# Need to set partner before to compute bank and lines properly
invoice.partner_id = partner.id
invoice_values['currency_id'], currency_logs = self._import_currency(tree, './/{*}DocumentCurrencyCode')
invoice_values['invoice_date'] = tree.findtext('./{*}IssueDate')
invoice_values['invoice_date_due'] = self._find_value(('./cbc:DueDate', './/cbc:PaymentDueDate'), tree)
# ==== partner_bank_id ====
bank_detail_nodes = tree.findall('.//{*}PaymentMeans')
bank_details = [bank_detail_node.findtext('{*}PayeeFinancialAccount/{*}ID') for bank_detail_node in bank_detail_nodes]
if bank_details:
self._import_partner_bank(invoice, bank_details)
# ==== ref, invoice_origin, narration, payment_reference ====
ref = tree.findtext('./{*}ID')
if ref and invoice.is_sale_document(include_receipts=True) and invoice.quick_edit_mode:
invoice_values['name'] = ref
elif ref:
invoice_values['ref'] = ref
invoice_values['invoice_origin'] = tree.findtext('./{*}OrderReference/{*}ID')
invoice_values['narration'] = self._import_description(tree, xpaths=['./{*}Note', './{*}PaymentTerms/{*}Note'])
invoice_values['payment_reference'] = tree.findtext('./{*}PaymentMeans/{*}PaymentID')
# ==== invoice_incoterm_id ====
incoterm_code = tree.findtext('./{*}TransportExecutionTerms/{*}DeliveryTerms/{*}ID')
if incoterm_code:
incoterm = self.env['account.incoterms'].search([('code', '=', incoterm_code)], limit=1)
if incoterm:
invoice_values['invoice_incoterm_id'] = incoterm.id
# ==== Document level AllowanceCharge, Prepaid Amounts, Invoice Lines ====
allowance_charges_line_vals, allowance_charges_logs = self._import_document_allowance_charges(tree, invoice, invoice.journal_id.type, qty_factor)
logs += self._import_prepaid_amount(invoice, tree, './{*}LegalMonetaryTotal/{*}PrepaidAmount', qty_factor)
line_tag = (
'InvoiceLine'
if invoice.move_type in ('in_invoice', 'out_invoice') or qty_factor == -1
else 'CreditNoteLine'
)
invoice_line_vals, line_logs = self._import_invoice_lines(invoice, tree, './{*}' + line_tag, qty_factor)
line_vals = allowance_charges_line_vals + invoice_line_vals
invoice_values = {
**invoice_values,
'invoice_line_ids': [Command.create(line_value) for line_value in line_vals],
}
invoice.write(invoice_values)
logs += partner_logs + currency_logs + line_logs + allowance_charges_logs
return logs
def _get_tax_nodes(self, tree):
tax_nodes = tree.findall('.//{*}Item/{*}ClassifiedTaxCategory/{*}Percent')
if not tax_nodes:
for elem in tree.findall('.//{*}TaxTotal'):
tax_nodes += elem.findall('.//{*}TaxSubtotal/{*}TaxCategory/{*}Percent')
return tax_nodes
def _get_document_allowance_charge_xpaths(self):
return {
'root': './{*}AllowanceCharge',
'charge_indicator': './{*}ChargeIndicator',
'base_amount': './{*}BaseAmount',
'amount': './{*}Amount',
'reason': './{*}AllowanceChargeReason',
'percentage': './{*}MultiplierFactorNumeric',
'tax_percentage': './{*}TaxCategory/{*}Percent',
}
def _get_line_xpaths(self, document_type=False, qty_factor=1):
return {
'basis_qty': './cac:Price/cbc:BaseQuantity',
'gross_price_unit': './{*}Price/{*}AllowanceCharge/{*}BaseAmount',
'rebate': './{*}Price/{*}AllowanceCharge/{*}Amount',
'net_price_unit': './{*}Price/{*}PriceAmount',
'delivered_qty': (
'./{*}InvoicedQuantity'
if document_type and document_type in ('in_invoice', 'out_invoice') or qty_factor == -1
else './{*}CreditedQuantity'
),
'allowance_charge': './/{*}AllowanceCharge',
'allowance_charge_indicator': './{*}ChargeIndicator',
'allowance_charge_amount': './{*}Amount',
'allowance_charge_reason': './{*}AllowanceChargeReason',
'allowance_charge_reason_code': './{*}AllowanceChargeReasonCode',
'line_total_amount': './{*}LineExtensionAmount',
'name': [
'./cac:Item/cbc:Description',
'./cac:Item/cbc:Name',
],
'product': {
'default_code': './cac:Item/cac:SellersItemIdentification/cbc:ID',
'name': './cac:Item/cbc:Name',
'barcode': './cac:Item/cac:StandardItemIdentification/cbc:ID[@schemeID="0160"]',
},
}
def _correct_invoice_tax_amount(self, tree, invoice):
""" The tax total may have been modified for rounding purpose, if so we should use the imported tax and not
the computed one """
# For each tax in our tax total, get the amount as well as the total in the xml.
for elem in tree.findall('.//{*}TaxTotal/{*}TaxSubtotal'):
percentage = elem.find('.//{*}TaxCategory/{*}Percent')
amount = elem.find('.//{*}TaxAmount')
if (percentage is not None and percentage.text is not None) and (amount is not None and amount.text is not None):
tax_percent = float(percentage.text)
# Compare the result with our tax total on the invoice, and apply correction if needed.
# First look for taxes matching the percentage in the xml.
taxes = invoice.line_ids.tax_line_id.filtered(lambda tax: tax.amount == tax_percent)
# If we found taxes with the correct amount, look for a tax line using it, and correct it as needed.
if taxes:
tax_total = float(amount.text)
tax_line = invoice.line_ids.filtered(lambda line: line.tax_line_id in taxes)[:1]
if tax_line:
sign = -1 if invoice.is_inbound(include_receipts=True) else 1
tax_line_amount = abs(tax_line.amount_currency)
if abs(tax_total - tax_line_amount) <= 0.05:
tax_line.amount_currency = tax_total * sign
# -------------------------------------------------------------------------
# IMPORT : helpers
# -------------------------------------------------------------------------
def _get_import_document_amount_sign(self, tree):
"""
In UBL, an invoice has tag 'Invoice' and a credit note has tag 'CreditNote'. However, a credit note can be
expressed as an invoice with negative amounts. For this case, we need a factor to take the opposite
of each quantity in the invoice.
"""
if tree.tag == '{urn:oasis:names:specification:ubl:schema:xsd:Invoice-2}Invoice':
amount_node = tree.find('.//{*}LegalMonetaryTotal/{*}TaxExclusiveAmount')
if amount_node is not None and float(amount_node.text) < 0:
return 'refund', -1
return 'invoice', 1
if tree.tag == '{urn:oasis:names:specification:ubl:schema:xsd:CreditNote-2}CreditNote':
return 'refund', 1
return None, None
|