# -*- coding: utf-8 -*- from odoo import models, _ from odoo.addons.account_edi_ubl_cii.models.account_edi_common import COUNTRY_EAS from stdnum.no import mva class AccountEdiXmlUBLBIS3(models.AbstractModel): _name = "account.edi.xml.ubl_bis3" _inherit = 'account.edi.xml.ubl_21' _description = "UBL BIS Billing 3.0.12" """ * Documentation of EHF Billing 3.0: https://anskaffelser.dev/postaward/g3/ * EHF 2.0 is no longer used: https://anskaffelser.dev/postaward/g2/announcement/2019-11-14-removal-old-invoicing-specifications/ * Official doc for EHF Billing 3.0 is the OpenPeppol BIS 3 doc + https://anskaffelser.dev/postaward/g3/spec/current/billing-3.0/norway/ "Based on work done in PEPPOL BIS Billing 3.0, Difi has included Norwegian rules in PEPPOL BIS Billing 3.0 and does not see a need to implement a different CIUS targeting the Norwegian market. Implementation of EHF Billing 3.0 is therefore done by implementing PEPPOL BIS Billing 3.0 without extensions or extra rules." Thus, EHF 3 and Bis 3 are actually the same format. The specific rules for NO defined in Bis 3 are added in Bis 3. """ # ------------------------------------------------------------------------- # EXPORT # ------------------------------------------------------------------------- def _export_invoice_filename(self, invoice): return f"{invoice.name.replace('/', '_')}_ubl_bis3.xml" def _export_invoice_ecosio_schematrons(self): return { 'invoice': 'eu.peppol.bis3:invoice:3.13.0', 'credit_note': 'eu.peppol.bis3:creditnote:3.13.0', } def _get_country_vals(self, country): # EXTENDS account.edi.xml.ubl_21 vals = super()._get_country_vals(country) vals.pop('name', None) return vals def _get_partner_party_tax_scheme_vals_list(self, partner, role): # EXTENDS account.edi.xml.ubl_21 vals_list = super()._get_partner_party_tax_scheme_vals_list(partner, role) if not partner.vat: return [] for vals in vals_list: vals.pop('registration_name', None) vals.pop('registration_address_vals', None) # /!\ For Australian companies, the ABN is encoded on the VAT field, but doesn't have the 2 digits prefix, # causing a validation error if partner.country_id.code == "AU" and partner.vat and not partner.vat.upper().startswith("AU"): vals['company_id'] = "AU" + partner.vat if partner.country_id.code == "LU" and 'l10n_lu_peppol_identifier' in partner._fields and partner.l10n_lu_peppol_identifier: vals['company_id'] = partner.l10n_lu_peppol_identifier # sources: # https://anskaffelser.dev/postaward/g3/spec/current/billing-3.0/norway/#_applying_foretaksregisteret # https://docs.peppol.eu/poacc/billing/3.0/bis/#national_rules (NO-R-002 (warning)) if partner.country_id.code == "NO" and role == 'supplier': vals_list.append({ 'company_id': "Foretaksregisteret", 'tax_scheme_id': "TAX", }) return vals_list def _get_partner_party_legal_entity_vals_list(self, partner): # EXTENDS account.edi.xml.ubl_21 vals_list = super()._get_partner_party_legal_entity_vals_list(partner) for vals in vals_list: vals.pop('registration_address_vals', None) if partner.country_code == 'NL' and 'l10n_nl_oin' in partner._fields: endpoint = partner.l10n_nl_oin or partner.l10n_nl_kvk scheme = '0190' if partner.l10n_nl_oin else '0106' vals.update({ 'company_id': endpoint, 'company_id_attrs': {'schemeID': scheme}, }) if partner.country_id.code == "LU" and 'l10n_lu_peppol_identifier' in partner._fields and partner.l10n_lu_peppol_identifier: vals['company_id'] = partner.l10n_lu_peppol_identifier return vals_list def _get_partner_contact_vals(self, partner): # EXTENDS account.edi.xml.ubl_21 vals = super()._get_partner_contact_vals(partner) vals.pop('id', None) return vals def _get_partner_party_vals(self, partner, role): # EXTENDS account.edi.xml.ubl_21 vals = super()._get_partner_party_vals(partner, role) vals['endpoint_id'] = partner.vat vals['endpoint_id_attrs'] = {'schemeID': COUNTRY_EAS.get(partner.country_id.code)} if partner.country_code == 'NO' and 'l10n_no_bronnoysund_number' in partner._fields: vals.update({ 'endpoint_id': partner.l10n_no_bronnoysund_number, 'endpoint_id_attrs': {'schemeID': '0192'}, }) # [BR-NL-1] Dutch supplier registration number ( AccountingSupplierParty/Party/PartyLegalEntity/CompanyID ); # With a Dutch supplier (NL), SchemeID may only contain 106 (Chamber of Commerce number) or 190 (OIN number). # [BR-NL-10] At a Dutch supplier, for a Dutch customer ( AccountingCustomerParty ) the customer registration # number must be filled with Chamber of Commerce or OIN. SchemeID may only contain 106 (Chamber of # Commerce number) or 190 (OIN number). if partner.country_code == 'NL' and 'l10n_nl_oin' in partner._fields: if partner.l10n_nl_oin: vals.update({ 'endpoint_id': partner.l10n_nl_oin, 'endpoint_id_attrs': {'schemeID': '0190'}, }) elif partner.l10n_nl_kvk: vals.update({ 'endpoint_id': partner.l10n_nl_kvk, 'endpoint_id_attrs': {'schemeID': '0106'}, }) if partner.country_id.code == 'SG' and 'l10n_sg_unique_entity_number' in partner._fields: vals.update({ 'endpoint_id': partner.l10n_sg_unique_entity_number, 'endpoint_id_attrs': {'schemeID': '0195'}, }) if partner.country_id.code == "LU" and 'l10n_lu_peppol_identifier' in partner._fields and partner.l10n_lu_peppol_identifier: vals['endpoint_id'] = partner.l10n_lu_peppol_identifier return vals def _get_partner_party_identification_vals_list(self, partner): # EXTENDS account.edi.xml.ubl_21 vals = super()._get_partner_party_identification_vals_list(partner) if partner.country_code == 'NL' and 'l10n_nl_oin' in partner._fields: endpoint = partner.l10n_nl_oin or partner.l10n_nl_kvk vals.append({ 'id': endpoint, }) return vals def _get_delivery_vals_list(self, invoice): # EXTENDS account.edi.xml.ubl_21 supplier = invoice.company_id.partner_id.commercial_partner_id customer = invoice.commercial_partner_id economic_area = self.env.ref('base.europe').country_ids.mapped('code') + ['NO'] intracom_delivery = (customer.country_id.code in economic_area and supplier.country_id.code in economic_area and supplier.country_id != customer.country_id) if not intracom_delivery: return [] # [BR-IC-12]-In an Invoice with a VAT breakdown (BG-23) where the VAT category code (BT-118) is # "Intra-community supply" the Deliver to country code (BT-80) shall not be blank. # [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 'partner_shipping_id' in invoice._fields: partner_shipping = invoice.partner_shipping_id else: partner_shipping = customer return [{ 'actual_delivery_date': invoice.invoice_date, 'delivery_location_vals': { 'delivery_address_vals': self._get_partner_address_vals(partner_shipping), }, }] def _get_partner_address_vals(self, partner): # EXTENDS account.edi.xml.ubl_21 vals = super()._get_partner_address_vals(partner) # schematron/openpeppol/3.13.0/xslt/CEN-EN16931-UBL.xslt # [UBL-CR-225]-A UBL invoice should not include the AccountingCustomerParty Party PostalAddress CountrySubentityCode vals.pop('country_subentity_code', None) return vals def _get_financial_institution_branch_vals(self, bank): # EXTENDS account.edi.xml.ubl_21 vals = super()._get_financial_institution_branch_vals(bank) # schematron/openpeppol/3.13.0/xslt/CEN-EN16931-UBL.xslt # [UBL-CR-664]-A UBL invoice should not include the FinancialInstitutionBranch FinancialInstitution # xpath test: not(//cac:FinancialInstitution) vals.pop('id_attrs', None) vals.pop('financial_institution_vals', None) return vals def _get_invoice_payment_means_vals_list(self, invoice): # EXTENDS account.edi.xml.ubl_21 vals_list = super()._get_invoice_payment_means_vals_list(invoice) for vals in vals_list: vals.pop('payment_due_date', None) vals.pop('instruction_id', None) if vals.get('payment_id_vals'): vals['payment_id_vals'] = vals['payment_id_vals'][:1] return vals_list def _get_tax_category_list(self, invoice, taxes): # EXTENDS account.edi.xml.ubl_21 vals_list = super()._get_tax_category_list(invoice, taxes) for vals in vals_list: vals.pop('name') # [UBL-CR-601]-A UBL invoice should not include the InvoiceLine Item ClassifiedTaxCategory TaxExemptionReason #vals.pop('tax_exemption_reason') return vals_list def _get_invoice_tax_totals_vals_list(self, invoice, taxes_vals): # EXTENDS account.edi.xml.ubl_21 vals_list = super()._get_invoice_tax_totals_vals_list(invoice, taxes_vals) for vals in vals_list: vals['currency_dp'] = 2 for subtotal_vals in vals.get('tax_subtotal_vals', []): subtotal_vals.pop('percent', None) subtotal_vals['currency_dp'] = 2 return vals_list def _get_invoice_line_allowance_vals_list(self, line): # EXTENDS account.edi.xml.ubl_21 vals_list = super()._get_invoice_line_allowance_vals_list(line) for vals in vals_list: vals['currency_dp'] = 2 return vals_list def _get_invoice_line_vals(self, line, taxes_vals): # EXTENDS account.edi.xml.ubl_21 vals = super()._get_invoice_line_vals(line, taxes_vals) vals.pop('tax_total_vals', None) vals['currency_dp'] = 2 vals['price_vals']['currency_dp'] = 2 return vals def _export_invoice_vals(self, invoice): # EXTENDS account.edi.xml.ubl_21 vals = super()._export_invoice_vals(invoice) vals['vals'].update({ 'customization_id': 'urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0', 'profile_id': 'urn:fdc:peppol.eu:2017:poacc:billing:01:1.0', 'currency_dp': 2, 'ubl_version_id': None, }) vals['vals']['legal_monetary_total_vals']['currency_dp'] = 2 # [NL-R-001] For suppliers in the Netherlands, if the document is a creditnote, the document MUST # contain an invoice reference (cac:BillingReference/cac:InvoiceDocumentReference/cbc:ID) if vals['supplier'].country_id.code == 'NL' and 'refund' in invoice.move_type: vals['vals'].update({ 'billing_reference_vals': { 'id': invoice.ref, 'issue_date': None, } }) return vals def _export_invoice_constraints(self, invoice, vals): # EXTENDS account.edi.xml.ubl_21 constraints = super()._export_invoice_constraints(invoice, vals) constraints.update( self._invoice_constraints_peppol_en16931_ubl(invoice, vals) ) constraints.update( self._invoice_constraints_cen_en16931_ubl(invoice, vals) ) return constraints def _invoice_constraints_cen_en16931_ubl(self, invoice, vals): """ corresponds to the errors raised by ' schematron/openpeppol/3.13.0/xslt/CEN-EN16931-UBL.xslt' for invoices. This xslt was obtained by transforming the corresponding sch https://docs.peppol.eu/poacc/billing/3.0/files/CEN-EN16931-UBL.sch. """ eu_countries = self.env.ref('base.europe').country_ids intracom_delivery = (vals['customer'].country_id in eu_countries and vals['supplier'].country_id in eu_countries and vals['customer'].country_id != vals['supplier'].country_id) constraints = { # [BR-S-02]-An Invoice that contains an Invoice line (BG-25) where the Invoiced item VAT category code # (BT-151) is "Standard rated" shall contain the Seller VAT Identifier (BT-31), the Seller tax registration # identifier (BT-32) and/or the Seller tax representative VAT identifier (BT-63). # --- # [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. 'cen_en16931_seller_vat_identifier': self._check_required_fields( vals['supplier'], 'vat' # this check is larger than the rules above ), # [BR-61]-If the Payment means type code (BT-81) means SEPA credit transfer, Local credit transfer or # Non-SEPA international credit transfer, the Payment account identifier (BT-84) shall be present. # note: Payment account identifier is # note: no need to check account_number, because it's a required field for a partner_bank 'cen_en16931_payment_account_identifier': self._check_required_fields( invoice, 'partner_bank_id' ) if vals['vals']['payment_means_vals_list'][0]['payment_means_code'] in (30, 58) else None, # [BR-62]-The Seller electronic address (BT-34) shall have a Scheme identifier. # if this fails, it might just be a missing country when mapping the country to the EAS code 'cen_en16931_seller_EAS': self._check_required_fields( vals['vals']['accounting_supplier_party_vals']['party_vals']['endpoint_id_attrs'], 'schemeID', _("No Electronic Address Scheme (EAS) could be found for %s.", vals['customer'].name) ), # [BR-63]-The Buyer electronic address (BT-49) shall have a Scheme identifier. # if this fails, it might just be a missing country when mapping the country to the EAS code 'cen_en16931_buyer_EAS': self._check_required_fields( vals['vals']['accounting_customer_party_vals']['party_vals']['endpoint_id_attrs'], 'schemeID', _("No Electronic Address Scheme (EAS) could be found for %s.", vals['customer'].name) ), # [BR-IC-12]-In an Invoice with a VAT breakdown (BG-23) where the VAT category code (BT-118) is # "Intra-community supply" the Deliver to country code (BT-80) shall not be blank. 'cen_en16931_delivery_country_code': self._check_required_fields( vals['vals']['delivery_vals_list'][0], 'delivery_location_vals', _("For intracommunity supply, the delivery address should be included.") ) if intracom_delivery else None, # [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. 'cen_en16931_delivery_date_invoicing_period': self._check_required_fields( vals['vals']['delivery_vals_list'][0], 'actual_delivery_date', _("For intracommunity supply, the actual delivery date or the invoicing period should be included.") ) and self._check_required_fields( vals['vals']['invoice_period_vals_list'][0], ['start_date', 'end_date'], _("For intracommunity supply, the actual delivery date or the invoicing period should be included.") ) if intracom_delivery else None, } for line in invoice.line_ids: if len(line.tax_ids) > 1: # [UBL-SR-48]-Invoice lines shall have one and only one classified tax category. constraints.update({'cen_en16931_tax_line': _("Each invoice line shall have one and only one tax.")}) return constraints def _invoice_constraints_peppol_en16931_ubl(self, invoice, vals): """ corresponds to the errors raised by 'schematron/openpeppol/3.13.0/xslt/PEPPOL-EN16931-UBL.xslt' for invoices in ecosio. This xslt was obtained by transforming the corresponding sch https://docs.peppol.eu/poacc/billing/3.0/files/PEPPOL-EN16931-UBL.sch. The national rules (https://docs.peppol.eu/poacc/billing/3.0/bis/#national_rules) are included in this file. They always refer to the supplier's country. """ constraints = { # PEPPOL-EN16931-R020: Seller electronic address MUST be provided 'peppol_en16931_ubl_seller_endpoint': self._check_required_fields( vals['supplier'], 'vat' ), # PEPPOL-EN16931-R010: Buyer electronic address MUST be provided 'peppol_en16931_ubl_buyer_endpoint': self._check_required_fields( vals['customer'], 'vat' ), # PEPPOL-EN16931-R003: A buyer reference or purchase order reference MUST be provided. 'peppol_en16931_ubl_buyer_ref_po_ref': "A buyer reference or purchase order reference must be provided." if self._check_required_fields( vals['vals'], 'buyer_reference' ) and self._check_required_fields(vals['vals'], 'order_reference') else None, } if vals['supplier'].country_id.code == 'NL': constraints.update({ # [NL-R-001] For suppliers in the Netherlands, if the document is a creditnote, the document MUST contain # an invoice reference (cac:BillingReference/cac:InvoiceDocumentReference/cbc:ID) 'nl_r_001': self._check_required_fields(invoice, 'ref') if 'refund' in invoice.move_type else '', # [NL-R-002] For suppliers in the Netherlands the supplier’s address (cac:AccountingSupplierParty/cac:Party # /cac:PostalAddress) MUST contain street name (cbc:StreetName), city (cbc:CityName) and post code (cbc:PostalZone) 'nl_r_002_street': self._check_required_fields(vals['supplier'], 'street'), 'nl_r_002_zip': self._check_required_fields(vals['supplier'], 'zip'), 'nl_r_002_city': self._check_required_fields(vals['supplier'], 'city'), # [NL-R-003] For suppliers in the Netherlands, the legal entity identifier MUST be either a # KVK or OIN number (schemeID 0106 or 0190) 'nl_r_003': _( "The supplier %s must have a KVK or OIN number.", vals['supplier'].display_name ) if 'l10n_nl_oin' not in vals['supplier']._fields or 'l10n_nl_kvk' not in vals['supplier']._fields else '', # [NL-R-007] For suppliers in the Netherlands, the supplier MUST provide a means of payment # (cac:PaymentMeans) if the payment is from customer to supplier 'nl_r_007': self._check_required_fields(invoice, 'partner_bank_id') }) if vals['customer'].country_id.code == 'NL': constraints.update({ # [NL-R-004] For suppliers in the Netherlands, if the customer is in the Netherlands, the customer # address (cac:AccountingCustomerParty/cac:Party/cac:PostalAddress) MUST contain the street name # (cbc:StreetName), the city (cbc:CityName) and post code (cbc:PostalZone) 'nl_r_004_street': self._check_required_fields(vals['customer'], 'street'), 'nl_r_004_city': self._check_required_fields(vals['customer'], 'city'), 'nl_r_004_zip': self._check_required_fields(vals['customer'], 'zip'), # [NL-R-005] For suppliers in the Netherlands, if the customer is in the Netherlands, # the customer’s legal entity identifier MUST be either a KVK or OIN number (schemeID 0106 or 0190) 'nl_r_005': _( "The customer %s must have a KVK or OIN number.", vals['customer'].display_name ) if 'l10n_nl_oin' not in vals['customer']._fields or 'l10n_nl_kvk' not in vals['customer']._fields else '', }) if vals['supplier'].country_id.code == 'NO': vat = vals['supplier'].vat constraints.update({ # NO-R-001: For Norwegian suppliers, a VAT number MUST be the country code prefix NO followed by a # valid Norwegian organization number (nine numbers) followed by the letters MVA. # Note: mva.is_valid("179728982MVA") is True while it lacks the NO prefix 'no_r_001': _( "The VAT number of the supplier does not seem to be valid. It should be of the form: NO179728982MVA." ) if not mva.is_valid(vat) or len(vat) != 14 or vat[:2] != 'NO' or vat[-3:] != 'MVA' else "", 'no_supplier_bronnoysund': _( "The supplier %s must have a Bronnoysund company registry.", vals['supplier'].display_name ) if 'l10n_no_bronnoysund_number' not in vals['supplier']._fields or not vals['supplier'].l10n_no_bronnoysund_number else "", }) if vals['customer'].country_id.code == 'NO': constraints.update({ 'no_customer_bronnoysund': _( "The supplier %s must have a Bronnoysund company registry.", vals['customer'].display_name ) if 'l10n_no_bronnoysund_number' not in vals['customer']._fields or not vals['customer'].l10n_no_bronnoysund_number else "", }) return constraints