Try in playground

Oman: fields

Every GETS field an Omani document can carry, when it is required and the values it accepts.

  • Field is the name the Integration engine shows.
  • Requirement covers every document type, modifier and variant. Mandatory fields are always required and optional ones never are. Conditional fields are required only when the condition in their description is met.
  • Enums lists the values a field accepts when it takes only a fixed set.
  • To see the fields for one document type, modifier and variant next to a sample request, open List with sample request.

Payload fields

380 fields · conditional fields are required only when the condition in their description is met

DescriptionEnums
Invoice CurrencyMandatorystringDocument currency
Document NumberMandatorystringUnique document number
Document BaseMandatorystringThe base document type, such as tax_invoice or credit_note. Each country’s values are listed under Enums on its fields page.
tax_invoiceTax invoicecredit_noteCredit notedebit_noteDebit notesimplified_invoiceSimplified invoicesimplified_credit_noteSimplified credit notesimplified_debit_noteSimplified debit note
Issue DateMandatorydateDocument issue date
Issue TimeMandatorystringTime the document was issued, as hh:mm:ss. ALIGNED-IBRP-016-OM: every document must carry its issue time (IBT-168).
Document IDMandatorystringInvoice UUID (BTOM-002). Must be a valid UUID version 5. PINT OM IBR-002-OM requires invoice UUID version 5 (BTOM-002); https://docs.peppol.eu/poac/om/pint-om/trn-invoice/semantic-model/btom-002/.
Additional NotesOptionalstringA textual note that gives unstructured information that is relevant to the Invoice as a whole.
Document ModifiersOptionalarrayModifiers that apply to the document, such as export. Send [] when none apply. Each country’s values are listed under Enums on its fields page.
self_billedSelf billedthird_partyThird partysummarySummarycontinuous_supplyContinuous supplyexportExportdeemed_supplyDeemed supplyreverse_chargeReverse chargemargin_schemeMargin schemee_commerceE-commerceimport_goodsImport goodsspecial_zone_suppliesSpecial zone suppliesb2gB2G
Document VariantOptionalstringA variant of the base document type: advance. Leave it out for an ordinary document.
advanceAdvance
Due DateOptionaldatePayment due date
Exchange Rate DateOptionaldateExchange rate date
Exchange RateOptionalnumberExchange rate when currency differs from tax currency
Exchange Source CurrencyOptionalstringExchange rate source currency
Exchange Target CurrencyOptionalstringExchange rate target currency
Invoice Period EndOptionaldateEnd date of the invoiced period
Invoice Period FrequencyOptionalstringFrequency of the billing period (monthly, weekly, etc.)
Invoice Period StartOptionaldateStart date of the invoiced period
Note Issuance ReasonOptionalstringReason for credit/debit note
Reference IDOptionalstringOriginal invoice reference ID
Reference NumbersOptionalarrayReference to original invoice (notes)
Tax Accounting CurrencyOptionalstringTax currency (often same as document currency)
Seller CityMandatorystringThe common name of the city, town or village, where the Seller address is located.
Seller CountryMandatorystringSeller country code
Seller Contact PhoneMandatorystringA phone number for the contact point. PINT OM IBR-011-OM requires seller contact telephone (IBT-042).
Seller NameMandatorystringSeller company name
Seller Peppol IDMandatorystringSeller's Peppol network identifier for Peppol delivery
Seller Registration TypeMandatorystringSeller registration type
Seller Registration ValueMandatorystringAn identifier issued by an official registrar that identifies the Seller as a legal entity or person.
Seller Tax ID TypeMandatorystringThe scheme of the TAX identifier.
Seller Tax ID ValueMandatorystringSeller tax ID value
Seller Access Code BuildingOptionalstringseller access code building
Seller Access Code GateOptionalstringseller access code gate
Seller Access Code IntercomOptionalstringseller access code intercom
Seller Address TypeOptionalstringseller address type
Seller Address UsageOptionalstringseller address usage
Seller ApartmentOptionalstringseller apartment
Seller Attention ToOptionalstringseller attention to
Seller Building NameOptionalstringseller building name
Seller Building NumberOptionalstringSeller building number
Seller Business Hours CloseOptionalstringseller business hours close
Seller Business Hours DaysOptionalarrayseller business hours days
Seller Business Hours OpenOptionalstringseller business hours open
Seller Care OfOptionalstringseller care of
Seller Delivery InstructionsOptionalstringseller delivery instructions
Seller Delivery PointOptionalstringseller delivery point
Seller DistrictOptionalstringSeller district
Seller FloorOptionalstringseller floor
Seller Geo Location LatitudeOptionalnumberseller geo location latitude
Seller Geo Location LongitudeOptionalnumberseller geo location longitude
Seller LandmarkOptionalstringseller landmark
Seller Plus CodeOptionalstringseller plus code
Seller PO BoxOptionalstringseller po box
Seller Post OfficeOptionalstringseller post office
Seller Room NumberOptionalstringseller room number
Seller Street NameOptionalstringseller street name
Seller Street NumberOptionalstringseller street number
Seller Sub DistrictOptionalstringseller sub district
Seller Time ZoneOptionalstringseller time zone
Seller Valid FromOptionaldateseller valid from
Seller Valid ToOptionaldateseller valid to
Seller Verification DateOptionaldateseller verification date
Seller Verification SourceOptionalstringseller verification source
Seller VerifiedOptionalstringseller verified
Seller WardOptionalstringseller ward
Seller What Three WordsOptionalstringseller what three words
Seller ZoneOptionalstringseller zone
Seller Address Line 1OptionalstringThe main address line in an address.
Seller Address Line 2OptionalstringAn additional address line in an address that can be used to give further details supplementing the main line.
Seller Address Line 3OptionalstringSeller address line 3
Seller Postal CodeOptionalstringThe identifier for an addressable group of properties according to the relevant postal service.
Seller State/ProvinceOptionalstringThe subdivision of a country. Such as a region, a county, a state, a province etc..
Seller Business ActivityOptionalstringSeller business activity
Seller Contact EmailOptionalstringAn e-mail address for the contact point.
Seller Contact NameOptionalstringA contact point for a legal entity or person.
Seller Industry Classification CodeOptionalstringIndustry classification code
Seller Industry Classification DescriptionOptionalstringIndustry classification description
Seller Industry Classification SchemeOptionalstringIndustry classification scheme
Seller Party IDOptionalstringSeller internal party ID
Seller Trade NameOptionalstringSeller trade name
Buyer CountryMandatorystringBuyer country code
Buyer NameMandatorystringBuyer company/name
Buyer Peppol IDMandatorystringBuyer's Peppol network identifier for Peppol delivery
Buyer Registration TypeMandatorystringBuyer registration type
Buyer Registration ValueMandatorystringAn identifier issued by an official registrar that identifies the Buyer as a legal entity or person.
Buyer Access Code BuildingOptionalstringbuyer access code building
Buyer Access Code GateOptionalstringbuyer access code gate
Buyer Access Code IntercomOptionalstringbuyer access code intercom
Buyer Address TypeOptionalstringbuyer address type
Buyer Address UsageOptionalstringbuyer address usage
Buyer ApartmentOptionalstringbuyer apartment
Buyer Attention ToOptionalstringbuyer attention to
Buyer Building NameOptionalstringbuyer building name
Buyer Building NumberOptionalstringBuyer building number
Buyer Business Hours CloseOptionalstringbuyer business hours close
Buyer Business Hours DaysOptionalarraybuyer business hours days
Buyer Business Hours OpenOptionalstringbuyer business hours open
Buyer Care OfOptionalstringbuyer care of
Buyer Delivery InstructionsOptionalstringbuyer delivery instructions
Buyer Delivery PointOptionalstringbuyer delivery point
Buyer DistrictOptionalstringBuyer district
Buyer FloorOptionalstringbuyer floor
Buyer Geo Location LatitudeOptionalnumberbuyer geo location latitude
Buyer Geo Location LongitudeOptionalnumberbuyer geo location longitude
Buyer LandmarkOptionalstringbuyer landmark
Buyer Plus CodeOptionalstringbuyer plus code
Buyer PO BoxOptionalstringbuyer po box
Buyer Post OfficeOptionalstringbuyer post office
Buyer Room NumberOptionalstringbuyer room number
Buyer Street NameOptionalstringbuyer street name
Buyer Street NumberOptionalstringbuyer street number
Buyer Sub DistrictOptionalstringbuyer sub district
Buyer Time ZoneOptionalstringbuyer time zone
Buyer Valid FromOptionaldatebuyer valid from
Buyer Valid ToOptionaldatebuyer valid to
Buyer Verification DateOptionaldatebuyer verification date
Buyer Verification SourceOptionalstringbuyer verification source
Buyer VerifiedOptionalstringbuyer verified
Buyer WardOptionalstringbuyer ward
Buyer What Three WordsOptionalstringbuyer what three words
Buyer ZoneOptionalstringbuyer zone
Buyer Address Line 1OptionalstringThe main address line in an address.
Buyer Address Line 2OptionalstringAn additional address line in an address that can be used to give further details supplementing the main line.
Buyer Address Line 3OptionalstringBuyer address line 3
Buyer CityOptionalstringThe common name of the city, town or village, where the Buyer’s address is located.
Buyer Postal CodeOptionalstringThe identifier for an addressable group of properties according to the relevant postal service.
Buyer State/ProvinceOptionalstringThe subdivision of a country. Such as a region, a county, a state, a province etc..
Buyer Business ActivityOptionalstringBuyer business activity
Buyer Contact EmailOptionalstringAn e-mail address for the contact point.
Buyer Contact NameOptionalstringA contact point for a legal entity or person.
Buyer Contact PhoneOptionalstringA phone number for the contact point.
Buyer Industry Classification CodeOptionalstringBuyer industry code
Buyer Industry Classification DescriptionOptionalstringBuyer industry description
Buyer Industry Classification SchemeOptionalstringBuyer industry scheme
Buyer Party IDOptionalstringBuyer internal party ID
Buyer Tax ID TypeOptionalstringThe scheme of the TAX identifier.
Buyer Tax ID ValueOptionalstringThe Buyer’s VAT identifier (also known as Buyer VAT identification number). The Buyer’s tax identifier (also known as Buyer tax identification number). For buyers in UAE which are registered under VAT should provide the Tax Registration Number (TRN).
Buyer Trade NameOptionalstringBuyer trade name
Delivery Access Code BuildingOptionalstringdelivery access code building
Delivery Access Code GateOptionalstringdelivery access code gate
Delivery Access Code IntercomOptionalstringdelivery access code intercom
Delivery Address TypeOptionalstringdelivery address type
Delivery Address UsageOptionalstringdelivery address usage
Delivery ApartmentOptionalstringdelivery apartment
Delivery Attention ToOptionalstringdelivery attention to
Delivery Building NameOptionalstringdelivery building name
Delivery Building NumberOptionalstringdelivery building number
Delivery Business Hours CloseOptionalstringdelivery business hours close
Delivery Business Hours DaysOptionalarraydelivery business hours days
Delivery Business Hours OpenOptionalstringdelivery business hours open
Delivery Care OfOptionalstringdelivery care of
Delivery Delivery InstructionsOptionalstringdelivery delivery instructions
Delivery Delivery PointOptionalstringdelivery delivery point
Delivery DistrictOptionalstringdelivery district
Delivery FloorOptionalstringdelivery floor
Delivery Geo Location LatitudeOptionalnumberdelivery geo location latitude
Delivery Geo Location LongitudeOptionalnumberdelivery geo location longitude
Delivery LandmarkOptionalstringdelivery landmark
Delivery Plus CodeOptionalstringdelivery plus code
Delivery PO BoxOptionalstringdelivery po box
Delivery Post OfficeOptionalstringdelivery post office
Delivery Room NumberOptionalstringdelivery room number
Delivery Street NameOptionalstringdelivery street name
Delivery Street NumberOptionalstringdelivery street number
Delivery Sub DistrictOptionalstringdelivery sub district
Delivery Time ZoneOptionalstringdelivery time zone
Delivery Valid FromOptionaldatedelivery valid from
Delivery Valid ToOptionaldatedelivery valid to
Delivery Verification DateOptionaldatedelivery verification date
Delivery Verification SourceOptionalstringdelivery verification source
Delivery VerifiedOptionalstringdelivery verified
Delivery WardOptionalstringdelivery ward
Delivery What Three WordsOptionalstringdelivery what three words
Delivery ZoneOptionalstringdelivery zone
Delivery Address Line 1OptionalstringThe main address line in an address.
Delivery Address Line 2OptionalstringAdditional delivery address line
Delivery Address Line 3OptionalstringThird delivery address line
Delivery CityOptionalstringThe common name of the city, town or village, where the deliver to address is located.
Delivery CountryOptionalstringA code that identifies the country.
Delivery Post CodeOptionalstringPostal code for delivery address
Delivery Country SubdivisionOptionalstringState, emirate or province for delivery address
Delivery Business ActivityOptionalstringDelivery business activity
Delivery Contact EmailOptionalstringDelivery contact email
Delivery Contact NameOptionalstringDelivery contact name
Delivery Contact PhoneOptionalstringDelivery contact phone
Actual Delivery DateOptionaldateActual delivery date
Actual Delivery TimeOptionalstringActual delivery time
Customs Declaration NumberOptionalstringcustoms declaration number
Destination PortOptionalstringDestination port
Export DateOptionaldateexport date
FreightOptionalstringfreight
Freight DocumentOptionalstringfreight document
IncotermsOptionalstringDelivery terms (Incoterms)
EXWFCACPTCIPDAPDPU
Origin PortOptionalstringOrigin port
Special TermsOptionalstringspecial terms
Transport ModeOptionalstringtransport mode
Delivery Industry Classification CodeOptionalstringDelivery industry classification code
Delivery Industry Classification DescriptionOptionalstringDelivery industry classification description
Delivery Industry Classification SchemeOptionalstringDelivery industry classification scheme
Delivery Party NameOptionalstringDelivery party name
Delivery Party IDOptionalstringIdentifier for delivery party
Delivery Peppol IDOptionalstringDelivery party's Peppol network identifier
Deliver to Legal Registration TypeOptionalstringType of registration for delivery party
Deliver to Legal RegistrationOptionalstringRegistration number for delivery party
Delivery Tax ID TypeOptionalstringDelivery tax ID type
Delivery Tax ID ValueOptionalstringDelivery tax ID value
Delivery Trade NameOptionalstringDelivery party trade name
Line Item IDMandatorystringLine item identifier
Line Item TotalMandatorynumberLine item total
Line Item NameMandatorystringLine item name/description
Item Gross PriceMandatorynumberOman unit price before the price-level discount. ibr-026: every line must carry its item price (IBT-146).
Line Item QuantityMandatorynumberThe quantity of items (goods or services) that is charged in the Invoice line.
Line Item Tax AmountMandatorynumberTax amount for the line item, excluding the net line amount.
Line Tax CategoryMandatorystringThe VAT category code for the invoiced item. IBR-076-OM: every line must carry its tax category code (IBT-151).
Line Item Unit CodeMandatorystringUnit code (PCE, KGM, etc.)
Line Taxable ValueConditionalnumberThe total amount of the Invoice line (before tax). ibr-024: every line must have its net amount (IBT-131). Send lineTaxableValue, or lineTotal with taxAmount so that it can be calculated.
Buyer Item CodeOptionalstringBuyer item code
Commodity Classification CodeOptionalstringCommodity classification code
When the scheme is HS
Commodity Classification DescriptionOptionalstringCommodity classification description
Commodity Classification SchemeOptionalstringThe identification scheme shall be chosen from the entries in UNTDID 7143 [6].
Commodity CodeOptionalstringTariff/commodity code
Country Of OriginOptionalstringThe code identifying the country from which the item originates.
Line Item DescriptionOptionalstringA description for an item.
Line Discount/Charge AmountOptionalnumberDiscount/Charge amount
Line Discount/Charge Base AmountOptionalnumberDiscount/Charge base amount
Line Discount/Charge IDOptionalstringDiscount/Charge ID
Line Discount/Charge is ChargeOptionalbooleanIs charge or discount
Line Discount/Charge PercentageOptionalnumberDiscount/Charge percentage
Line Discount/Charge ReasonOptionalstringDiscount/Charge reason
Line Discount/Charge Reason CodeOptionalstringDiscount/Charge reason code
Line Discount/Charge Tax AmountOptionalnumberDiscount/Charge tax amount
Line Discount/Charge Tax CategoryOptionalstringDiscount/Charge tax category
Line Discount/Charge Tax RateOptionalnumberDiscount/Charge tax rate
Line TypeOptionalstringLine type
Item Net PriceOptionalnumberOman net unit price, using the existing netPrice input field. Oman input uses netPrice for the unit price after discount.
Base QuantityOptionalnumberThe number of item units to which the price applies.
Base Quantity Unit CodeOptionalstringBase quantity unit code
Line Related Document TypeOptionalstringRelated document type
Line Related Document IDOptionalstringRelated document ID
Seller Item CodeOptionalstringSeller item code
Standard Item Code IDOptionalstringAn item identifier based on a registered scheme.
Standard Item Code SchemeOptionalstringThe identification scheme identifier of the Item standard identifier.
Tax Exemption ReasonOptionalstringA textual statement of the reason why the line amount is exempted from VAT or why no VAT is being charged.
Tax Exemption Reason CodeOptionalstringA coded statement of the reason for why the line amount is exempted from VAT.
Line Tax RateOptionalnumberThe VAT rate, represented as percentage that applies to the invoiced item.
Industrial classification codeConditionalstringIndustrial classification code. Validated by the Oman GETS rules for the selected document profile. Conditional for tax invoices, credit notes and debit notes; optional for simplified invoices, simplified credit notes and simplified debit notes. IBR-081-OM: every line needs an industrial classification code (BTOM-033), except on simplified documents and with the import_goods or reverse_charge modifier, or margin_scheme with self_billed.
Item typeConditionalstringItem type. Validated by the Oman GETS rules for the selected document profile. Mandatory for tax invoices, credit notes and debit notes; optional for simplified invoices, simplified credit notes and simplified debit notes. IBR-078-OM: every line must say whether it is goods or services (BTOM-019), except on simplified documents.
GS
Profit margin item type codeOptionalstringProfit margin item type code. Validated by the Oman GETS rules for the selected document profile.
Service type codeOptionalstringService type code. Validated by the Oman GETS rules for the selected document profile.
Unit taxOptionalnumberUnit tax. Validated by the Oman GETS rules for the selected document profile.
Line Accounting ReferenceOptionalstringAccounting reference for the line item.
Attribute NameOptionalstringName of the line item attribute.
Attribute ValueOptionalstringValue of the line item attribute.
Line Buyer Accounting ReferenceOptionalstringBuyer accounting reference for the line item.
Commodity Classification VersionOptionalstringVersion of the commodity classification scheme.
Line Invoice Period EndOptionaldateEnd date of the invoiced period for this line.
Line Invoice Period StartOptionaldateStart date of the invoiced period for this line.
Line NoteOptionalstringFree text note for the line item.
Line Object IdentifierOptionalstringObject identifier for the line item.
Line Object Identifier SchemeOptionalstringScheme for the line item object identifier.
Order Line ReferenceOptionalstringReference to the corresponding order line.
Line Tax SchemeOptionalstringTax scheme for the line item (IBT-167). Typically VAT for Peppol/EN 16931 invoices.
Amount DueMandatorynumberThe outstanding amount that is requested to be paid.
Total Amount Excluding TaxMandatorynumberTotal excluding tax
Total Amount Including TaxMandatorynumberTotal including tax
Total Line Taxable AmountMandatorynumberSum of line taxable values
Total Tax AmountMandatorynumberTotal tax amount
Prepaid AmountOptionalnumberThe sum of amounts which have been paid in advance.
Rounding AmountOptionalnumberRounding adjustment
Total AllowancesOptionalnumberSum of all allowances on document level in the Invoice.
Total ChargesOptionalnumberSum of all charges on document level in the Invoice.
Tax Total AmountConditionalnumberTotal tax amount of the document. Optional as a group: if you leave taxTotals out, the VAT breakdown is calculated from the line items. A tax total you send needs its tax amount and, for each VAT category, the taxable amount, tax amount and category.
Tax Subtotal PercentageConditionalnumberTax rate of this category, as a percentage. Optional as a group: if you leave taxTotals out, the VAT breakdown is calculated from the line items. A tax total you send needs its tax amount and, for each VAT category, the taxable amount, tax amount and category.
Tax Subtotal Taxable AmountConditionalnumberSum of the taxable amounts in this tax category and rate. Optional as a group: if you leave taxTotals out, the VAT breakdown is calculated from the line items. A tax total you send needs its tax amount and, for each VAT category, the taxable amount, tax amount and category.
Tax Subtotal AmountConditionalnumberTax amount for this tax category and rate. Optional as a group: if you leave taxTotals out, the VAT breakdown is calculated from the line items. A tax total you send needs its tax amount and, for each VAT category, the taxable amount, tax amount and category.
Tax Subtotal CategoryConditionalstringTax category code of this part of the breakdown, such as S for the standard rate. Optional as a group: if you leave taxTotals out, the VAT breakdown is calculated from the line items. A tax total you send needs its tax amount and, for each VAT category, the taxable amount, tax amount and category.
Tax Subtotal Exemption ReasonConditionalstringWhy this category is exempt from tax, as text. Optional as a group: if you leave taxTotals out, the VAT breakdown is calculated from the line items. A tax total you send needs its tax amount and, for each VAT category, the taxable amount, tax amount and category.
Tax Subtotal Exemption Reason CodeConditionalstringWhy this category is exempt from tax, as a code. Optional as a group: if you leave taxTotals out, the VAT breakdown is calculated from the line items. A tax total you send needs its tax amount and, for each VAT category, the taxable amount, tax amount and category.
Tax Subtotal SchemeOptionalstringTax scheme of this part of the breakdown, normally VAT. Optional as a group: if you leave taxTotals out, the VAT breakdown is calculated from the line items. A tax total you send needs its tax amount and, for each VAT category, the taxable amount, tax amount and category.
Invoice Discount/Charge AmountOptionalnumberAllowance/charge amount
Invoice Discount/Charge Base AmountOptionalnumberBase amount
Invoice Discount/Charge Line IDOptionalstringAllowance/Charge ID
Invoice-level Is ChargeOptionalbooleanCharge (true) or allowance (false)
Invoice Discount/Charge PercentageOptionalnumberPercent applied
Invoice Discount/Charge ReasonOptionalstringReason for allowance/charge
Invoice Discount/Charge Reason CodeOptionalstringReason code
Invoice Discount/Charge Tax AmountOptionalnumberTax amount
Invoice Discount/Charge Tax CategoryOptionalstringTax category
Invoice Discount/Charge Tax RateOptionalnumberTax rate
Payee Account IDConditionalstringA unique identifier of the financial payment account, at a payment service provider, to which payment should be made.
Card Holder NameOptionalstringCard holder name
Card NetworkOptionalstringCard network ID
Card PANOptionalstringCard primary account number
Payee Account NameOptionalstringThe name of the payment account, at a payment service provider, to which payment should be made.
Payee Institution BranchOptionalstringAn identifier for the payment service provider where a payment account is located.
Direct Debit Mandate Ref IDOptionalstringDirect debit mandate reference
Payer Financial AccountOptionalstringPayer financial account
Payment IDOptionalstringPayment identifier
Payment Means CodeOptionalstringHow the payment is made, as a UNTDID 4461 payment means code, for example 30 for a credit transfer or 10 for cash.
Payment Means TextOptionalstringPayment method description
Discount AmountOptionalnumberThe payment amount that these terms apply to. When relevant, the amount includes tax.
Discount Due DateOptionaldateDiscount due date
Payment Terms NoteOptionalstringA textual description of the payment terms that apply to the amount due for payment (Including description of possible penalties).
Penalty AmountOptionalnumberPenalty amount
Penalty PercentageOptionalnumberPenalty percent
Settlement Discount PercentageOptionalnumberSettlement discount percent
Attachment ChecksumOptionalstringAttachment checksum
Attachment ContentOptionalstringAttachment base64 content
Attachment Content URLOptionalstringAttachment content URL
Attachment DescriptionOptionalstringAttachment description
Attachment FilenameOptionalstringAttachment file name
Attachment Mime CodeOptionalstringA code identifying the file type.
Attachment SizeOptionalnumberAttachment size
Supporting Document DescriptionOptionalstringDescription of supporting document
Supporting Document TypeOptionalstringType of supporting document
Referenced document reason codeOptionalstringReferenced document reason code. Validated by the Oman GETS rules for the selected document profile.
CANVATVALQTYOTH
Referenced document UUIDOptionalstringReferenced document UUID. Validated by the Oman GETS rules for the selected document profile.
Supporting Document IDOptionalstringSupporting document identifier
Supporting Document Issue DateOptionaldateSupporting document issue date
Supporting Document URLOptionalstringReference URL
Buyer Electronic Address SchemeMandatorystringPeppol participant scheme identifier for buyer
Seller Electronic Address SchemeMandatorystringScheme of the seller’s Peppol participant identifier (BT-34-1), for example 0088 for a GLN.
Preceding Invoice Issue DateConditionaldateIssue date of the original preceding invoice (BT-26). Required for credit/debit notes and continuous supply.
Invoice Total VAT Amount in Tax Accounting CurrencyConditionalnumberTotal VAT amount expressed in tax accounting currency (BT-111). Required when taxCurrency differs from document currency.
Payment Account Identifier SchemeOptionalstringScheme for payment account identifier (BT-84-1). Typically IBAN for SEPA credit transfers.
Accounting CostOptionalstringBuyers accounting cost centre (BT-19).
Buyer Identifier SchemeOptionalstringISO/IEC 6523 scheme ID for buyer identifier (BT-46-1). Defines the format and authority of the buyer identifier.
Buyer Accounting ReferenceOptionalstringAccounting reference provided by the buyer.
Bank Assigned Creditor IdentifierOptionalstringSEPA creditor identifier (BT-90). Required for direct debit mandates. Conditional for payment means 59 (SEPA direct debit).
Delivery Party Identifier SchemeOptionalstringISO/IEC 6523 scheme ID for delivery party identifier.
Delivery Location IdentifierOptionalstringIdentifier for the actual delivery location (BT-71). Used for logistics and tracking when delivery party differs from buyer.
Delivery Location Identifier SchemeOptionalstringScheme for delivery location identifier (BT-71-1). E.g. 0088 for GLN-based location IDs.
Invoiced Object IdentifierOptionalstringObject identification by seller (BT-18). For specific object tracking and reference, e.g. meter point or project ID.
Invoiced Object Identifier SchemeOptionalstringScheme for invoiced object identifier (BT-18-1). Defines the format and authority of the object identifier.
Note Subject CodeOptionalstringSubject code for document-level notes.
Payee Identifier SchemeOptionalstringISO/IEC 6523 scheme ID for payee identifier (BT-61-1). Defines the format and authority of the payee identifier.
Payment Terms AmountOptionalnumberPayment terms monetary amount (BT-176). E.g. minimum payment amount or installment amount.
Payment Terms Due DateOptionaldatePayment terms due date (BT-177). The date by which payment must be made according to agreed terms.
Payment Terms Instructions IDOptionalstringIdentifier for payment terms instructions (BT-187). Used to reference agreed payment terms.
Registration Number SchemeOptionalstringScheme for seller legal registration identifier (BT-30-1). E.g. CBE, Handelsregister.
Remittance InformationOptionalstringPayment remittance information text (BT-83). Free text or structured reference for payment reconciliation.
Remittance Information SchemeOptionalstringScheme for remittance information (BT-83-1). Identifies the type of payment reference used.
Seller Additional Legal InformationOptionalstringAdditional legal information about the seller (BT-33). E.g. legal form (SPRL, SA, BV, NV, ASBL).
Seller Identifier SchemeOptionalstringISO/IEC 6523 scheme ID for seller identifier (BT-29-1). Defines the format and authority of the seller identifier.
Tax Point DateOptionaldateDate when VAT becomes accountable (BT-7). Critical for VAT compliance and tax period determination.
Tax Point Date CodeOptionalstringCode indicating the tax point date type.
Buyer country subdivision codeOptionalstringBuyer country subdivision code. Validated by the Oman GETS rules for the selected document profile.
AFZMOOTHSHRFZSEZADSLLFZ
Buyer textual identifierOptionalstringBuyer textual identifier. Validated by the Oman GETS rules for the selected document profile.
CRTINCIDPASNUMOTHIDICIDSZLN
Delivery country subdivision codeOptionalstringDelivery country subdivision code. Validated by the Oman GETS rules for the selected document profile.
Import dateOptionalstringImport date. Validated by the Oman GETS rules for the selected document profile.
Seller country subdivision codeOptionalstringSeller country subdivision code. Validated by the Oman GETS rules for the selected document profile.
AFZMOOTHSHRFZSEZADSLLFZ
Seller textual identifierOptionalstringSeller textual identifier. Validated by the Oman GETS rules for the selected document profile.
CRTINCIDPASNUMOTHIDICIDSZLN
Seller UUIDOptionalstringSeller UUID. Validated by the Oman GETS rules for the selected document profile.
Third party address line 1OptionalstringThird party address line 1. Validated by the Oman GETS rules for the selected document profile.
Third party address line 2OptionalstringThird party address line 2. Validated by the Oman GETS rules for the selected document profile.
Third party address line 3OptionalstringThird party address line 3. Validated by the Oman GETS rules for the selected document profile.
Third party cityOptionalstringThird party city. Validated by the Oman GETS rules for the selected document profile.
Third party countryOptionalstringThird party country. Validated by the Oman GETS rules for the selected document profile.
Third party country subdivisionOptionalstringThird party country subdivision. Validated by the Oman GETS rules for the selected document profile.
Third party country subdivision codeOptionalstringThird party country subdivision code. Validated by the Oman GETS rules for the selected document profile.
Third party nameOptionalstringThird party name. Validated by the Oman GETS rules for the selected document profile.
Third party postal codeOptionalstringThird party postal code. Validated by the Oman GETS rules for the selected document profile.
Third party VATINOptionalstringThird party VATIN. Validated by the Oman GETS rules for the selected document profile.
Destination AuthorityOptionalstringDestination authority
Destination BodyOptionalstringEmail body
Destination CountryOptionalstringDestination country
Destination Document TypeOptionalstringDestination document type
Destination Participant IDOptionalstringPeppol participant ID
Destination RecipientsOptionalarrayEmail recipients
Destination SubjectOptionalstringEmail subject
Destination TypeOptionalstringDestination type for submission
Is B2BOptionalbooleanBusiness to Business flag
Is TestbedOptionalbooleanTestbed document flag
PurposeOptionalstringDocument purpose (e.g., testbed, e-invoicing, mapping)
ModeOptionalstringDocument processing mode
OperationOptionalstringDocument operation type
Source IDOptionalstringSource identifier
Source NameOptionalstringSource name
Source TypeOptionalstringSource type
Source VersionOptionalstringSource version
VersionOptionalstringDocument version

