JSR Tax Advisors logoAPI
Developer APIsReference documentation

Purchase invoice request payload


UBL-aligned JSON request field catalogue for POST /api/purchase-invoices/{customer_profile_id}. Maps each PINT OM business term to the API JSON path.

Syntax reference: PINT OM syntax binding

Validation: Enforced by PINT rule engines — see PINT UBL validation and jurisdiction-aligned rules.

Engineering mapping: Purchase Invoice Peppol Field Mapping (model fields, source legend, known gaps).

Cardinality legend

NotationMeaning
0..1Optional; maximum one occurrence
1..1Mandatory; exactly one occurrence
1..nMandatory; one or more occurrences
0..nOptional; zero or more occurrences

Semantic cardinality reflects the PINT business term. Syntax cardinality reflects the UBL XML element.

Party and line conventions

  • Line items: document_lines[]

  • Supplier party: accounting_supplier_party (from customer profile on self-billed purchase docs)

  • Customer party: accounting_customer_party

  • Transaction type: transaction_type (BTOM-001, 20-character bitmap)

  • Seller UUID: seller_uuid (BTOM-004; auto-generated when omitted)

Syntax element column mirrors the expanded Peppol syntax tree (including nested cac: / cbc: containers). • prefix in Term indicates nesting depth.

Field catalogue

