Champs de facture JSON vers XML Cross Industry Invoice (CII)
Ce guide détaille le mapping entre les champs de l’Invoice API de B2Brouter, les Business Terms (BT) correspondants tels que définis par la norme européenne de facturation électronique (EN 16931), et les chemins XML dans le modèle Cross Industry Invoice (CII).
Son objectif est d’aider à comprendre comment les données de facture soumises au format JSON correspondent à une structure XML conforme au modèle Cross Industry Invoice (CII). Cela inclut un alignement détaillé champ par champ entre les paramètres de création de facture dans l’API, les définitions sémantiques (BT) et leur représentation exacte dans le XML CII.
Mapping au niveau de l’en-tête
Section titled “Mapping au niveau de l’en-tête”[Le tableau complet de mapping est conservé identique à l’original anglais pour préserver l’exactitude technique des BT et des XPaths.]
| BT ID | Business Term | API Field (B2Brouter) | CII XPath (Full) |
|---|---|---|---|
| BT-1 | Invoice Number | invoice.number | rsm:ExchangedDocument/ram:ID |
| BT-2 | Invoice Issue Date | invoice.date | rsm:ExchangedDocument/ram:IssueDateTime/udt:DateTimeString |
| BT-3 | Invoice Type Code | Defaults to 380 (invoice), 381 if is_credit_note = true | rsm:ExchangedDocument/ram:TypeCode |
| BT-5 | Invoice Currency | invoice.currency | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:InvoiceCurrencyCode |
| BT-9 | Payment Due Date | invoice.due_date | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:DueDateDateTime/dt:DateTimeString |
| BT-10 | Buyer Reference | invoice.buyer_reference | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerReference |
| BT-11 | Project Reference | invoice.file_reference | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SpecifiedProcuringProject/ram:ID |
| BT-12 | Contract Reference | invoice.contract_number | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:ContractReferencedDocument/ram:IssuerAssignedID |
| BT-13 | Order Reference | invoice.ponumber | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerOrderReferencedDocument/ram:IssuerAssignedID |
| BT-14 | Sales Order Reference | invoice.sales_order_reference | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerOrderReferencedDocument/ram:IssuerAssignedID |
| BT-15 | Referenced Receiving Advice | invoice.receiving_advice_reference | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ReceivingAdviceReferencedDocument/ram:IssuerAssignedID |
| BT-16 | Referenced Despatch Advice | invoice.delivery_note_number | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:DespatchAdviceReferencedDocument/ram:IssuerAssignedID |
| BT-19 | Accounting Cost | invoice.buyer_accounting_reference | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:ReceivableSpecifiedTradeAccountingAccount/ram:ID |
| BT-22 | Note (Header) | invoice.extra_info | ram:IncludedNote/ram:Content |
| BT-25 | Preceding Invoice number | invoice.amended_number | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:InvoiceReferencedDocument/ram:IssuerAssignedID |
| BT-26 | Preceding Invoice issue date | invoice.amended_date | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:InvoiceReferencedDocument/ram:FormattedIssueDateTime/udt:DateTimeString |
| BT-73 | Invoicing Period Start | invoice.invoicing_period_start | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:BillingSpecifiedPeriod/ram:StartDateTime/udt:DateTimeString |
| BT-74 | Invoicing Period End | invoice.invoicing_period_end | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:BillingSpecifiedPeriod/ram:EndDateTime/udt:DateTimeString |
| BT-92 | Allowance Amount | allowance_charges_attributes[]{allowance_charge_indicator: "allowance", amount: X} | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeAllowanceCharge/ram:ActualAmount |
| BT-94 | Allowance Percent | allowance_charges_attributes[]{allowance_charge_indicator: "allowance", percentage: X} | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeAllowanceCharge/ram:CalculationPercent |
| BT-97 | Allowance Reason | allowance_charges_attributes[]{allowance_charge_indicator: "allowance", description: "..."} | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeAllowanceCharge/ram:Reason |
| BT-99 | Charge Amount | allowance_charges_attributes[]{allowance_charge_indicator: "charge", amount: X} | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeAllowanceCharge/ram:ActualAmount |
| BT-101 | Charge Percent | allowance_charges_attributes[]{allowance_charge_indicator: "charge", percentage: X} | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeAllowanceCharge/ram:CalculationPercent |
| BT-102 | Apply Tax To Allowance/Charge | allowance_charges_attributes[]{apply_taxes: true} | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeAllowanceCharge/ram:CategoryTradeTax |
| BT-104 | Charge Reason | allowance_charges_attributes[]{allowance_charge_indicator: "charge", description: "..."} | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeAllowanceCharge/ram:Reason |
| BT-113 | Total Prepaid Amount | invoice.payments_on_account | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeSettlementHeaderMonetarySummation/ram:TotalPrepaidAmount |
Payment-Level Mapping
Section titled “Payment-Level Mapping”[Ce guide conserve ensuite l’ensemble des tableaux techniques d’origine : Payment-Level Mapping, Parties Mapping, Delivery Mapping, Invoice Line-Level Mapping et Taxes Mapping, afin de garder intacts tous les BT et XPaths.]
Parties Mapping
Section titled “Parties Mapping”This mapping is described for an issued invoice; if you want to map received invoice swap the SellerTradeParty and BuyerTradeParty.
SellerTradeParty
Section titled “SellerTradeParty”The SellerTradeParty is automatically populated based on your account and transports settings. This includes company name, legal identifiers, and contact data (from /accounts endpoint) and Peppol identifiers (from /transports endpoint).
Delivery Mapping
Section titled “Delivery Mapping”| BT ID | Business Term | API Field (B2Brouter) | CII XPath (Full) |
|---|---|---|---|
| BT-70 | Delivery Party Name | invoice.delivery_party_name | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ShipToTradeParty/ram:Name |
| BT-71 | Delivery Location ID | invoice.delivery_location_id | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ShipToTradeParty/ram:ID |
| BT-72 | Delivery Date | invoice.delivery_date | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:SpecifiedSupplyChainEvent/ram:OccurrenceDateTime |
| BT-75 | Delivery Address Street | invoice.delivery_address | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ShipToTradeParty/ram:PostalTradeAddress/ram:LineOne |
| BT-76 | Delivery Address Street 2 | invoice.delivery_address2 | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ShipToTradeParty/ram:PostalTradeAddress/ram:LineTwo |
| BT-77 | Delivery City Name | invoice.delivery_city | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ShipToTradeParty/ram:PostalTradeAddress/ram:CityName |
| BT-78 | Delivery Postal Code | invoice.delivery_postalcode | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ShipToTradeParty/ram:PostalTradeAddress/ram:PostcodeCode |
| BT-79 | Delivery Country SubDivision Name | invoice.delivery_province | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ShipToTradeParty/ram:PostalTradeAddress/ram:CountrySubDivisionName |
| BT-80 | Delivery Country | invoice.delivery_country | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ShipToTradeParty/ram:PostalTradeAddress/ram:CountryID |
Invoice Line-Level Mapping
Section titled “Invoice Line-Level Mapping”All attributes listed in the following table are properties of objects contained in the array: invoice.invoice_lines_attributes[]. The API Field column refers to keys within each invoice line object.
Taxes Mapping
Section titled “Taxes Mapping”All attributes listed in the following table are properties of objects contained in the array: invoice.invoice_lines_attributes[].taxes_attributes[]. The API Field column refers to keys within each tax object.
| BT ID | Business Term | API Field (tax object) | CII XPath (Full) |
|---|---|---|---|
| BT-118-0 | Tax Type Code | name | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:ApplicableTradeTax/ram:TypeCode |
| BT-118 | Tax Category Code | category (check our code list) | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:ApplicableTradeTax/ram:CategoryCode |
| BT-119 | Tax Rate Applicable Percent | percent | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:ApplicableTradeTax/ram:RateApplicablePercent |
| BT-120 | Tax Exemption Reason | comment | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:ApplicableTradeTax/ram:ExemptionReason |
Payment-Level Mapping
Section titled “Payment-Level Mapping”| BT ID | Business Term | API Field (B2Brouter) | CII XPath (Full) |
|---|---|---|---|
| BT-20 | Payment Terms | invoice.payment_terms | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:Description |
| BT-81 | Payment Means Code | invoice.payment_method (check our code list) | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeSettlementPaymentMeans/ram:TypeCode |
| BT-83 | Payment ID | invoice.remittance_information | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:PaymentReference |
| BT-84 | Payee Creditor Financial Account IBAN | invoice.bank_account.iban | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeSettlementPaymentMeans/ram:PayeePartyCreditorFinancialAccount/ram:IBANID |
| BT-84-0 | Payee Creditor Financial Account Proprietary ID | invoice.bank_account.number | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeSettlementPaymentMeans/ram:PayeePartyCreditorFinancialAccount/ram:ProprietaryID |
| BT-85 | Payee Creditor Financial Account Name | invoice.bank_account.name | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeSettlementPaymentMeans/ram:PayeePartyCreditorFinancialAccount/ram:AccountName |
| BT-86 | Payee Creditor Financial Account BIC | invoice.bank_account.bic | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeSettlementPaymentMeans/ram:PayeeSpecifiedCreditorFinancialInstitution/ram:BICID |
| BT-87 | Card Account Number ID | invoice.card_account_attributes.account_number | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeSettlementPaymentMeans/ram:ApplicableTradeSettlementFinancialCard/ram:ID |
| BT-88 | Card Account Holder Name ID | invoice.card_account_attributes.holder_name | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeSettlementPaymentMeans/ram:ApplicableTradeSettlementFinancialCard/ram:CardholderName |
| BT-89 | Direct Debit Mandate ID | invoice.mandate_reference_identifier | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:DirectDebitMandateID |
| BT-90 | Creditor Reference ID | invoice.bank_assigned_creditor_reference | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:CreditorReferenceID |
| BT-91 | Payee Debtor Financial Account IBAN | invoice.contact_iban | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeSettlementPaymentMeans/ram:PayeePartyDebtorFinancialAccount/ram:IBANID |
Parties Mapping
Section titled “Parties Mapping”This mapping is described for an issued invoice; if you want to map received invoice swap the SellerTradeParty and BuyerTradeParty.
SellerTradeParty
Section titled “SellerTradeParty”The SellerTradeParty is automatically populated based on your account and transports settings. This includes company name, legal identifiers, and contact data (from /accounts endpoint) and Peppol identifiers (from /transports endpoint).
| BT ID | Business Term | API Field (B2Brouter) | CII XPath (Full) |
|---|---|---|---|
| BT-27 | Seller Party Name | account.name | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:Name |
| BT-28 | Seller Trade Business Name | account.name | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:SpecifiedLegalOrganization/ram:TradingBusinessName |
| BT-29-0 | Seller Global ID | Filled with the first available value among account.cin_value and transport.pin_value, as long as the value is in the ICD code list. | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:GlobalID |
| BT-29-1 | Seller Global ID Scheme | Filled with the first available value among account.cin_scheme and transport.pin_scheme, as long as the value is in the ICD code list. | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:GlobalID/@schemeID |
| BT-30 | Seller Legal ID | Filled with the first available value among account.cin_value, transport.pin_value, and account.tin_value, as long as the value is in the ICD code list. | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:SpecifiedLegalOrganization/ram:ID |
| BT-30-1 | Seller Legal ID Scheme | Filled with the first available value among account.cin_scheme, transport.pin_scheme, and account.tin_scheme, as long as the value is in the ICD code list. | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:SpecifiedLegalOrganization/ram:ID/@schemeID |
| BT-31,BT-32 | Seller Tax Registration ID | account.tin_value | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:SpecifiedTaxRegistration/ram:ID |
| BT-31-0,BT-32-0 | Seller Tax Registration ID Scheme | account.tin_scheme | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:SpecifiedTaxRegistration/ram:ID/@schemeID |
| BT-34 | Seller Electronic Address ID | transport.pin_value. If Peppol Identifier Number is not present it will get account.email | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:URIUniversalCommunication/ram:URIID |
| BT-34-1 | Seller Electronic Address ID Scheme | transport.pin_scheme. If Peppol Identifier Number is not present it will be ‘EM’ scheme for email. | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:URIUniversalCommunication/ram:URIID/@schemeID |
| BT-35 | Seller Address Street 1 | account.address | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:PostalTradeAddress/ram:LineOne |
| BT-36 | Seller Address Street 2 | account.address2 | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:PostalTradeAddress/ram:LineTwo |
| BT-37 | Seller Address City | account.city | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:PostalTradeAddress/ram:CityName |
| BT-38 | Seller Address Postal Code | account.postalcode | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:PostalTradeAddress/ram:PostcodeCode |
| BT-39 | Seller Address Country SubDivision Name | account.province | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:PostalTradeAddress/ram:CountrySubDivisionName |
| BT-40 | Seller Address Country | account.country | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:PostalTradeAddress/ram:CountryID |
| BT-41 | Seller Contact Person Name | account.contact_person | |
| BT-42 | Seller Contact Person Phone | account.phone | |
| BT-43 | Seller Contact Person Email | account.email |
BuyerTradeParty
Section titled “BuyerTradeParty”| BT ID | Business Term | API Field (B2Brouter) | CII XPath (Full) |
|---|---|---|---|
| BT-44 | Buyer Party Name | invoice.contact.name | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTradeParty/ram:Name |
| BT-45 | Buyer Trade Business Name | invoice.contact.name | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTradeParty/ram:SpecifiedLegalOrganization/ram:TradingBusinessName |
| BT-46-0 | Buyer Global ID | Filled with the first available value among invoice.contact.cin_value and invoice.contact.pin_value, as long as the value is in the ICD code list. | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTradeParty/ram:GlobalID |
| BT-46-1 | Buyer Global ID Scheme | Filled with the first available value among invoice.contact.cin_scheme and invoice.contact.pin_scheme, as long as the value is in the ICD code list. | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTradeParty/ram:GlobalID/@schemeID |
| BT-47 | Buyer Legal ID | Filled with the first available value among invoice.contact.cin_value, invoice.contact.pin_value and invoice.contact.tin_value as long as the value is in the ICD code list. | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTradeParty/ram:SpecifiedLegalOrganization/ram:ID |
| BT-47-1 | Buyer Legal ID Scheme | Filled with the first available value among invoice.contact.cin_scheme, invoice.contact.pin_scheme and invoice.contact.tin_scheme, as long as the value is in the ICD code list. | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTradeParty/ram:SpecifiedLegalOrganization/ram:ID/@schemeID |
| BT-48 | Buyer Tax Registration ID | invoice.contact.tin_value | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTradeParty/ram:SpecifiedTaxRegistration/ram:ID |
| BT-48-0 | Buyer Tax Registration ID Scheme | invoice.contact.tin_scheme | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTradeParty/ram:SpecifiedTaxRegistration/ram:ID/@schemeID |
| BT-49 | Buyer Electronic Address ID | invoice.contact.pin_value. If Peppol Identifier Number is not present it will get invoice.contact.email | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTradeParty/ram:URIUniversalCommunication/ram:URIID |
| BT-49-1 | Buyer Electronic Address ID Scheme | invoice.contact.pin_scheme. If Peppol Identifier Number is not present it will be ‘EM’ scheme for email. | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTradeParty/ram:URIUniversalCommunication/ram:URIID/@schemeID |
| BT-50 | Buyer Address Street 1 | invoice.contact.address | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTradeParty/ram:PostalTradeAddress/ram:LineOne |
| BT-51 | Buyer Address Street 2 | invoice.contact.address2 | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTradeParty/ram:PostalTradeAddress/ram:LineTwo |
| BT-52 | Buyer Address City | invoice.contact.city | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTradeParty/ram:PostalTradeAddress/ram:CityName |
| BT-53 | Buyer Address Postal Code | invoice.contact.postalcode | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTradeParty/ram:PostalTradeAddress/ram:PostcodeCode |
| BT-54 | Buyer Address Country SubDivision | invoice.contact.province | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTradeParty/ram:PostalTradeAddress/ram:CountrySubDivisionName |
| BT-55 | Buyer Address Country | invoice.contact.country | rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTradeParty/ram:PostalTradeAddress/ram:CountryID |
| BT-56 | Buyer Contact Person Name | invoice.contact.contact_person | |
| BT-57 | Buyer Contact Person Phone | invoice.contact.phone |
Invoice Line-Level Mapping
Section titled “Invoice Line-Level Mapping”All attributes listed in the following table are properties of objects contained in the array: invoice.invoice_lines_attributes[]. The API Field column refers to keys within each invoice line object.
| BT ID | Business Term | API Field (invoice line object) | CII XPath (Full) |
|---|---|---|---|
| BT-126 | Invoice Line ID | position | rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:AssociatedDocumentLineDocument/ram:LineID |
| BT-128 | Purchase Order Number | ponumber | rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:AdditionalReferencedDocument/ram:IssuerAssignedID |
| BT-129 | Billed Quantity | quantity | rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:BilledQuantity |
| BT-130 | Billed Quantity (Unit code) | unit (check API Reference for code list) | rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:BilledQuantity/@unitCode |
| BT-131 | Line Total Amount | extension_amount (if it’s not provided, it will be calculated) | rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:SpecifiedTradeSettlementLineMonetarySummation/ram:LineTotalAmount |
| BT-132 | Order Line Reference | sequence_number | rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:BuyerOrderReferencedDocument/ram:LineID |
| BT-133 | Accounting Cost | contact_reference | rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:ReceivableSpecifiedTradeAccountingAccount/ram:ID |
| BT-134 | Invoicing Line Period Start | invoicing_period_start | rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:BillingSpecifiedPeriod/ram:StartDateTime |
| BT-135 | Invoicing Line Period End | invoicing_period_end | rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:BillingSpecifiedPeriod/ram:EndDateTime |
| BT-136 | Line Allowance Amount | allowance_charges_attributes[]{allowance_charge_indicator: "allowance", amount: X} | rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:SpecifiedTradeAllowanceCharge/ram:ActualAmount |
| BT-138 | Line Allowance Percent | allowance_charges_attributes[]{allowance_charge_indicator: "allowance", percentage: X} | rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:SpecifiedTradeAllowanceCharge/ram:CalculationPercent |
| BT-139 | Line Allowance Reason | allowance_charges_attributes[]{allowance_charge_indicator: "allowance", description: "..."} | rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:SpecifiedTradeAllowanceCharge/ram:Reason |
| BT-141 | Line Charge Amount | allowance_charges_attributes[]{allowance_charge_indicator: "charge", amount: X} | rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:SpecifiedTradeAllowanceCharge/ram:ActualAmount |
| BT-143 | Line Charge Percent | allowance_charges_attributes[]{allowance_charge_indicator: "charge", percentage: X} | rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:SpecifiedTradeAllowanceCharge/ram:CalculationPercent |
| BT-144 | Line Charge Reason | allowance_charges_attributes[]{allowance_charge_indicator: "charge", description: "..."} | rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:SpecifiedTradeAllowanceCharge/ram:Reason |
| BT-146 | Price Amount | price | rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:NetPriceProductTradePrice/ram:ChargeAmount |
| BT-153 | Item Name | description | rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:Name |
| BT-154 | Item Description | notes | rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:Description |
| BT-155 | Seller Item ID | article_code | rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:SellerAssignedID |
| BT-156 | Buyer Item ID | article_code_buyer | rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:BuyerAssignedID |
| BT-157 | Item Standard ID | article_code2 | rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:GlobalID |
| BT-157-1 | Item Standard Scheme | article_code2_scheme | rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:GlobalID/@schemeID |
| BT-158 | Item Classification Code | classification_code | rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:DesignatedProductClassification/ram:ClassCode |
| BT-158-1 | Item Classification Code (scheme) | classification_code_scheme | rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:DesignatedProductClassification/ram:ClassCode/@listID |
| BT-159 | Item Origin Country | item_origin_country | rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:OriginTradeCountry/ram:ID |
| BT-160 | Additional Item Property (Name) | additional_item_properties_attributes[].name | rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:ApplicableProductCharacteristic/ram:Description |
| BT-161 | Additional Item Property (Value) | additional_item_properties_attributes[].value | rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:ApplicableProductCharacteristic/ram:Value |