Required fields by document type

The table’s requirements as lists of GETS paths. A conditional field is required only when the condition in its description is met. Fields a modifier or variant makes mandatory are listed under it.

Every document type

Mandatory: header.documentType.base, header.documentNumber, header.uuid, header.issueDate, header.issueTime, header.currency, parties.seller.name, parties.seller.address.country, parties.seller.address.city, parties.seller.taxIds[].type, parties.seller.taxIds[].value, parties.seller.registrationNumbers[].type, parties.seller.registrationNumbers[].value, parties.seller.contact.phone, parties.buyer.name, parties.buyer.address.country, parties.buyer.registrationNumbers[].type, parties.buyer.registrationNumbers[].value, lineItems[].id, lineItems[].name, lineItems[].quantity, lineItems[].unitCode, lineItems[].lineTotal, lineItems[].taxAmount, lineItems[].taxCategory, lineItems[].price.amount, totals.totalAmountExcludingTax, totals.totalAmountIncludingTax, totals.amountDue, totals.totalLineTaxableAmount, totals.totalTaxAmount, parties.seller.peppolId, parties.buyer.peppolId, extensions.peppol_seller_peppolIdScheme, extensions.peppol_buyer_peppolIdScheme

Conditional: lineItems[].lineTaxableValue, payment.paymentMeans[].creditTransferInfo.payeeFinancialAccountId, extensions.peppol_precedingInvoiceIssueDate, extensions.peppol_totalTaxAmountInTaxCurrency, taxTotals[].taxAmount, taxTotals[].taxSubtotals[].taxableAmount, taxTotals[].taxSubtotals[].taxAmount, taxTotals[].taxSubtotals[].taxCategory, taxTotals[].taxSubtotals[].percent, taxTotals[].taxSubtotals[].taxExemptionReason, taxTotals[].taxSubtotals[].taxExemptionReasonCode

