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
|
from odoo import _, models, Command
from odoo.tools import float_repr, is_html_empty, html2plaintext, cleanup_xml_node
from lxml import etree
from datetime import datetime
import logging
_logger = logging.getLogger(__name__)
DEFAULT_FACTURX_DATE_FORMAT = '%Y%m%d'
CII_NAMESPACES = {
'ram': "urn:un:unece:uncefact:data:standard:ReusableAggregateBusinessInformationEntity:100",
'rsm': "urn:un:unece:uncefact:data:standard:CrossIndustryInvoice:100",
'udt': "urn:un:unece:uncefact:data:standard:UnqualifiedDataType:100",
}
class AccountEdiXmlCII(models.AbstractModel):
_name = "account.edi.xml.cii"
_inherit = 'account.edi.common'
_description = "Factur-x/XRechnung CII 2.2.0"
def _find_value(self, xpath, tree, nsmap=False):
# EXTENDS account.edi.common
return super()._find_value(xpath, tree, CII_NAMESPACES)
def _export_invoice_filename(self, invoice):
return f"{invoice.name.replace('/', '_')}_factur_x.xml"
def _export_invoice_ecosio_schematrons(self):
return {
'invoice': 'de.xrechnung:cii:2.2.0',
'credit_note': 'de.xrechnung:cii:2.2.0',
}
def _export_invoice_constraints(self, invoice, vals):
constraints = self._invoice_constraints_common(invoice)
constraints.update({
# [BR-08]-An Invoice shall contain the Seller postal address (BG-5).
# [BR-09]-The Seller postal address (BG-5) shall contain a Seller country code (BT-40).
'seller_postal_address': self._check_required_fields(
vals['record']['company_id']['partner_id']['commercial_partner_id'], 'country_id'
),
# [BR-DE-9] The element "Buyer post code" (BT-53) must be transmitted. (only mandatory in Germany ?)
'buyer_postal_address': self._check_required_fields(
vals['record']['commercial_partner_id'], 'zip'
),
# [BR-DE-4] The element "Seller post code" (BT-38) must be transmitted. (only mandatory in Germany ?)
'seller_post_code': self._check_required_fields(
vals['record']['company_id']['partner_id']['commercial_partner_id'], 'zip'
),
# [BR-CO-26]-In order for the buyer to automatically identify a supplier, the Seller identifier (BT-29),
# the Seller legal registration identifier (BT-30) and/or the Seller VAT identifier (BT-31) shall be present.
'seller_identifier': self._check_required_fields(
vals['record']['company_id'], ['vat'] # 'siret'
),
# [BR-DE-1] An Invoice must contain information on "PAYMENT INSTRUCTIONS" (BG-16)
# first check that a partner_bank_id exists, then check that there is an account number
'seller_payment_instructions_1': self._check_required_fields(
vals['record'], 'partner_bank_id'
),
'seller_payment_instructions_2': self._check_required_fields(
vals['record']['partner_bank_id'], 'sanitized_acc_number',
_("The field 'Sanitized Account Number' is required on the Recipient Bank.")
),
# [BR-DE-6] The element "Seller contact telephone number" (BT-42) must be transmitted.
'seller_phone': self._check_required_fields(
vals['record']['company_id']['partner_id']['commercial_partner_id'], ['phone', 'mobile'],
),
# [BR-DE-7] The element "Seller contact email address" (BT-43) must be transmitted.
'seller_email': self._check_required_fields(
vals['record']['company_id'], 'email'
),
# [BR-CO-04]-Each Invoice line (BG-25) shall be categorized with an Invoiced item VAT category code (BT-151).
'tax_invoice_line': self._check_required_tax(vals),
# [BR-IC-02]-An Invoice that contains an Invoice line (BG-25) where the Invoiced item VAT category code (BT-151)
# is "Intra-community supply" shall contain the Seller VAT Identifier (BT-31) or the Seller tax representative
# VAT identifier (BT-63) and the Buyer VAT identifier (BT-48).
'intracom_seller_vat': self._check_required_fields(vals['record']['company_id'], 'vat') if vals['intracom_delivery'] else None,
'intracom_buyer_vat': self._check_required_fields(vals['record']['commercial_partner_id'], 'vat') if vals['intracom_delivery'] else None,
# [BR-IG-05]-In an Invoice line (BG-25) where the Invoiced item VAT category code (BT-151) is "IGIC" the
# invoiced item VAT rate (BT-152) shall be greater than 0 (zero).
'igic_tax_rate': self._check_non_0_rate_tax(vals)
if vals['record']['commercial_partner_id']['country_id']['code'] == 'ES'
and vals['record']['commercial_partner_id']['zip']
and vals['record']['commercial_partner_id']['zip'][:2] in ['35', '38'] else None,
})
return constraints
def _check_required_tax(self, vals):
for line_vals in vals['invoice_line_vals_list']:
line = line_vals['line']
if not vals['tax_details']['tax_details_per_record'][line]['tax_details']:
return _("You should include at least one tax per invoice line. [BR-CO-04]-Each Invoice line (BG-25) "
"shall be categorized with an Invoiced item VAT category code (BT-151).")
def _check_non_0_rate_tax(self, vals):
for line_vals in vals['tax_details']['tax_details_per_record']:
tax_rate_list = line_vals.tax_ids.flatten_taxes_hierarchy().mapped("amount")
if not any([rate > 0 for rate in tax_rate_list]):
return _("When the Canary Island General Indirect Tax (IGIC) applies, the tax rate on "
"each invoice line should be greater than 0.")
def _get_scheduled_delivery_time(self, invoice):
# don't create a bridge only to get line.sale_line_ids.order_id.picking_ids.date_done
# line.sale_line_ids.order_id.picking_ids.scheduled_date or line.sale_line_ids.order_id.commitment_date
return invoice.invoice_date
def _get_invoicing_period(self, invoice):
# get the Invoicing period (BG-14): a list of dates covered by the invoice
# don't create a bridge to get the date range from the timesheet_ids
return [invoice.invoice_date]
def _get_exchanged_document_vals(self, invoice):
return {
'id': invoice.name,
'type_code': '380' if invoice.move_type == 'out_invoice' else '381',
'issue_date_time': invoice.invoice_date,
'included_note': html2plaintext(invoice.narration) if invoice.narration else "",
}
def _export_invoice_vals(self, invoice):
def format_date(dt):
# Format the date in the Factur-x standard.
dt = dt or datetime.now()
return dt.strftime(DEFAULT_FACTURX_DATE_FORMAT)
def format_monetary(number, decimal_places=2):
# Facturx requires the monetary values to be rounded to 2 decimal values
return float_repr(number, decimal_places)
def grouping_key_generator(base_line, tax_data):
tax = tax_data['tax']
customer = invoice.commercial_partner_id
supplier = invoice.company_id.partner_id.commercial_partner_id
grouping_key = {
**self._get_tax_unece_codes(customer, supplier, tax),
'amount': tax.amount,
'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
# Validate the structure of the taxes
self._validate_taxes(invoice.invoice_line_ids.tax_ids)
# Create file content.
tax_details = invoice._prepare_invoice_aggregated_taxes(grouping_key_generator=grouping_key_generator)
# 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.
fixed_taxes_keys = [k for k in tax_details['tax_details'] if k['amount_type'] == 'fixed']
for key in fixed_taxes_keys:
fixed_tax_details = tax_details['tax_details'].pop(key)
tax_details['tax_amount_currency'] -= fixed_tax_details['tax_amount_currency']
tax_details['tax_amount'] -= fixed_tax_details['tax_amount']
tax_details['base_amount_currency'] += fixed_tax_details['tax_amount_currency']
tax_details['base_amount'] += fixed_tax_details['tax_amount']
if 'siret' in invoice.company_id._fields and invoice.company_id.siret:
seller_siret = invoice.company_id.siret
else:
seller_siret = invoice.company_id.company_registry
buyer_siret = invoice.commercial_partner_id.company_registry
if 'siret' in invoice.commercial_partner_id._fields and invoice.commercial_partner_id.siret:
buyer_siret = invoice.commercial_partner_id.siret
template_values = {
**invoice._prepare_edi_vals_to_export(),
'tax_details': tax_details,
'format_date': format_date,
'format_monetary': format_monetary,
'is_html_empty': is_html_empty,
'scheduled_delivery_time': self._get_scheduled_delivery_time(invoice),
'intracom_delivery': False,
'ExchangedDocument_vals': self._get_exchanged_document_vals(invoice),
'seller_specified_legal_organization': seller_siret,
'buyer_specified_legal_organization': buyer_siret,
'ship_to_trade_party': invoice.partner_shipping_id if 'partner_shipping_id' in invoice._fields and invoice.partner_shipping_id
else invoice.commercial_partner_id,
# Chorus Pro fields
'buyer_reference': invoice.buyer_reference if 'buyer_reference' in invoice._fields
and invoice.buyer_reference else invoice.commercial_partner_id.ref,
'purchase_order_reference': invoice.purchase_order_reference if 'purchase_order_reference' in invoice._fields
and invoice.purchase_order_reference else invoice.ref or invoice.name,
'contract_reference': invoice.contract_reference if 'contract_reference' in invoice._fields and invoice.contract_reference else '',
'document_context_id': "urn:cen.eu:en16931:2017#conformant#urn:factur-x.eu:1p0:extended",
}
# data used for IncludedSupplyChainTradeLineItem / SpecifiedLineTradeSettlement
for line_vals in template_values['invoice_line_vals_list']:
line = line_vals['line']
line_vals['unece_uom_code'] = self._get_uom_unece_code(line.product_uom_id)
# data used for ApplicableHeaderTradeSettlement / ApplicableTradeTax (at the end of the xml)
for tax_detail_vals in template_values['tax_details']['tax_details'].values():
# /!\ -0.0 == 0.0 in python but not in XSLT, so it can raise a fatal error when validating the XML
# if 0.0 is expected and -0.0 is given.
amount_currency = tax_detail_vals['tax_amount_currency']
tax_detail_vals['calculated_amount'] = amount_currency if not invoice.currency_id.is_zero(amount_currency) else 0
if tax_detail_vals.get('tax_category_code') == 'K':
template_values['intracom_delivery'] = True
# [BR - IC - 11] - In an Invoice with a VAT breakdown (BG-23) where the VAT category code (BT-118) is
# "Intra-community supply" the Actual delivery date (BT-72) or the Invoicing period (BG-14) shall not be blank.
if tax_detail_vals.get('tax_category_code') == 'K' and not template_values['scheduled_delivery_time']:
date_range = self._get_invoicing_period(invoice)
template_values['billing_start'] = min(date_range)
template_values['billing_end'] = max(date_range)
# Fixed taxes: add them as charges on the invoice lines
for line_vals in template_values['invoice_line_vals_list']:
line_vals['allowance_charge_vals_list'] = []
for grouping_key, tax_detail in tax_details['tax_details_per_record'][line_vals['line']]['tax_details'].items():
if grouping_key['amount_type'] == 'fixed':
line_vals['allowance_charge_vals_list'].append({
'indicator': 'true',
'reason': tax_detail['tax_name'],
'reason_code': 'AEO',
'amount': tax_detail['tax_amount_currency'],
})
sum_fixed_taxes = sum(x['amount'] for x in line_vals['allowance_charge_vals_list'])
line_vals['line_total_amount'] = line_vals['line'].price_subtotal + sum_fixed_taxes
# Fixed taxes: set the total adjusted amounts on the document level
template_values['tax_basis_total_amount'] = tax_details['base_amount_currency']
template_values['tax_total_amount'] = tax_details['tax_amount_currency']
return template_values
def _export_invoice(self, invoice):
vals = self._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('account_edi_ubl_cii.account_invoice_facturx_export_22', vals)
return etree.tostring(cleanup_xml_node(xml_content), xml_declaration=True, encoding='UTF-8'), set(errors)
# -------------------------------------------------------------------------
# IMPORT
# -------------------------------------------------------------------------
def _import_retrieve_partner_vals(self, tree, role):
return {
'vat': self._find_value(f".//ram:{role}/ram:SpecifiedTaxRegistration/ram:ID[string-length(text()) > 5]", tree),
'name': self._find_value(f".//ram:{role}/ram:Name", tree),
'phone': self._find_value(f".//ram:{role}/ram:DefinedTradeContact/ram:TelephoneUniversalCommunication/ram:CompleteNumber", tree),
'email': self._find_value(f".//ram:{role}//ram:URIID[@schemeID='SMTP']", tree),
'country_code': self._find_value(f'.//ram:{role}/ram:PostalTradeAddress//ram:CountryID', 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 = 'SellerTradeParty' if invoice.journal_id.type == 'purchase' else 'BuyerTradeParty'
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, './/{*}InvoiceCurrencyCode')
# ==== partner_bank_id ====
bank_detail_nodes = tree.findall('.//{*}SpecifiedTradeSettlementPaymentMeans')
bank_details = [
bank_detail_node.findtext('{*}PayeePartyCreditorFinancialAccount/{*}IBANID')
or bank_detail_node.findtext('{*}PayeePartyCreditorFinancialAccount/{*}ProprietaryID')
for bank_detail_node in bank_detail_nodes
]
if bank_details:
self._import_partner_bank(invoice, bank_details=bank_details)
# ==== ref, invoice_origin, narration, payment_reference ====
invoice_values['ref'] = tree.findtext('./{*}ExchangedDocument/{*}ID')
invoice_values['invoice_origin'] = tree.findtext(
'.//{*}BuyerOrderReferencedDocument/{*}IssuerAssignedID'
)
invoice_values['narration'] = self._import_description(tree, xpaths=[
'./{*}ExchangedDocument/{*}IncludedNote/{*}Content',
'.//{*}SpecifiedTradePaymentTerms/{*}Description',
])
invoice_values['payment_reference'] = tree.findtext(
'./{*}SupplyChainTradeTransaction/{*}ApplicableHeaderTradeSettlement/{*}PaymentReference'
)
# ==== invoice_date, invoice_date_due ====
issue_date = tree.findtext('./{*}ExchangedDocument/{*}IssueDateTime/{*}DateTimeString')
if issue_date:
invoice_values['invoice_date'] = datetime.strptime(issue_date.strip(), DEFAULT_FACTURX_DATE_FORMAT)
due_date = tree.findtext('.//{*}SpecifiedTradePaymentTerms/{*}DueDateDateTime/{*}DateTimeString')
if due_date:
invoice_values['invoice_date_due'] = datetime.strptime(due_date.strip(), DEFAULT_FACTURX_DATE_FORMAT)
# ==== 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, './/{*}ApplicableHeaderTradeSettlement/{*}SpecifiedTradeSettlementHeaderMonetarySummation/{*}TotalPrepaidAmount', qty_factor)
invoice_line_vals, line_logs = self._import_invoice_lines(invoice, tree, './{*}SupplyChainTradeTransaction/{*}IncludedSupplyChainTradeLineItem', 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):
return tree.findall('.//{*}ApplicableTradeTax/{*}RateApplicablePercent')
def _get_document_allowance_charge_xpaths(self):
return {
'root': './{*}SupplyChainTradeTransaction/{*}ApplicableHeaderTradeSettlement/{*}SpecifiedTradeAllowanceCharge',
'charge_indicator': './{*}ChargeIndicator/{*}Indicator',
'base_amount': './{*}BasisAmount',
'amount': './{*}ActualAmount',
'reason': './{*}Reason',
'percentage': './{*}CalculationPercent',
'tax_percentage': './{*}CategoryTradeTax/{*}RateApplicablePercent',
}
def _get_line_xpaths(self, document_type=False, qty_factor=1):
return {
'basis_qty': (
'./ram:SpecifiedLineTradeAgreement/ram:GrossPriceProductTradePrice/ram:BasisQuantity',
'./ram:SpecifiedLineTradeAgreement/ram:NetPriceProductTradePrice/ram:BasisQuantity',
),
'gross_price_unit': './{*}SpecifiedLineTradeAgreement/{*}GrossPriceProductTradePrice/{*}ChargeAmount',
'rebate': './{*}SpecifiedLineTradeAgreement/{*}GrossPriceProductTradePrice/{*}AppliedTradeAllowanceCharge/{*}ActualAmount',
'net_price_unit': './{*}SpecifiedLineTradeAgreement/{*}NetPriceProductTradePrice/{*}ChargeAmount',
'delivered_qty': './{*}SpecifiedLineTradeDelivery/{*}BilledQuantity',
'allowance_charge': './/{*}SpecifiedLineTradeSettlement/{*}SpecifiedTradeAllowanceCharge',
'allowance_charge_indicator': './{*}ChargeIndicator/{*}Indicator',
'allowance_charge_amount': './{*}ActualAmount',
'allowance_charge_reason': './{*}Reason',
'allowance_charge_reason_code': './{*}ReasonCode',
'line_total_amount': './{*}SpecifiedLineTradeSettlement/{*}SpecifiedTradeSettlementLineMonetarySummation/{*}LineTotalAmount',
'name': [
'./ram:SpecifiedTradeProduct/ram:Name',
],
'product': {
'default_code': './ram:SpecifiedTradeProduct/ram:SellerAssignedID',
'name': './ram:SpecifiedTradeProduct/ram:Name',
'barcode': './ram:SpecifiedTradeProduct/ram:GlobalID',
},
}
# -------------------------------------------------------------------------
# IMPORT : helpers
# -------------------------------------------------------------------------
def _get_import_document_amount_sign(self, tree):
"""
In factur-x, an invoice has code 380 and a credit note has code 381. 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.
"""
move_type_code = tree.find('.//{*}ExchangedDocument/{*}TypeCode')
if move_type_code is None:
return None, None
if move_type_code.text == '381':
return 'refund', 1
if move_type_code.text == '380':
amount_node = tree.find('.//{*}SpecifiedTradeSettlementHeaderMonetarySummation/{*}TaxBasisTotalAmount')
if amount_node is not None and float(amount_node.text) < 0:
return 'refund', -1
return 'invoice', 1
|