BT IDTermSyntax elementJSON pathSemantic cardinalitySyntax cardinalityRequired on createValidation rulesExample
ubl:Invoiceubl:Invoice1..1NoStructural UBL container
IBT-024Specification identifiercbc:CustomizationID1..11..1NoSystem/xml-only; not in request body
IBT-023Business process typecbc:ProfileID1..11..1NoSystem/xml-only; not in request body
IBT-001Invoice numbercbc:IDdocument_number1..11..1YesRequired for API create; unique within organizationPINV-INT-001
BTOM-002Unique Identifier Numbercbc:UUIDuuid1..11..1NoSystem/xml-only; not in request body
IBT-002Invoice issue datecbc:IssueDateissue_date1..11..1YesFormat yyyy-MM-dd (IBR-003)2026-04-22
IBT-168Invoice issue timecbc:IssueTimeissue_time0..10..1NoFormat HH:mm:ss when provided10:30:00
IBT-009Payment due datecbc:DueDatedue_date0..10..1NoFormat yyyy-MM-dd2026-05-22
BTOM-001• Invoice transaction type@nametransaction_type1..11..1YesExactly 20 characters; each 1 or X (bitmap)1XXXXXXXXXXXXXXXXXXX
IBT-022Invoice notecbc:Notenote0..10..1NoSee PINT UBL rules and jurisdiction rules
IBT-007VAT point datecbc:TaxPointDatetax_point_date0..10..1NoFormat yyyy-MM-dd; defaults to issue_date if omitted
IBT-005Invoice currency codecbc:DocumentCurrencyCodedocument_currency_code1..11..1YesValid ISO 4217 code; default OMROMR
IBT-006VAT accounting currencycbc:TaxCurrencyCodetax_currency_code0..10..1NoSee PINT UBL rules and jurisdiction rules
IBT-019Buyer accounting referencecbc:AccountingCostaccounting_cost0..10..1NoSee PINT UBL rules and jurisdiction rules
IBT-010Buyer referencecbc:BuyerReferencebuyer_reference0..10..1NoSee PINT UBL rules and jurisdiction rules
IBG-14INVOICING PERIODcac:InvoicePeriod0..10..1NoSee PINT UBL rules
IBT-073• Invoicing period start datecbc:StartDateinvoice_period.start_date0..10..1NoSee PINT UBL rules and jurisdiction rules
IBT-074• Invoicing period end datecbc:EndDateinvoice_period.end_date0..10..1NoSee PINT UBL rules and jurisdiction rules
IBT-008• VAT point date codecbc:DescriptionCode0..10..1NoSee PINT UBL rules
Order and sales order referencecac:OrderReference0..1NoStructural UBL container
IBT-013• Purchase order referencecbc:IDorder_reference.id0..11..1NoSee PINT UBL rules and jurisdiction rules
IBT-014• Sales order referencecbc:SalesOrderIDorder_reference.sales_order_id0..10..1NoSee PINT UBL rules and jurisdiction rules
IBG-03PRECEDING INVOICE REFERENCEcac:BillingReferencebilling_reference[]0..n0..nNoSee PINT UBL rules and jurisdiction rules
• Invoice document referencecac:BillingReference/cac:InvoiceDocumentReference1..1NoStructural UBL container
IBT-025•• Preceding Invoice referencecbc:IDbilling_reference[].id1..11..1YesSee PINT UBL rules and jurisdiction rules
BTOM-031•• UUIDcbc:UUIDbilling_reference[].uuid0..10..1NoSee PINT UBL rules
IBT-026•• Preceding Invoice issue datecbc:IssueDatebilling_reference[].issue_date0..10..1NoSee PINT UBL rules and jurisdiction rules
BTOM-032•• Credit Note or Debit Note reason codecbc:DocumentStatusCode0..10..1NoSee PINT UBL rules
Despatch advice referencecac:DespatchDocumentReference0..1NoStructural UBL container
IBT-016• Despatch advice referencecbc:IDdespatch_document_reference.id0..11..1NoSee PINT UBL rules and jurisdiction rules
Receipt advice referencecac:ReceiptDocumentReference0..1NoStructural UBL container
IBT-015• Receiving advice referencecbc:IDreceipt_document_reference.id0..11..1NoSee PINT UBL rules and jurisdiction rules
BGOM-03PREPAYMENT DOCUMENT REFERENCEcac:OriginatorDocumentReference[cbc:ID = "Prepayment invoice number value"]0..n0..nNoSee PINT UBL rules
BTOM-027• Prepayment invoice numbercbc:IDprepayment_invoice_reference.id0..11..1NoSee PINT UBL rules and jurisdiction rules
BTOM-014• Prepayment invoice UUIDcbc:UUIDprepayment_invoice_reference.uuid0..10..1NoSee PINT UBL rules and jurisdiction rules
Tender or Lot referencecac:OriginatorDocumentReference0..1NoStructural UBL container
IBT-017• Tender or lot referencecbc:IDoriginator_document_reference.id0..11..1NoSee PINT UBL rules and jurisdiction rules
Contract referencecac:ContractDocumentReference0..1NoStructural UBL container
IBT-012• Contract referencecbc:IDcontract_document_reference.id0..11..1NoSee PINT UBL rules and jurisdiction rules
BGOM-05PROFIT MARGIN DETAILScac:AdditionalDocumentReference[cbc:DocumentTypeCode = "PM_TOTAL"]0..10..1NoSee PINT UBL rules
BTOM-020-1• Profit margin currencycbc:ID0..11..1NoSee PINT UBL rules
BTOM-020-2• Fixed value as: PM_TOTALcbc:DocumentTypeCode0..11..1NoSee PINT UBL rules
BTOM-020• Total amount due (profit margin)cbc:DocumentDescription0..11..1NoSee PINT UBL rules
Additional document reference classcac:AdditionalDocumentReference[cbc:DocumentTypeCode = 130]0..1NoStructural UBL container
IBT-018• Invoiced object identifiercbc:ID0..11..1NoSee PINT UBL rules
IBT-018-1•• The identification scheme identifier of the Invoiced object identifier.@schemeID0..10..1NoSee PINT UBL rules
• Qualifier for syntax bindingcac:AdditionalDocumentReference[cbc:DocumentTypeCode = 130]/cbc:DocumentTypeCode1..1NoStructural UBL container
IBG-24ADDITIONAL SUPPORTING DOCUMENTScac:AdditionalDocumentReference[cbc:DocumentTypeCode != 130]attachments[]0..n0..nNoSee PINT UBL rules and jurisdiction rules
IBT-122• Supporting document referencecbc:IDattachments[].id (generated)1..11..1YesSee PINT UBL rules and jurisdiction rules
BTOM-023• Supporting document UUIDcbc:UUID0..10..1NoSee PINT UBL rules
IBT-123• Supporting document descriptioncbc:DocumentDescription0..10..1NoSee PINT UBL rules
• Attachmentcac:AdditionalDocumentReference[cbc:DocumentTypeCode != 130]/cac:Attachment0..1NoStructural UBL container
IBT-125•• Attached documentcbc:EmbeddedDocumentBinaryObjectattachments[].file_content0..10..1NoSee PINT UBL rules and jurisdiction rules
IBT-125-1••• Attached document Mime code@mimeCodeattachments[].file_type1..11..1YesSee PINT UBL rules and jurisdiction rules
IBT-125-2••• Attached document Filename@filenameattachments[].file_name1..11..1YesSee PINT UBL rules and jurisdiction rules
•• External referencecac:AdditionalDocumentReference[cbc:DocumentTypeCode != 130]/cac:Attachment/cac:ExternalReference0..1NoStructural UBL container
IBT-124••• External document locationcbc:URI0..11..1NoSee PINT UBL rules
Project referencecac:ProjectReference0..1NoStructural UBL container
IBT-011• Project referencecbc:IDproject_reference.id0..11..1NoSee PINT UBL rules and jurisdiction rules
IBG-04SELLERcac:AccountingSupplierPartyaccounting_supplier_party1..11..1YesSee PINT UBL rules and jurisdiction rules
BTOM-004• Seller UUIDcbc:AdditionalAccountIDseller_uuid0..10..1No (auto-generated if omitted)See PINT UBL rules and jurisdiction rules
• Partycac:AccountingSupplierParty/cac:Party1..1NoStructural UBL container
IBT-034•• Seller electronic addresscbc:EndpointIDaccounting_supplier_party.endpoint_id1..11..1YesSee PINT UBL rules and jurisdiction rulesSELLER1234
IBT-034-1••• Seller electronic address identification scheme identifier@schemeIDaccounting_supplier_party.endpoint_scheme_id1..11..1YesSee PINT UBL rules and jurisdiction rules001
•• cac:PartyIdentificationcac:AccountingSupplierParty/cac:Party/cac:PartyIdentification0..nNoStructural UBL container
IBT-029-1•••• Scheme identifier@schemeID0..10..1NoSee PINT UBL rules
BTOM-015•••• Seller Identifier (textual code)@schemeName0..10..1NoSee PINT UBL rules
•• Bank assigned creditor identifiercac:AccountingSupplierParty/cac:Party/cac:PartyIdentification[cac:ID/@schemeID = "SEPA"]0..1NoStructural UBL container
IBT-090••• Bank assigned creditor identifiercbc:ID0..11..1NoSee PINT UBL rules
•••• Seller or bank assigned creditor identifier identification scheme identifiercac:AccountingSupplierParty/cac:Party/cac:PartyIdentification[cac:ID/@schemeID = "SEPA"]/cbc:ID/@schemeID1..1NoStructural UBL container
•• Party namecac:AccountingSupplierParty/cac:Party/cac:PartyName0..1NoStructural UBL container
IBT-028••• Seller trading namecbc:Nameaccounting_supplier_party.party_name0..11..1NoSee PINT UBL rules and jurisdiction rulesSeller Business
IBG-05•• SELLER POSTAL ADDRESScac:PostalAddressaccounting_supplier_party.postal_address1..11..1YesSee PINT UBL rules and jurisdiction rules
IBT-035••• Seller address line 1 - postal codecbc:StreetNameaccounting_supplier_party.postal_address.street_name1..11..1YesSee PINT UBL rules and jurisdiction rules123 Seller St
IBT-036••• Seller address line 2 - postal code areacbc:AdditionalStreetNameaccounting_supplier_party.postal_address.additional_street_name1..11..1YesSee PINT UBL rules and jurisdiction rules
IBT-037••• Seller citycbc:CityNameaccounting_supplier_party.postal_address.city_name1..11..1YesSee PINT UBL rules and jurisdiction rulesMuscat
IBT-038••• Seller post code - PO Box numbercbc:PostalZoneaccounting_supplier_party.postal_address.postal_zone1..11..1YesSee PINT UBL rules and jurisdiction rules12345
IBT-039••• Seller country subdivisioncbc:CountrySubentityaccounting_supplier_party.postal_address.country_subentity0..10..1NoCL-13-OM country subdivision code (MO, SHRFZ, SEZAD, SLLFZ, AFZ)MA
BTOM-024••• Seller country subdivision codecbc:CountrySubentityCode0..10..1NoSee PINT UBL rules
••• Address linecac:AccountingSupplierParty/cac:Party/cac:PostalAddress/cac:AddressLine1..1NoStructural UBL container
IBT-162•••• Seller address line 3 - areacbc:Lineaccounting_supplier_party.postal_address.address_line1..11..1YesSee PINT UBL rules and jurisdiction rules
••• Countrycac:AccountingSupplierParty/cac:Party/cac:PostalAddress/cac:Country1..1NoStructural UBL container
IBT-040•••• Seller country codecbc:IdentificationCodeaccounting_supplier_party.postal_address.country_code1..11..1YesOMR addresses require country_subentity emirate codeOM
•• PARTY TAXcac:AccountingSupplierParty/cac:Party/cac:PartyTaxScheme[cac:TaxScheme = "VAT"]0..1NoStructural UBL container
IBT-031••• Seller VATINcbc:CompanyIDaccounting_supplier_party.party_tax_scheme.company_id0..11..1NoTRN format per OTA; tax scheme must be VATOM1100537271
••• TAX SCHEMEcac:AccountingSupplierParty/cac:Party/cac:PartyTaxScheme[cac:TaxScheme = "VAT"]/cac:TaxScheme1..1NoStructural UBL container
IBT-031-1•••• Tax scheme codecbc:IDaccounting_supplier_party.party_tax_scheme.tax_scheme1..11..1YesMust be VAT for OMN partiesVAT
•• PARTY TAXcac:AccountingSupplierParty/cac:Party/cac:PartyTaxScheme[cac:TaxScheme != "VAT"]0..1NoStructural UBL container
IBT-032••• Seller tax registration identifiercbc:CompanyIDaccounting_supplier_party.tin0..11..1NoSee PINT UBL rules and jurisdiction rules
••• TAX SCHEMEcac:AccountingSupplierParty/cac:Party/cac:PartyTaxScheme[cac:TaxScheme != "VAT"]/cac:TaxScheme1..1NoStructural UBL container
•••• Tax scheme codecac:AccountingSupplierParty/cac:Party/cac:PartyTaxScheme[cac:TaxScheme != "VAT"]/cac:TaxScheme/cbc:ID1..1NoStructural UBL container
•• Party legal entitycac:AccountingSupplierParty/cac:Party/cac:PartyLegalEntity1..1NoStructural UBL container
IBT-027••• Seller namecbc:RegistrationNameaccounting_supplier_party.party_name1..11..1YesSee PINT UBL rules and jurisdiction rulesSeller Business
IBT-030••• Seller legal registration identifiercbc:CompanyIDaccounting_supplier_party.company_id0..10..1NoSee PINT UBL rules and jurisdiction rules265627835
IBT-030-1•••• Scheme identifier@schemeIDaccounting_supplier_party.company_scheme_id0..10..1NoSee PINT UBL rules and jurisdiction rules
IBT-033••• Seller additional legal informationcbc:CompanyLegalFormaccounting_supplier_party.company_legal_form0..10..1NoSee PINT UBL rules and jurisdiction rules
IBG-06•• SELLER CONTACTcac:Contactaccounting_supplier_party (contact)0..10..1NoSee PINT UBL rules and jurisdiction rules
IBT-041••• Seller contact pointcbc:Nameaccounting_supplier_party.name0..10..1NoSee PINT UBL rules and jurisdiction rulesSeller Party
IBT-042••• Seller contact telephone numbercbc:Telephoneaccounting_supplier_party.telephone1..11..1YesSee PINT UBL rules and jurisdiction rules
IBT-043••• Seller contact email addresscbc:ElectronicMailaccounting_supplier_party.email0..10..1NoSee PINT UBL rules and jurisdiction rules
BGOM-01•• THIRD PARTY DETAILScac:AgentParty0..10..1NoSee PINT UBL rules
••• PARTY NAMEcac:AccountingSupplierParty/cac:Party/cac:AgentParty/cac:PartyName0..1NoStructural UBL container
BTOM-005•••• Third Party Namecbc:Nameaccounting_supplier_party.third_party.name0..11..1NoSee PINT UBL rules
BGOM-02••• THIRD PARTY POSTAL ADDRESScac:PostalAddress0..10..1NoSee PINT UBL rules
BTOM-007•••• Third Party Address Line 1cbc:StreetNameaccounting_supplier_party.third_party.postal_address.street_name0..10..1NoSee PINT UBL rules
BTOM-008•••• Third Party Address Line 2cbc:AdditionalStreetNameaccounting_supplier_party.third_party.postal_address.additional_street_name0..10..1NoSee PINT UBL rules
BTOM-010•••• Third Party Citycbc:CityNameaccounting_supplier_party.third_party.postal_address.city_name0..10..1NoSee PINT UBL rules
BTOM-011•••• Third Party Postal Code - PO Box Numbercbc:PostalZoneaccounting_supplier_party.third_party.postal_address.postal_zone0..10..1NoSee PINT UBL rules
BTOM-012•••• Third Party Country Subdivisioncbc:CountrySubentityaccounting_supplier_party.third_party.postal_address.country_subentity0..10..1NoSee PINT UBL rules
BTOM-012-1•••• Third Party Country Subdivision Codecbc:CountrySubentityCode0..10..1NoSee PINT UBL rules
•••• ADDRESS LINEcac:AccountingSupplierParty/cac:Party/cac:AgentParty/cac:PostalAddress/cac:AddressLine0..1NoStructural UBL container
BTOM-009••••• Third Party Address Line 3cbc:Lineaccounting_supplier_party.third_party.postal_address.address_line0..11..1NoSee PINT UBL rules
•••• COUNTRYcac:AccountingSupplierParty/cac:Party/cac:AgentParty/cac:PostalAddress/cac:Country1..1NoStructural UBL container
BTOM-013••••• Third Party Country Codecbc:IdentificationCodeaccounting_supplier_party.third_party.postal_address.country_code0..11..1NoSee PINT UBL rules
••• PARTY TAXcac:AccountingSupplierParty/cac:Party/cac:AgentParty/cac:PartyTaxScheme0..1NoStructural UBL container
BTOM-006•••• Third Party VATIN.cbc:CompanyIDaccounting_supplier_party.third_party.vat_identifier0..11..1NoSee PINT UBL rules
•••• TAX SCHEMEcac:AccountingSupplierParty/cac:Party/cac:AgentParty/cac:PartyTaxScheme/cac:TaxScheme1..1NoStructural UBL container
BTOM-006-1••••• Tax scheme codecbc:IDaccounting_supplier_party.third_party.tax_scheme_code1..11..1NoSee PINT UBL rules
IBG-07BUYERcac:AccountingCustomerPartyaccounting_customer_party1..11..1No (from buyer profile)See PINT UBL rules and jurisdiction rules
• Partycac:AccountingCustomerParty/cac:Party1..1NoStructural UBL container
IBT-049•• Buyer electronic addresscbc:EndpointIDaccounting_customer_party.endpoint_id1..11..1No (from buyer profile)See PINT UBL rules and jurisdiction rules
IBT-049-1••• Scheme identifier@schemeIDaccounting_customer_party.endpoint_scheme_id1..11..1No (from buyer profile)See PINT UBL rules and jurisdiction rules
•• cac:PartyIdentificationcac:AccountingCustomerParty/cac:Party/cac:PartyIdentification0..1NoStructural UBL container
IBT-046-1•••• Scheme identifier@schemeID0..10..1NoSee PINT UBL rules
BTOM-018•••• Buyer Identifier (textual code)@schemeName0..10..1NoSee PINT UBL rules
•• Party namecac:AccountingCustomerParty/cac:Party/cac:PartyName0..1NoStructural UBL container
IBT-045••• Buyer trading namecbc:Nameaccounting_customer_party.party_name0..11..1No (from buyer profile)See PINT UBL rules and jurisdiction rules
IBG-08•• BUYER POSTAL ADDRESScac:PostalAddressaccounting_customer_party.postal_address1..11..1No (from buyer profile)See PINT UBL rules and jurisdiction rules
IBT-050••• Buyer address line 1 - postal codecbc:StreetNameaccounting_customer_party.postal_address.street_name1..11..1No (from buyer profile)See PINT UBL rules and jurisdiction rules
IBT-051••• Buyer address line 2 - postal code areacbc:AdditionalStreetNameaccounting_customer_party.postal_address.additional_street_name1..11..1No (from buyer profile)See PINT UBL rules and jurisdiction rules
IBT-052••• Buyer citycbc:CityNameaccounting_customer_party.postal_address.city_name1..11..1No (from buyer profile)See PINT UBL rules and jurisdiction rules
IBT-053••• Buyer post code - PO Box numbercbc:PostalZoneaccounting_customer_party.postal_address.postal_zone1..11..1No (from buyer profile)See PINT UBL rules and jurisdiction rules
IBT-054••• Buyer country subdivisioncbc:CountrySubentityaccounting_customer_party.postal_address.country_subentity0..10..1No (from buyer profile)CL-13-OM country subdivision code (MO, SHRFZ, SEZAD, SLLFZ, AFZ)
BTOM-026••• Buyer country subdivision codecbc:CountrySubentityCode0..10..1NoSee PINT UBL rules
••• Address linecac:AccountingCustomerParty/cac:Party/cac:PostalAddress/cac:AddressLine1..1NoStructural UBL container
IBT-163•••• Buyer address line 3 - areacbc:Lineaccounting_customer_party.postal_address.address_line1..11..1No (from buyer profile)See PINT UBL rules and jurisdiction rules
••• Countrycac:AccountingCustomerParty/cac:Party/cac:PostalAddress/cac:Country1..1NoStructural UBL container
IBT-055•••• Buyer country codecbc:IdentificationCodeaccounting_customer_party.postal_address.country_code1..11..1No (from buyer profile)OMR addresses require country_subentity emirate code
•• PARTY TAXcac:AccountingCustomerParty/cac:Party/cac:PartyTaxScheme0..1NoStructural UBL container
IBT-048••• Buyer VATINcbc:CompanyIDaccounting_customer_party.party_tax_scheme.company_id0..11..1No (from buyer profile)TRN format per OTA; tax scheme must be VAT
••• TAX SCHEMEcac:AccountingCustomerParty/cac:Party/cac:PartyTaxScheme/cac:TaxScheme1..1NoStructural UBL container
IBT-048-1•••• Tax scheme codecbc:IDaccounting_customer_party.party_tax_scheme.tax_scheme1..11..1No (from buyer profile)Must be VAT for OMN parties
•• Party legal entitycac:AccountingCustomerParty/cac:Party/cac:PartyLegalEntity1..1NoStructural UBL container
IBT-044••• Buyer namecbc:RegistrationNameaccounting_customer_party.party_name1..11..1No (from buyer profile)See PINT UBL rules and jurisdiction rules
IBT-047••• Buyer legal registration identifiercbc:CompanyIDaccounting_customer_party.company_id0..10..1No (from buyer profile)See PINT UBL rules and jurisdiction rules
IBT-047-1•••• Scheme identifier@schemeIDaccounting_customer_party.company_scheme_id0..10..1No (from buyer profile)See PINT UBL rules and jurisdiction rules
IBG-09•• BUYER CONTACTcac:Contactaccounting_customer_party (contact)0..10..1No (from buyer profile)See PINT UBL rules and jurisdiction rules
IBT-056••• Buyer contact pointcbc:Nameaccounting_customer_party.name0..10..1No (from buyer profile)See PINT UBL rules and jurisdiction rules
IBT-057••• Buyer contact telephone numbercbc:Telephoneaccounting_customer_party.telephone0..10..1No (from buyer profile)See PINT UBL rules and jurisdiction rules
IBT-058••• Buyer contact email addresscbc:ElectronicMailaccounting_customer_party.email0..10..1No (from buyer profile)See PINT UBL rules and jurisdiction rules
IBG-10Payeecac:PayeePartypayee_party0..10..1NoSee PINT UBL rules and jurisdiction rules
• PARTY IDENTIFICATIONcac:PayeeParty/cac:PartyIdentification0..1NoStructural UBL container
IBT-060•• Payee identifiercbc:IDpayee_party.party_identification_id0..11..1NoSee PINT UBL rules and jurisdiction rules
IBT-060-1••• Scheme identifier@schemeID0..10..1NoSee PINT UBL rules
• Party namecac:PayeeParty/cac:PartyName1..1NoStructural UBL container
IBT-059•• Payee namecbc:Namepayee_party.party_name1..11..1YesSee PINT UBL rules and jurisdiction rules
• Party legal entitycac:PayeeParty/cac:PartyLegalEntity0..1NoStructural UBL container
IBT-061•• Payee legal registration identifiercbc:CompanyIDpayee_party.company_id0..11..1NoSee PINT UBL rules and jurisdiction rules
IBT-061-1••• Scheme identifier@schemeIDpayee_party.company_scheme_id0..10..1NoSee PINT UBL rules and jurisdiction rules
IBG-11SELLER TAX REPRESENTATIVE PARTYcac:TaxRepresentativePartytax_representative_party0..10..1NoSee PINT UBL rules and jurisdiction rules
• Party namecac:TaxRepresentativeParty/cac:PartyName0..1NoStructural UBL container
IBT-062•• Seller tax representative namecbc:Nametax_representative_party.name1..11..1YesSee PINT UBL rules and jurisdiction rules
IBG-12• SELLER TAX REPRESENTATIVE POSTAL ADDRESScac:PostalAddresstax_representative_party.postal_address1..11..1YesSee PINT UBL rules and jurisdiction rules
IBT-064•• Tax representative address line 1cbc:StreetNametax_representative_party.postal_address.street_name0..10..1NoSee PINT UBL rules and jurisdiction rules
IBT-065•• Tax representative address line 2cbc:AdditionalStreetNametax_representative_party.postal_address.additional_street_name0..10..1NoSee PINT UBL rules and jurisdiction rules
IBT-066•• Tax representative citycbc:CityNametax_representative_party.postal_address.city_name0..10..1NoSee PINT UBL rules and jurisdiction rules
IBT-067•• Tax representative post codecbc:PostalZonetax_representative_party.postal_address.postal_zone0..10..1NoSee PINT UBL rules and jurisdiction rules
IBT-068•• Tax representative country subdivisioncbc:CountrySubentitytax_representative_party.postal_address.country_subentity0..10..1NoCL-13-OM country subdivision code (MO, SHRFZ, SEZAD, SLLFZ, AFZ)
•• Address linecac:TaxRepresentativeParty/cac:PostalAddress/cac:AddressLine0..1NoStructural UBL container
IBT-164••• Tax representative address line 3cbc:Linetax_representative_party.postal_address.address_line0..11..1NoSee PINT UBL rules and jurisdiction rules
•• Countrycac:TaxRepresentativeParty/cac:PostalAddress/cac:Country1..1NoStructural UBL container
IBT-069••• Tax representative country codecbc:IdentificationCodetax_representative_party.postal_address.country_code1..11..1YesSee PINT UBL rules and jurisdiction rules
• PARTY TAXcac:TaxRepresentativeParty/cac:PartyTaxScheme0..1NoStructural UBL container
IBT-063•• Seller tax representative tax identifiercbc:CompanyIDtax_representative_party.party_tax_scheme.company_id0..10..1NoMust be VAT for OMN parties
•• TAX SCHEMEcac:TaxRepresentativeParty/cac:PartyTaxScheme/cac:TaxScheme1..1NoStructural UBL container
IBT-063-1••• Tax scheme codecbc:IDtax_representative_party.party_tax_scheme.tax_scheme1..11..1YesMust be VAT for OMN parties
IBG-13DELIVERY INFORMATIONcac:Deliverydelivery0..10..1NoSee PINT UBL rules and jurisdiction rules
IBT-072• Actual delivery datecbc:ActualDeliveryDatedelivery.actual_delivery_date0..10..1NoSee PINT UBL rules and jurisdiction rules
• cac:DeliveryLocationcac:Delivery/cac:DeliveryLocation0..1NoStructural UBL container
IBT-071•• Deliver to location identifiercbc:IDdelivery.delivery_location.id0..10..1NoSee PINT UBL rules and jurisdiction rules
IBT-071-1••• Scheme identifier@schemeID0..10..1NoSee PINT UBL rules
IBG-15•• DELIVER TO ADDRESScac:Addressdelivery.delivery_location.address0..10..1NoSee PINT UBL rules and jurisdiction rules
IBT-075••• Deliver to address line 1 - postal codecbc:StreetNamedelivery.delivery_location.address.street_name0..10..1NoSee PINT UBL rules and jurisdiction rules
IBT-076••• Deliver to address line 2 - postal code areacbc:AdditionalStreetNamedelivery.delivery_location.address.additional_street_name0..10..1NoSee PINT UBL rules and jurisdiction rules
IBT-077••• Deliver to citycbc:CityNamedelivery.delivery_location.address.city_name0..10..1NoSee PINT UBL rules and jurisdiction rules
IBT-078••• Deliver to post code - PO Box numbercbc:PostalZonedelivery.delivery_location.address.postal_zone0..10..1NoSee PINT UBL rules and jurisdiction rules
IBT-079••• Deliver to country subdivisioncbc:CountrySubentitydelivery.delivery_location.address.country_subentity0..10..1NoCL-13-OM country subdivision code (MO, SHRFZ, SEZAD, SLLFZ, AFZ)
••• Address linecac:Delivery/cac:DeliveryLocation/cac:Address/cac:AddressLine0..1NoStructural UBL container
IBT-165•••• Deliver to address line 3 - areacbc:Linedelivery.delivery_location.address.address_line0..11..1NoSee PINT UBL rules and jurisdiction rules
••• Countrycac:Delivery/cac:DeliveryLocation/cac:Address/cac:Country1..1NoStructural UBL container
IBT-080•••• Deliver to country codecbc:IdentificationCodedelivery.delivery_location.address.country_code1..11..1YesSee PINT UBL rules and jurisdiction rules
• DELIVER PARTYcac:Delivery/cac:DeliveryParty0..1NoStructural UBL container
•• PARTY NAMEcac:Delivery/cac:DeliveryParty/cac:PartyName1..1NoStructural UBL container
IBT-070••• Deliver to party namecbc:Namedelivery.party_name0..11..1NoSee PINT UBL rules and jurisdiction rules
• INCOTERMScac:Delivery/cac:DeliveryTerms0..1NoStructural UBL container
BTOM-022•• Incotermscbc:ID[schemeID = "incoterms"]delivery.terms0..11..1NoSee PINT UBL rules
••• Scheme identifiercac:Delivery/cac:DeliveryTerms/cbc:ID[schemeID = "incoterms"]/@schemeID1..1NoStructural UBL container
• SHIPMENTcac:Delivery/cac:Shipment0..1NoStructural UBL container
BTOM-021•• Customs Declaration numbercbc:IDstatement_document_reference.id0..11..1NoSee PINT UBL rules
•• SHIPMENT DELIVERYcac:Delivery/cac:Shipment/cac:Delivery0..1NoStructural UBL container
BTOM-030••• Import datecbc:ActualDeliveryDate0..10..1NoSee PINT UBL rules
IBG-16PAYMENT INSTRUCTIONScac:PaymentMeanspayment_means0..n0..nNoSee PINT UBL rules and jurisdiction rules
IBT-178• Payment Instructions IDcbc:IDpayment_means.id0..10..1NoSee PINT UBL rules and jurisdiction rules
IBT-081• Payment means type codecbc:PaymentMeansCodepayment_means.payment_means_code1..11..1YesRequired when transaction_type position 2 is X (IBR-049)54
IBT-082•• Payment means text@name0..10..1NoSee PINT UBL rules
IBT-083• Remittance informationcbc:PaymentIDpayment_means.payment_id[]0..n0..nNoSee PINT UBL rules and jurisdiction rules
IBT-083-1•• Scheme identifier@schemeID0..10..1NoSee PINT UBL rules
IBG-18• PAYMENT CARD INFORMATIONcac:CardAccountpayment_means.card_account0..10..1NoSee PINT UBL rules and jurisdiction rules
IBT-087•• Payment card primary account numbercbc:PrimaryAccountNumberIDpayment_means.card_account.primary_account_number_id1..11..1YesSee PINT UBL rules and jurisdiction rules4286
•• cbc:NetworkIDcac:PaymentMeans/cac:CardAccount/cbc:NetworkID1..1NoStructural UBL container
IBT-088•• Payment card holder namecbc:HolderNamepayment_means.card_account.holder_name0..10..1NoSee PINT UBL rules and jurisdiction rules
IBG-17• CREDIT TRANSFERcac:PayeeFinancialAccountpayment_means.payee_financial_account0..10..1NoSee PINT UBL rules and jurisdiction rules
IBT-084•• Payment account identifiercbc:IDpayment_means.payee_financial_account.id1..11..1YesSee PINT UBL rules and jurisdiction rules
IBT-084-1••• Scheme identifier@schemeID0..10..1NoSee PINT UBL rules
IBT-085•• Payment account namecbc:Namepayment_means.payee_financial_account.name0..10..1NoSee PINT UBL rules and jurisdiction rules
•• FINANCIAL INSTITUTION BRANCHcac:PaymentMeans/cac:PayeeFinancialAccount/cac:FinancialInstitutionBranch0..1NoStructural UBL container
IBT-086••• Payment service provider identifiercbc:IDpayment_means.payee_financial_account.financial_institution_branch_id0..11..1NoSee PINT UBL rules and jurisdiction rules
IBG-34••• FINANCIAL INSTITUTION ADDRESScac:Addresspayment_means.payee_financial_account.address0..10..1NoSee PINT UBL rules and jurisdiction rules
IBT-169•••• Account address line 1cbc:StreetNamepayment_means.payee_financial_account.address.street_name0..10..1NoSee PINT UBL rules and jurisdiction rules
IBT-170•••• Account address line 2cbc:AdditionalStreetNamepayment_means.payee_financial_account.address.additional_street_name0..10..1NoSee PINT UBL rules and jurisdiction rules
IBT-171•••• Account citycbc:CityNamepayment_means.payee_financial_account.address.city_name0..10..1NoSee PINT UBL rules and jurisdiction rules
IBT-172•••• Account post codecbc:PostalZonepayment_means.payee_financial_account.address.postal_zone0..10..1NoSee PINT UBL rules and jurisdiction rules
IBT-173•••• Account country subdivisioncbc:CountrySubentitypayment_means.payee_financial_account.address.country_subentity0..10..1NoCL-13-OM country subdivision code (MO, SHRFZ, SEZAD, SLLFZ, AFZ)
•••• cac:AddressLinecac:PaymentMeans/cac:PayeeFinancialAccount/cac:FinancialInstitutionBranch/cac:Address/cac:AddressLine0..1NoStructural UBL container
IBT-174••••• Account address line 3cbc:Linepayment_means.payee_financial_account.address.address_line0..11..1NoSee PINT UBL rules and jurisdiction rules
•••• cac:Countrycac:PaymentMeans/cac:PayeeFinancialAccount/cac:FinancialInstitutionBranch/cac:Address/cac:Country0..1NoStructural UBL container
IBT-175••••• Account country codecbc:IdentificationCodepayment_means.payee_financial_account.address.country_code0..11..1NoSee PINT UBL rules and jurisdiction rules
IBG-19• DIRECT DEBITcac:PaymentMandatepayment_means.payment_mandate0..10..1NoSee PINT UBL rules and jurisdiction rules
IBT-089•• Mandate reference identifiercbc:IDpayment_means.payment_mandate.id0..10..1NoSee PINT UBL rules and jurisdiction rules
•• PAYER FINANCIAL ACCOUNTcac:PaymentMeans/cac:PaymentMandate/cac:PayerFinancialAccount0..1NoStructural UBL container
IBT-091••• Debited account identifiercbc:IDpayment_means.payment_mandate.payer_financial_account_id0..11..1NoSee PINT UBL rules and jurisdiction rules
IBG-33INVOICE TERMScac:PaymentTermspayment_terms0..n0..nNoSee PINT UBL rules and jurisdiction rules
IBT-187• Terms payment instructions IDcbc:PaymentMeansIDpayment_terms.payment_means_id0..10..1NoSee PINT UBL rules and jurisdiction rules
IBT-020• Payment termscbc:Notepayment_terms.note0..10..1NoSee PINT UBL rules and jurisdiction rules
IBT-176• Terms amountcbc:Amountpayment_terms.amount0..10..1NoSee PINT UBL rules and jurisdiction rules
•• Currency codecac:PaymentTerms/cbc:Amount/@currencyID1..1NoStructural UBL container
IBT-177• Terms installment due datecbc:InstallmentDueDatepayment_terms.installment_due_date0..10..1NoSee PINT UBL rules and jurisdiction rules
IBG-35PAID AMOUNTScac:PrepaidPayment0..n0..nNoSee PINT UBL rules
IBT-179• Payment identifiercbc:ID0..10..1NoSee PINT UBL rules
IBT-180• Paid amountcbc:PaidAmount0..10..1NoSee PINT UBL rules
•• Currency codecac:PrepaidPayment/cbc:PaidAmount/@currencyID1..1NoStructural UBL container
IBT-181• The date when the paid amount is debited to the invoice.cbc:ReceivedDate0..10..1NoSee PINT UBL rules
IBT-182• Payment typecbc:InstructionID0..10..1NoSee PINT UBL rules
IBG-20DOCUMENT LEVEL ALLOWANCEScac:AllowanceCharge[cbc:ChargeIndicator = false]allowances[]0..n0..nNoSee PINT UBL rules and jurisdiction rules
• Syntax binding qualifiercac:AllowanceCharge[cbc:ChargeIndicator = false]/cbc:ChargeIndicator1..1NoStructural UBL container
IBT-098• Document level allowance reason codecbc:AllowanceChargeReasonCodeallowances[].reason_code0..10..1NoSee PINT UBL rules and jurisdiction rules
IBT-097• Document level allowance reasoncbc:AllowanceChargeReasonallowances[].reason0..10..1NoSee PINT UBL rules and jurisdiction rules
IBT-094• Document level allowance percentagecbc:MultiplierFactorNumericallowances[].multiplier_factor_numeric0..10..1NoSee PINT UBL rules and jurisdiction rules
IBT-092• Document level allowance amountcbc:Amountallowances[].amount1..11..1YesSee PINT UBL rules and jurisdiction rules
•• Currency codecac:AllowanceCharge[cbc:ChargeIndicator = false]/cbc:Amount/@currencyID1..1NoStructural UBL container
IBT-093• Document level allowance base amountcbc:BaseAmountallowances[].base_amount0..10..1NoSee PINT UBL rules and jurisdiction rules
•• Currency codecac:AllowanceCharge[cbc:ChargeIndicator = false]/cbc:BaseAmount/@currencyID1..1NoStructural UBL container
• TAX CATEGORYcac:AllowanceCharge[cbc:ChargeIndicator = false]/cac:TaxCategory0..1NoStructural UBL container
IBT-095•• Document level allowance tax category codecbc:IDallowances[].tax_category.id0..11..1NoSee PINT UBL rules and jurisdiction rules
IBT-096•• Document level allowance tax ratecbc:Percentallowances[].tax_category.percent0..10..1NoNumeric VAT rate; required for taxable categories
IBT-196•• Document level allowance tax exemption reason codecbc:TaxExemptionReasonCodeallowances[].tax_category.tax_exemption_reason_code0..10..1NoSee PINT UBL rules and jurisdiction rules
IBT-197•• Document level allowance tax exemption reason textcbc:TaxExemptionReasonallowances[].tax_category.tax_exemption_reason0..10..1NoSee PINT UBL rules and jurisdiction rules
•• TAX SCHEMEcac:AllowanceCharge[cbc:ChargeIndicator = false]/cac:TaxCategory/cac:TaxScheme1..1NoStructural UBL container
IBT-095-1••• Tax scheme codecbc:IDallowances[].tax_category.tax_scheme1..11..1YesMust be VAT for OMN parties
IBG-21DOCUMENT LEVEL CHARGEScac:AllowanceCharge[cbc:ChargeIndicator = true]charges[]0..n0..nNoSee PINT UBL rules and jurisdiction rules
• Syntax binding qualifiercac:AllowanceCharge[cbc:ChargeIndicator = true]/cbc:ChargeIndicator1..1NoStructural UBL container
IBT-105• Document level charge reason codecbc:AllowanceChargeReasonCodecharges[].reason_code0..10..1NoSee PINT UBL rules and jurisdiction rules
IBT-104• Document level charge reasoncbc:AllowanceChargeReasoncharges[].reason0..10..1NoSee PINT UBL rules and jurisdiction rules
IBT-101• Document level charge percentagecbc:MultiplierFactorNumericcharges[].multiplier_factor_numeric0..10..1NoSee PINT UBL rules and jurisdiction rules
IBT-099• Document level charge amountcbc:Amountcharges[].amount1..11..1YesSee PINT UBL rules and jurisdiction rules
•• Currency codecac:AllowanceCharge[cbc:ChargeIndicator = true]/cbc:Amount/@currencyID1..1NoStructural UBL container
IBT-100• Document level charge base amountcbc:BaseAmountcharges[].base_amount0..10..1NoSee PINT UBL rules and jurisdiction rules
•• Currency codecac:AllowanceCharge[cbc:ChargeIndicator = true]/cbc:BaseAmount/@currencyID1..1NoStructural UBL container
• TAX CATEGORYcac:AllowanceCharge[cbc:ChargeIndicator = true]/cac:TaxCategory0..1NoStructural UBL container
IBT-102•• Document level charge tax category codecbc:IDcharges[].tax_category.id0..11..1NoSee PINT UBL rules and jurisdiction rules
IBT-103•• Document level charge tax ratecbc:Percentcharges[].tax_category.percent0..10..1NoNumeric VAT rate; required for taxable categories
IBT-198•• Document level charge tax exemption reason codecbc:TaxExemptionReasonCodecharges[].tax_category.tax_exemption_reason_code0..10..1NoSee PINT UBL rules and jurisdiction rules
IBT-199•• Document level charge tax exemption reason textcbc:TaxExemptionReasoncharges[].tax_category.tax_exemption_reason0..10..1NoSee PINT UBL rules and jurisdiction rules
•• TAX SCHEMEcac:AllowanceCharge[cbc:ChargeIndicator = true]/cac:TaxCategory/cac:TaxScheme1..1NoStructural UBL container
IBT-102-1••• Tax scheme codecbc:IDcharges[].tax_category.tax_scheme1..11..1YesMust be VAT for OMN parties
CURRENCY EXCHANGE RATEcac:TaxExchangeRate0..1NoStructural UBL container
BTOM-028• Source currency codecbc:SourceCurrencyCodetax_exchange_rate.source_currency_code1..11..1NoSee PINT UBL rules
BTOM-029• Target currency codecbc:TargetCurrencyCodetax_exchange_rate.target_currency_code1..11..1NoSee PINT UBL rules
BTOM-003• Calculation ratecbc:CalculationRatetax_exchange_rate.calculation_rate0..11..1NoSee PINT UBL rules
Tax totalcac:TaxTotal[cac:TaxTotal/TaxAmount/@currency = cbc:DocumentCurrencyCode]1..1NoStructural UBL container
IBT-110• Invoice total TAX amountcbc:TaxAmount1..11..1NoResponse-only; calculated by API
•• Currency codecac:TaxTotal[cac:TaxTotal/TaxAmount/@currency = cbc:DocumentCurrencyCode]/cbc:TaxAmount/@currencyID1..1NoStructural UBL container
IBT-200• Tax inclusive pricingcbc:TaxIncludedIndicator0..10..1NoSystem/xml-only; not in request body
IBG-23• TAX BREAKDOWNcac:TaxSubtotal1..n1..nNoResponse-only; calculated by API
IBT-116•• VAT category taxable amountcbc:TaxableAmount1..11..1NoResponse-only; calculated by API
••• Currency codecac:TaxTotal[cac:TaxTotal/TaxAmount/@currency = cbc:DocumentCurrencyCode]/cac:TaxSubtotal/cbc:TaxableAmount/@currencyID1..1NoStructural UBL container
IBT-117•• VAT category tax amountcbc:TaxAmount1..11..1NoResponse-only; calculated by API
••• Currency codecac:TaxTotal[cac:TaxTotal/TaxAmount/@currency = cbc:DocumentCurrencyCode]/cac:TaxSubtotal/cbc:TaxAmount/@currencyID1..1NoStructural UBL container
•• cac:TaxCategorycac:TaxTotal[cac:TaxTotal/TaxAmount/@currency = cbc:DocumentCurrencyCode]/cac:TaxSubtotal/cac:TaxCategory1..1NoStructural UBL container
IBT-118••• VAT category codecbc:ID1..11..1NoResponse-only; calculated by API
IBT-119••• VAT category ratecbc:Percent0..10..1NoResponse-only; calculated by API
IBT-121••• VAT exemption reason codecbc:TaxExemptionReasonCode0..10..1NoSee PINT UBL rules
IBT-120••• VAT exemption reason textcbc:TaxExemptionReason0..10..1NoSee PINT UBL rules
••• TAX SCHEMEcac:TaxTotal[cac:TaxTotal/TaxAmount/@currency = cbc:DocumentCurrencyCode]/cac:TaxSubtotal/cac:TaxCategory/cac:TaxScheme1..1NoStructural UBL container
IBT-118-1•••• Tax scheme codecbc:ID1..11..1NoResponse-only; calculated by API
IBG-37DOCUMENT TOTALS IN TAX ACCOUNTING CURRENCYcac:TaxTotal[cac:TaxTotal/TaxAmount/@currency = cbc:TaxCurrencyCode]0..10..1NoResponse-only; calculated by API
IBT-111• Invoice total VAT amount in tax accounting currencycbc:TaxAmount0..11..1NoResponse-only; calculated by API
•• Currency codecac:TaxTotal[cac:TaxTotal/TaxAmount/@currency = cbc:TaxCurrencyCode]/cbc:TaxAmount/@currencyID1..1NoStructural UBL container
IBG-38• One of the subtotals the sum of which equals the total tax amount for a particular taxation scheme.cac:TaxSubtotal0..n0..nNoSee PINT UBL rules
IBT-190•• TAX category tax amount in accounting currencycbc:TaxAmount0..10..1NoSee PINT UBL rules
••• Currency codecac:TaxTotal[cac:TaxTotal/TaxAmount/@currency = cbc:TaxCurrencyCode]/cac:TaxSubtotal/cbc:TaxAmount/@currencyID1..1NoStructural UBL container
•• The tax category applicable to this subtotalcac:TaxTotal[cac:TaxTotal/TaxAmount/@currency = cbc:TaxCurrencyCode]/cac:TaxSubtotal/cac:TaxCategory0..1NoStructural UBL container
IBT-192••• TAX category code for tax category tax amount in accounting currencycbc:ID0..10..1NoSee PINT UBL rules
IBT-193••• TAX category rate for tax category tax amount in accounting currencycbc:Percent0..10..1NoSee PINT UBL rules
IBG-22DOCUMENT TOTALScac:LegalMonetaryTotal1..11..1NoResponse-only; calculated by API
IBT-106• Sum of Invoice line net amountcbc:LineExtensionAmount1..11..1NoResponse-only; calculated by API
•• Currency codecac:LegalMonetaryTotal/cbc:LineExtensionAmount/@currencyID1..1NoStructural UBL container
IBT-109• Invoice total amount without VATcbc:TaxExclusiveAmount1..11..1NoResponse-only; calculated by API
•• Currency codecac:LegalMonetaryTotal/cbc:TaxExclusiveAmount/@currencyID1..1NoStructural UBL container
IBT-112• Invoice total amount with VATcbc:TaxInclusiveAmount1..11..1NoResponse-only; calculated by API
•• Currency codecac:LegalMonetaryTotal/cbc:TaxInclusiveAmount/@currencyID1..1NoStructural UBL container
IBT-107• Sum of allowances on document levelcbc:AllowanceTotalAmount0..10..1NoResponse-only; calculated by API
•• Currency codecac:LegalMonetaryTotal/cbc:AllowanceTotalAmount/@currencyID1..1NoStructural UBL container
IBT-108• Sum of charges on document levelcbc:ChargeTotalAmount0..10..1NoResponse-only; calculated by API
•• Currency codecac:LegalMonetaryTotal/cbc:ChargeTotalAmount/@currencyID1..1NoStructural UBL container
IBT-113• Paid amountcbc:PrepaidAmountprepaid_amount0..10..1NoSee PINT UBL rules and jurisdiction rules
•• Currency codecac:LegalMonetaryTotal/cbc:PrepaidAmount/@currencyID1..1NoStructural UBL container
IBT-114• Rounding amountcbc:PayableRoundingAmountpayable_rounding_amount0..10..1NoSee PINT UBL rules and jurisdiction rules
•• Currency codecac:LegalMonetaryTotal/cbc:PayableRoundingAmount/@currencyID1..1NoStructural UBL container
IBT-115• Amount due for paymentcbc:PayableAmount1..11..1NoResponse-only; calculated by API
•• Currency codecac:LegalMonetaryTotal/cbc:PayableAmount/@currencyID1..1NoStructural UBL container
IBG-25INVOICE LINEcac:InvoiceLinedocument_lines[]1..n1..nYes (≥1)See PINT UBL rules and jurisdiction rules
IBT-126• Invoice line identifiercbc:ID1..11..1NoSee PINT UBL rules
IBT-127• Invoice line notecbc:Notedocument_lines[].note0..10..1NoSee PINT UBL rules and jurisdiction rules
IBT-129• Invoiced quantitycbc:InvoicedQuantitydocument_lines[].quantity1..11..1YesMust be positive2.0
IBT-130•• Invoiced quantity unit of measure code@unitCodedocument_lines[].unit_code1..11..1YesUN/ECE Rec 20 string code; see Unit of Measure CodesEA
IBT-131• Invoice line net amountcbc:LineExtensionAmount1..11..1NoResponse-only; calculated by API
•• Currency codecac:InvoiceLine/cbc:LineExtensionAmount/@currencyID1..1NoStructural UBL container
IBT-133• Invoice line Buyer accounting referencecbc:AccountingCostdocument_lines[].accounting_cost0..10..1NoSee PINT UBL rules and jurisdiction rules
IBG-26• INVOICE LINE PERIODcac:InvoicePerioddocument_lines[].invoice_period0..10..1NoSee PINT UBL rules and jurisdiction rules
IBT-134•• Invoice line period start datecbc:StartDatedocument_lines[].invoice_period.start_date0..10..1NoSee PINT UBL rules and jurisdiction rules
IBT-135•• Invoice line period end datecbc:EndDatedocument_lines[].invoice_period.end_date0..10..1NoSee PINT UBL rules and jurisdiction rules
• ORDER LINE REFERENCEcac:InvoiceLine/cac:OrderLineReference0..1NoStructural UBL container
IBT-132•• Referenced purchase order line referencecbc:LineIDdocument_lines[].order_line_reference.line_id0..11..1NoSee PINT UBL rules and jurisdiction rules
•• Referenced purchase order.cac:InvoiceLine/cac:OrderLineReference/cac:OrderReference0..1NoStructural UBL container
IBT-183••• Purchase order referencecbc:IDdocument_lines[].order_line_reference.order_reference_id0..11..1NoSee PINT UBL rules and jurisdiction rules
• DESPATCH REFERENCEcac:InvoiceLine/cac:DespatchLineReference0..1NoStructural UBL container
•• Despatch advice linecac:InvoiceLine/cac:DespatchLineReference/cbc:LineID1..1NoStructural UBL container
•• Despatch advice referencecac:InvoiceLine/cac:DespatchLineReference/cac:DocumentReference0..1NoStructural UBL container
IBT-184••• Despatch advice referencecbc:IDdocument_lines[].despatch_line_reference.id0..11..1NoSee PINT UBL rules and jurisdiction rules
IBG-36• LINE DOCUMENT REFERENCEcac:DocumentReference[cbc:DocumentTypeCode != 130]0..10..1NoSee PINT UBL rules
IBT-188•• Invoice line document identifiercbc:ID1..11..1NoSee PINT UBL rules
IBT-189•• Document type codecbc:DocumentTypeCode0..10..1NoSee PINT UBL rules
• LINE OBJECT IDENTIFIERcac:InvoiceLine/cac:DocumentReference[cbc:DocumentTypeCode = 130]0..1NoStructural UBL container
IBT-128•• Invoice line object identifiercbc:IDdocument_lines[].line_object_identifier0..11..1NoSee PINT UBL rules and jurisdiction rules
IBT-128-1••• Scheme identifier@schemeID0..10..1NoSee PINT UBL rules
•• Qualifier for syntax bindingcac:InvoiceLine/cac:DocumentReference[cbc:DocumentTypeCode = 130]/cbc:DocumentTypeCode1..1NoStructural UBL container
IBG-27• INVOICE LINE ALLOWANCEScac:AllowanceCharge[cbc:ChargeIndicator = false]document_lines[].allowances[]0..n0..nNoSee PINT UBL rules and jurisdiction rules
•• Syntax binding qualifiercac:InvoiceLine/cac:AllowanceCharge[cbc:ChargeIndicator = false]/cbc:ChargeIndicator1..1NoStructural UBL container
IBT-140•• Invoice line allowance reason codecbc:AllowanceChargeReasonCodedocument_lines[].allowances[].reason_code0..10..1NoSee PINT UBL rules and jurisdiction rules
IBT-139•• Invoice line allowance reasoncbc:AllowanceChargeReasondocument_lines[].allowances[].reason0..10..1NoSee PINT UBL rules and jurisdiction rules
IBT-138•• Invoice line allowance percentagecbc:MultiplierFactorNumericdocument_lines[].allowances[].multiplier_factor_numeric0..10..1NoSee PINT UBL rules and jurisdiction rules
IBT-136•• Invoice line allowance amountcbc:Amountdocument_lines[].allowances[].amount1..11..1YesSee PINT UBL rules and jurisdiction rules
••• Currency codecac:InvoiceLine/cac:AllowanceCharge[cbc:ChargeIndicator = false]/cbc:Amount/@currencyID1..1NoStructural UBL container
IBT-137•• Invoice line allowance base amountcbc:BaseAmountdocument_lines[].allowances[].base_amount0..10..1NoSee PINT UBL rules and jurisdiction rules
••• Currency codecac:InvoiceLine/cac:AllowanceCharge[cbc:ChargeIndicator = false]/cbc:BaseAmount/@currencyID1..1NoStructural UBL container
IBG-28• INVOICE LINE CHARGEScac:AllowanceCharge[cbc:ChargeIndicator = true]document_lines[].charges[]0..n0..nNoSee PINT UBL rules and jurisdiction rules
•• Syntax binding qualifiercac:InvoiceLine/cac:AllowanceCharge[cbc:ChargeIndicator = true]/cbc:ChargeIndicator1..1NoStructural UBL container
IBT-145•• Invoice line charge reason codecbc:AllowanceChargeReasonCodedocument_lines[].charges[].reason_code0..10..1NoSee PINT UBL rules and jurisdiction rules
IBT-144•• Invoice line charge reasoncbc:AllowanceChargeReasondocument_lines[].charges[].reason0..10..1NoSee PINT UBL rules and jurisdiction rules
IBT-143•• Invoice line charge percentagecbc:MultiplierFactorNumericdocument_lines[].charges[].multiplier_factor_numeric0..10..1NoSee PINT UBL rules and jurisdiction rules
IBT-141•• Invoice line charge amountcbc:Amountdocument_lines[].charges[].amount1..11..1YesSee PINT UBL rules and jurisdiction rules
••• Currency codecac:InvoiceLine/cac:AllowanceCharge[cbc:ChargeIndicator = true]/cbc:Amount/@currencyID1..1NoStructural UBL container
IBT-142•• Invoice line charge base amountcbc:BaseAmountdocument_lines[].charges[].base_amount0..10..1NoSee PINT UBL rules and jurisdiction rules
••• Currency codecac:InvoiceLine/cac:AllowanceCharge[cbc:ChargeIndicator = true]/cbc:BaseAmount/@currencyID1..1NoStructural UBL container
IBG-31• ITEM INFORMATIONcac:Item1..11..1NoSee PINT UBL rules
IBT-154•• Item descriptioncbc:Descriptiondocument_lines[].description0..10..1NoSee PINT UBL rules and jurisdiction rulesSample Item Description
IBT-153•• Item namecbc:Namedocument_lines[].name1..11..1YesSee PINT UBL rules and jurisdiction rulesSample Item
•• BUYERS ITEM IDENTIFICATIONcac:InvoiceLine/cac:Item/cac:BuyersItemIdentification0..1NoStructural UBL container
IBT-156••• Item Buyer's identifiercbc:IDdocument_lines[].buyer_item_identification.id0..11..1NoSee PINT UBL rules and jurisdiction rules
•• SELLERS ITEM IDENTIFICATIONcac:InvoiceLine/cac:Item/cac:SellersItemIdentification0..1NoStructural UBL container
IBT-155••• Item Seller's identifiercbc:IDdocument_lines[].seller_item_identification.id0..11..1NoSee PINT UBL rules and jurisdiction rules
•• STANDARD ITEM IDENTIFICATIONcac:InvoiceLine/cac:Item/cac:StandardItemIdentification0..1NoStructural UBL container
IBT-157••• Item standard identifiercbc:IDdocument_lines[].standard_item_identification.id0..11..1NoSee PINT UBL rules and jurisdiction rules
IBT-157-1•••• Scheme identifier@schemeIDdocument_lines[].standard_item_identification.scheme_id1..11..1YesSee PINT UBL rules and jurisdiction rules
BGOM-06•• INDUSTRIAL CLASSIFICATIONcac:AdditionalItemIdentification0..n0..nNoSee PINT UBL rules
BTOM-033••• Industrial Classification Codecbc:ID1..11..1NoSee PINT UBL rules
BTOM-033-1•••• The name of the identification scheme.@schemeName1..11..1NoSee PINT UBL rules
BGOM-07•• SERVICE TYPEcac:ItemSpecificationDocumentReference0..n0..nNoSee PINT UBL rules
BTOM-034••• Service Type Codecbc:ID1..11..1NoSee PINT UBL rules
BTOM-034-1•••• The name of the identification scheme.@schemeName1..11..1NoSee PINT UBL rules
BTOM-019••• Goods or Services identificationcbc:DocumentTypeCode1..11..1NoSee PINT UBL rules
•• ORIGIN COUNTRYcac:InvoiceLine/cac:Item/cac:OriginCountry0..1NoStructural UBL container
IBT-159••• Item country of origincbc:IdentificationCodedocument_lines[].origin_country.identification_code0..11..1NoSee PINT UBL rules and jurisdiction rules
•• cac:CommodityClassificationcac:InvoiceLine/cac:Item/cac:CommodityClassification0..nNoStructural UBL container
IBT-158••• Item classification identifier (HS Code)cbc:ItemClassificationCodedocument_lines[].commodity_classification.item_classification_code0..n1..1NoSee PINT UBL rules and jurisdiction rules
IBT-158-1•••• Scheme identifier@listIDdocument_lines[].commodity_classification.item_classification_list_id1..11..1YesSee PINT UBL rules and jurisdiction rules
IBT-158-2•••• Scheme version identifier@listVersionIDdocument_lines[].commodity_classification.item_classification_list_version_id0..10..1NoSee PINT UBL rules and jurisdiction rules
IBG-30•• LINE VAT INFORMATIONcac:ClassifiedTaxCategorydocument_lines[].classified_tax_category0..n0..nNoSee PINT UBL rules and jurisdiction rules
IBT-151••• Invoiced item VAT category codecbc:IDdocument_lines[].classified_tax_category.id1..11..1YesString code (S, E, O, Z); see Tax CategoriesS
IBT-152••• Invoiced item VAT ratecbc:Percentdocument_lines[].classified_tax_category.percent0..10..1NoNumeric VAT rate; required for taxable categories5.0
IBT-166••• Unit TAXcbc:PerUnitAmount0..10..1NoSee PINT UBL rules
•••• Currency codecac:InvoiceLine/cac:Item/cac:ClassifiedTaxCategory/cbc:PerUnitAmount/@currencyID1..1NoStructural UBL container
IBT-186••• Tax exemption reason codecbc:TaxExemptionReasonCodedocument_lines[].classified_tax_category.tax_exemption_reason_code0..10..1NoSee PINT UBL rules and jurisdiction rules
IBT-185••• Tax exemption reason textcbc:TaxExemptionReasondocument_lines[].classified_tax_category.tax_exemption_reason0..10..1NoSee PINT UBL rules and jurisdiction rules
••• Zero rated reason codecbc:ZeroRatedReasonCodedocument_lines[].classified_tax_category.zero_rated_reason_code0..10..1NoRequired when classified_tax_category.id is Z
••• Zero rated reason textcbc:ZeroRatedReasondocument_lines[].classified_tax_category.zero_rated_reason0..10..1NoRequired when classified_tax_category.id is Z
••• TAX SCHEMEcac:InvoiceLine/cac:Item/cac:ClassifiedTaxCategory/cac:TaxScheme0..1NoStructural UBL container
IBT-167•••• Tax Schemecbc:IDdocument_lines[].classified_tax_category.tax_scheme0..10..1NoMust be VAT for OMN partiesVAT
IBG-32•• ITEM ATTRIBUTEScac:AdditionalItemPropertydocument_lines[].additional_item_property[]0..n0..nNoSee PINT UBL rules and jurisdiction rules
IBT-160••• Item attribute namecbc:Namedocument_lines[].additional_item_property[].name1..11..1YesSee PINT UBL rules and jurisdiction rules
BTOM-025••• Profit margin item type codecbc:NameCode0..10..1NoSee PINT UBL rules
IBT-161••• Item attribute valuecbc:Valuedocument_lines[].additional_item_property[].value1..11..1YesSee PINT UBL rules and jurisdiction rules
IBG-29• PRICE DETAILScac:Pricedocument_lines[].price1..11..1YesSee PINT UBL rules and jurisdiction rules
IBT-146•• Item net pricecbc:PriceAmount1..11..1NoMust not be negative (IBR-027)
••• Currency codecac:InvoiceLine/cac:Price/cbc:PriceAmount/@currencyID1..1NoStructural UBL container
IBT-149•• Item price base quantitycbc:BaseQuantitydocument_lines[].price.base_quantity0..10..1NoMust be positive above zero (IBR-087)1.0
IBT-150••• Item price base quantity unit of measure code@unitCode0..10..1NoSee PINT UBL rules
•• ALLOWANCEcac:InvoiceLine/cac:Price/cac:AllowanceCharge0..1NoStructural UBL container
••• Syntax binding qualifiercac:InvoiceLine/cac:Price/cac:AllowanceCharge/cbc:ChargeIndicator1..1NoStructural UBL container
IBT-147••• Item price discountcbc:Amountdocument_lines[].price.allowance.amount0..11..1NoSee PINT UBL rules and jurisdiction rules
•••• Currency codecac:InvoiceLine/cac:Price/cac:AllowanceCharge/cbc:Amount/@currencyID1..1NoStructural UBL container
IBT-148••• Item gross pricecbc:BaseAmountdocument_lines[].price.base_amount0..10..1NoSee PINT UBL rules and jurisdiction rules100.0
•••• Currency codecac:InvoiceLine/cac:Price/cac:AllowanceCharge/cbc:BaseAmount/@currencyID1..1NoStructural UBL container
BGOM-04• LINE AMOUNTS IN ACCOUNTING CURRENCY (OMR)cac:ItemPriceExtension0..10..1NoSee PINT UBL rules
BTOM-017•• Total amount including VATcbc:Amount1..11..1NoSee PINT UBL rules
••• Currency codecac:InvoiceLine/cac:ItemPriceExtension/cbc:Amount/@CurrencyID1..1NoStructural UBL container
•• LINE TAXcac:InvoiceLine/cac:ItemPriceExtension/cac:TaxTotal1..1NoStructural UBL container
BTOM-016••• Line item VAT amountcbc:TaxAmount1..11..1NoSee PINT UBL rules
•••• Currency codecac:InvoiceLine/cac:ItemPriceExtension/cac:TaxTotal/cbc:TaxAmount/@CurrencyID1..1NoStructural UBL container