Tax invoice (tax_invoice)

Also mandatory: lineItems[].extensions.om_itemType

Also conditional: lineItems[].extensions.om_industrialClassifications[].code

Credit note (credit_note)

Also mandatory: lineItems[].extensions.om_itemType

Also conditional: lineItems[].extensions.om_industrialClassifications[].code

Debit note (debit_note)

Also mandatory: lineItems[].extensions.om_itemType

Also conditional: lineItems[].extensions.om_industrialClassifications[].code

Simplified invoice (simplified_invoice)

Nothing beyond the fields every document type needs.

Simplified credit note (simplified_credit_note)

Nothing beyond the fields every document type needs.

Simplified debit note (simplified_debit_note)

Nothing beyond the fields every document type needs.

Modifiers and variants

  • self_billed (modifier): no further mandatory fields.
  • third_party (modifier): no further mandatory fields.
  • summary (modifier): no further mandatory fields.
  • continuous_supply (modifier): no further mandatory fields.
  • export (modifier): no further mandatory fields.
  • deemed_supply (modifier): no further mandatory fields.
  • reverse_charge (modifier): no further mandatory fields.
  • margin_scheme (modifier): no further mandatory fields.
  • e_commerce (modifier): no further mandatory fields.
  • import_goods (modifier): no further mandatory fields.
  • special_zone_supplies (modifier): no further mandatory fields.
  • b2g (modifier): no further mandatory fields.
  • advance (variant): no further mandatory fields.