Try in playground

Field reference

Every GETS payload field for each country: whether it is mandatory, conditional or optional, and the values it accepts.

These are the fields of payload in POST https://prod.gets.complyance.io/api/v3/unify. For the endpoint, headers, the rest of the request body, the response and errors, see Submit and retrieve.

Payload fields

United Arab Emirates

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

DescriptionEnums
Document NumberInvoice numberMandatorystringUnique document number
Issue DateInvoice issue dateMandatorydateDocument issue date
Invoice CurrencyInvoice currency codeMandatorystringDocument currency
Currency: 177 codes
Tax Accounting CurrencyTax accounting currencyConditionalstringTax currency (often same as document currency) Required when currency ≠ AED
Currency: 177 codes
Due DatePayment due dateConditionaldatePayment due date Mandatory for tax invoices; optional for credit notes. With the deemed_supply modifier: optional for tax invoices. UAE PINT-AE IBT-009UAE PINT-AE IBR-127-AE exempts credit notes from the payment due date requirementUAE PINT-AE IBR-127-AE exempts deemed supply from payment due date
Additional NotesInvoice noteOptionalstringAdditional notes
Reference IDPreceding Invoice referenceConditionalstringOriginal invoice reference ID Mandatory for credit notes; optional for tax invoices. Credit note requires original invoice reference
Invoice Period StartInvoicing period start dateConditionaldateStart date of the invoiced period Conditional with the summary modifier. UAE PINT-AE IBR-138-AE requires an invoicing period for summary invoices
Invoice Period EndInvoicing period end dateConditionaldateEnd date of the invoiced period Conditional with the summary modifier. UAE PINT-AE IBR-138-AE requires an invoicing period for summary invoices
Document BaseMandatorystringBase document type (e.g., tax_invoice, credit_note, debit_note)
tax_invoiceTax invoicecredit_noteCredit note
Exchange RateConditionalnumberExchange rate when currency differs from tax currency Required when currency ≠ AED
Invoice Period FrequencyConditionalstringFrequency of the billing period (monthly, weekly, etc.) Conditional with the summary modifier. UAE PINT-AE IBR-138-AE requires an invoicing period for summary invoices
DAILYDailyWEEKLYWeeklyONCE_IN_15_DAYSOnce in 15 daysMONTHLYMonthlyONCE_IN_45_DAYSOnce in 45 daysONCE_IN_60_DAYSOnce in 60 days
Document IDOptionalstringInternal system document identifier (UUID or database ID)
Document ModifiersOptionalarrayDocument modifiers (e.g., export, summary, self-billed)
free_trade_zoneFree trade zonedisclosed_agentDisclosed agente_commerceE-commerceexportExportreverse_chargeReverse chargecontinuous_supplyContinuous supply
Document VariantOptionalstringDocument variant (e.g., B2B, B2C)
Exchange Rate DateOptionaldateExchange rate date
Issue TimeOptionalstringDocument issue time (HH:MM or HH:MM:SS:0000)
Note Issuance ReasonOptionalstringReason for credit/debit note
Reference NumbersOptionalarrayReference to original invoice (notes)
Seller Registration TypeSeller legal registration identifier typeMandatorystringSeller registration type
Seller NameSeller nameSeller trading nameMandatorystringSeller company name
Seller Party IDSeller identifierOptionalstringSeller internal party ID
Seller Registration ValueSeller legal registration identifierMandatorystringSeller registration value
Seller Tax ID ValueSeller VAT identifierSeller tax registration identifierConditionalstringSeller tax ID value Optional with the out_of_scope modifier. UAE PINT-AE IBR-134-AE does not require Seller VAT identifier for out-of-scope invoices
Seller Tax ID TypeTax scheme codeMandatorystringSeller tax ID type (VAT, TIN, etc.)
Seller Peppol IDSeller electronic addressMandatorystringSeller's Peppol network identifier for Peppol delivery
Seller Address Line 1Seller address line 1MandatorystringSeller address line 1 UAE address requirement
Seller Address Line 2Seller address line 2OptionalstringSeller address line 2
Seller CitySeller cityMandatorystringSeller city
Seller Postal CodeSeller post codeOptionalstringSeller postal code
Seller State/ProvinceSeller country subdivisionMandatorystringSeller state/province UAE emirate required
Only when the country is AE. AUHAbu DhabiDXBDubaiSHJSharjahUAQUmm Al QuwainFUJFujairahAJMAjmanRAKRas Al Khaimah
Seller CountrySeller country codeMandatorystringSeller country code
Country: 251 codes
Seller Contact NameSeller contact pointOptionalstringSeller contact name
Seller Contact PhoneSeller contact telephone numberOptionalstringSeller contact phone
Seller Contact EmailSeller contact email addressOptionalstringSeller contact email
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 3OptionalstringSeller address line 3
Seller Business ActivityOptionalstringSeller business activity
Seller Industry Classification CodeOptionalstringIndustry classification code
Seller Industry Classification DescriptionOptionalstringIndustry classification description
Seller Industry Classification SchemeOptionalstringIndustry classification scheme
Seller Trade NameOptionalstringSeller trade name
Buyer Registration TypeBuyer legal registration identifier typeMandatorystringBuyer registration type
Buyer NameBuyer nameBuyer trading nameMandatorystringBuyer company/name
Buyer Party IDBuyer identifierOptionalstringBuyer internal party ID
Buyer Registration ValueBuyer legal registration identifierMandatorystringBuyer registration value
Buyer Tax ID ValueBuyer VAT identifierConditionalstringBuyer tax ID value Optional with the export modifier. Mandatory with the reverse_charge modifier. UAE TRN for B2B buyersUAE TRN optional for export buyersRCM requires buyer TRN
Buyer Tax ID TypeTax scheme codeOptionalstringBuyer tax ID type
Buyer Peppol IDBuyer electronic addressMandatorystringBuyer's Peppol network identifier for Peppol delivery
Buyer Address Line 1Buyer address line 1MandatorystringBuyer address line 1 UAE address requirement
Buyer Address Line 2Buyer address line 2OptionalstringBuyer address line 2
Buyer CityBuyer cityMandatorystringBuyer city UAE address requirement
Buyer Postal CodeBuyer post codeOptionalstringBuyer postal code
Buyer State/ProvinceBuyer country subdivisionMandatorystringBuyer state/province UAE emirate required
Only when the country is AE. AUHAbu DhabiDXBDubaiSHJSharjahUAQUmm Al QuwainFUJFujairahAJMAjmanRAKRas Al Khaimah
Buyer CountryBuyer country codeMandatorystringBuyer country code
Country: 251 codes
Buyer Contact NameBuyer contact pointOptionalstringBuyer contact name
Buyer Contact PhoneBuyer contact telephone numberOptionalstringBuyer contact phone
Buyer Contact EmailBuyer contact email addressOptionalstringBuyer contact email
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 3OptionalstringBuyer address line 3
Buyer Business ActivityOptionalstringBuyer business activity
Buyer Industry Classification CodeOptionalstringBuyer industry code
Buyer Industry Classification DescriptionOptionalstringBuyer industry description
Buyer Industry Classification SchemeOptionalstringBuyer industry scheme
Buyer Trade NameOptionalstringBuyer trade name
Delivery Address Line 1Deliver to address line 1ConditionalstringDelivery address line 1 Mandatory with the e_commerce or export modifier. E-commerce deliveryExport delivery
Delivery CityDeliver to cityConditionalstringDelivery city Mandatory with the e_commerce or export modifier. E-commerce deliveryExport delivery
Delivery Post CodeDeliver to post codeOptionalstringPostal code for delivery address
Delivery Country SubdivisionDeliver to country subdivisionConditionalstringState, emirate or province for delivery address Mandatory with the e_commerce or export modifier. E-commerce deliveryExport delivery
Only when the country is AE. AUHAbu DhabiDXBDubaiSHJSharjahUAQUmm Al QuwainFUJFujairahAJMAjmanRAKRas Al Khaimah
Delivery CountryDeliver to country codeConditionalstringDelivery country Mandatory with the e_commerce or export modifier. E-commerce deliveryExport delivery
Country: 251 codes
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 2OptionalstringAdditional delivery address line
Delivery Address Line 3OptionalstringThird delivery address line
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)
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 IDInvoice line identifierMandatorystringLine item identifier
Line Item QuantityInvoiced quantityMandatorynumberLine item quantity
Line Item Unit CodeInvoiced quantity unit of measure codeItem price base quantity unit of measure codeMandatorystringUnit code (PCE, KGM, etc.)
Line Total Without TaxInvoice line net amountMandatorynumberNet line amount excluding VAT. Emitted as the UAE invoice line extension amount. UAE IBR-147-AE requires the IBT-131 invoice line net amount
Line Discount/Charge AmountInvoice line allowance amountInvoice line charge amountOptionalnumberDiscount/Charge amount
Line Discount/Charge Base AmountInvoice line allowance base amountInvoice line charge base amountOptionalnumberDiscount/Charge base amount
Line Discount/Charge PercentageInvoice line allowance percentageInvoice line charge percentageOptionalnumberDiscount/Charge percentage
Line Discount/Charge ReasonInvoice line allowance reasonInvoice line charge reasonOptionalstringDiscount/Charge reason
Line Discount/Charge Reason CodeInvoice line allowance reason codeInvoice line charge reason codeOptionalstringDiscount/Charge reason code
For allowances bonus_for_works_ahead_of_scheduleBonus for works ahead of scheduleother_bonusOther bonusmanufacturers_consumer_discountManufacturer's consumer discountdue_to_military_statusDue to military statusdue_to_work_accidentDue to work accidentspecial_agreementSpecial agreement
For charges
Item Net PriceItem net priceMandatorynumberNet unit price excluding VAT.
Item Gross PriceItem gross priceMandatorynumberUnit price before a price-level discount, excluding VAT. UAE PINT-AE IBR-126-AE requires Item Gross Price
Base QuantityItem price base quantityOptionalnumberBase quantity
Line Tax CategoryInvoiced item VAT category codeMandatorystringLine tax category UAE VAT category required per line
SStandard rateEExempt from taxOServices outside scope of tax / Not subject to taxAEVAT Reverse ChargeZZero ratedNStandard rate additional VAT
Line Tax RateInvoiced item VAT rateConditionalnumberLine tax rate Conditional with the out_of_scope modifier. UAE VAT rate required per lineOut-of-scope invoices permit E/O lines without a VAT rate and Z lines with a zero rate (ALIGNED-IBRP-E-05, ALIGNED-IBRP-O-05, ALIGNED-IBRP-Z-05)
Line Item NameItem nameMandatorystringLine item name/description
Line Item DescriptionItem descriptionOptionalstringLine item description
Standard Item Code IDItem standard identifierConditionalstringStandard item code ID Mandatory with the reverse_charge modifier. RCM requires item classification
Standard Item Code SchemeScheme identifierConditionalstringStandard item code scheme Mandatory with the reverse_charge modifier. RCM requires item classification scheme
Identifier scheme: 243 codes
Tax Exemption ReasonVAT exemption reason textConditionalstringTax exemption reason Required for exempt/zero-rated lines
Tax Exemption Reason CodeVAT exemption reason codeConditionalstringTax exemption reason code Required for exempt/zero-rated lines
CERTAIN_FINANCIAL_SERVICESCertain financial servicesRESIDENTIAL_UNITSSupply of residential units (lease or sale)BARE_LANDBare landLOCAL_PASSENGER_TRANSPORTLocal passenger transport
Line Item Tax AmountMandatorynumberTax amount for the line item, excluding the net line amount.
Commodity Classification CodeConditionalstringCommodity classification code UAE PINT-AE IBR-184-AE and IBR-186-AE require item classification for goods and mixed items
Commodity Classification SchemeConditionalstringCommodity classification scheme UAE PINT-AE IBR-188-AE requires the HS scheme when item classification is provided
Buyer Item CodeOptionalstringBuyer item code
Commodity Classification DescriptionOptionalstringCommodity classification description
Commodity CodeOptionalstringTariff/commodity code
Country Of OriginOptionalstringCountry of origin
Line Discount/Charge IDOptionalstringDiscount/Charge ID
Line Discount/Charge is ChargeOptionalbooleanIs charge or discount
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 Total With TaxOptionalnumberTax-inclusive line amount. Calculated from the line total without tax and line tax amount when omitted. UAE BTAE-10 invoice line amount payable can be enriched from net amount plus VAT
Line TypeOptionalstringLine type
Base Quantity Unit CodeOptionalstringBase quantity unit code
Line Related Document TypeOptionalstringRelated document type
Line Related Document IDOptionalstringRelated document ID
Seller Item CodeOptionalstringSeller item code
VAT Line Amount in AEDVAT Line amount in AEDOptionalnumberVAT amount calculated in AED currency.
Line Amount in AEDInvoice line amount in AEDOptionalnumberInvoice line amount payable calculated in AED currency.
Line NoteInvoice line noteOptionalstringFree text note for the line item.
Line Object IdentifierInvoice line object identifierOptionalstringObject identifier for the line item.
Line Object Identifier SchemeScheme identifierOptionalstringScheme for the line item object identifier.
Reference type: 818 codes
Order Line ReferenceReferenced purchase order line referenceOptionalstringReference to the corresponding order line.
Line Accounting ReferenceInvoice line Buyer accounting referenceOptionalstringAccounting reference for the line item.
Line Invoice Period StartInvoice line period start dateOptionaldateStart date of the invoiced period for this line.
Line Invoice Period EndInvoice line period end dateOptionaldateEnd date of the invoiced period for this line.
Item Price Allowance AmountItem price discountOptionalnumberItem-level allowance calculated from the gross and net prices.
Attribute NameItem attribute nameOptionalstringName of the line item attribute.
Attribute ValueItem attribute valueOptionalstringValue of the line item attribute.
Item TypeConditionalstringGoods, Services, or Both; emitted as item CommodityCode G, S, or B.
GoodsServicesBoth
Reverse Charge Mechanism TypeConditionalstringReverse charge mechanism type for goods/services. Required when the reverse_charge modifier is active or when taxCategory is AE. Mandatory with the reverse_charge modifier. RCM type required
ELECTRONIC_DEVICESGOLD_AND_DIAMONDSCRUDE_OR_REFINED_OILUNPROCESSED_OR_PROCESSED_NATURAL_GASPURE_HYDROCARBONS
Service Accounting Code SchemeConditionalstringMust be "SAC" when a service accounting code is provided.
Service Accounting CodeConditionalstringService accounting code, emitted as AdditionalItemIdentification/ID. Required for Services and Both items.
Batch NumberOptionalstringUAE-specific batch ID. Used for inventory tracking and batch management.
Service Accounting Code Scheme VersionOptionalstringSAC scheme version. Version of the service accounting code scheme.
Line Buyer Accounting ReferenceOptionalstringBuyer accounting reference for the line item.
Commodity Classification VersionOptionalstringVersion of the commodity classification scheme.
Line Tax SchemeOptionalstringTax scheme for the line item (IBT-167). Typically VAT for Peppol/EN 16931 invoices.
Total Line Taxable AmountSum of Invoice line net amountMandatorynumberSum of line taxable values
Total AllowancesSum of allowances on document levelOptionalnumberTotal allowances
Total ChargesSum of charges on document levelOptionalnumberTotal charges
Total Amount Excluding TaxInvoice total amount without TAXMandatorynumberTotal excluding tax
Total Amount Including TaxInvoice total amount with TAXMandatorynumberTotal including tax
Prepaid AmountPaid amountOptionalnumberPrepaid amount
Rounding AmountRounding amountOptionalnumberRounding adjustment
Amount DueAmount due for paymentMandatorynumberAmount due
Total Tax AmountMandatorynumberTotal tax amount
Invoice Discount/Charge AmountDocument level allowance amountDocument level charge amountOptionalnumberAllowance/charge amount
Invoice Discount/Charge Base AmountDocument level allowance base amountDocument level charge base amountOptionalnumberBase amount
Invoice Discount/Charge PercentageDocument level allowance percentageDocument level charge percentageOptionalnumberPercent applied
Invoice Discount/Charge Tax CategoryDocument level allowance VAT category codeDocument level charge VAT category codeOptionalstringTax category
SStandard rateEExempt from taxOServices outside scope of tax / Not subject to taxAEVAT Reverse ChargeZZero ratedNStandard rate additional VAT
Invoice Discount/Charge Tax RateDocument level allowance VAT rateDocument level charge VAT rateOptionalnumberTax rate
Invoice Discount/Charge ReasonDocument level allowance reasonDocument level charge reasonOptionalstringReason for allowance/charge
Invoice Discount/Charge Reason CodeDocument level allowance reason codeDocument level charge reason codeOptionalstringReason code
For allowances bonus_for_works_ahead_of_scheduleBonus for works ahead of scheduleother_bonusOther bonusmanufacturers_consumer_discountManufacturer's consumer discountdue_to_military_statusDue to military statusdue_to_work_accidentDue to work accidentspecial_agreementSpecial agreement
For charges
Invoice Discount/Charge Line IDOptionalstringAllowance/Charge ID
Invoice-level Is ChargeOptionalbooleanCharge (true) or allowance (false)
Invoice Discount/Charge Tax AmountOptionalnumberTax amount
Payment Terms NotePayment termsOptionalstringPayment terms note
Payment Means CodePayment means type codeConditionalstringPayment method type. Must be one of: 'CASH', 'CREDIT', 'PAYMENT_TO_BANK_ACCOUNT', 'BANK_CARD', 'INSTRUMENT_NOT_DEFINED', 'CHEQUE', 'ACH', 'BANKER_DRAFT', 'OTHER'. Will be converted to numeric code for ZATCA XML. Mandatory for tax invoices; optional for credit notes. With the deemed_supply modifier: optional for tax invoices. UAE PINT-AE payment means mandatoryUAE PINT-AE IBR-191-AE prohibits payment means code for credit notesUAE PINT-AE IBR-191-AE prohibits payment means code for deemed supply
INSTRUMENT_NOT_DEFINEDInstrument not definedIN_CASHCashCHEQUEChequeBANKERS_DRAFTBanker's draftCREDIT_TRANSFERCredit transferDIRECT_DEBITDirect debit
Payment IDRemittance informationOptionalstringPayment identifier
Payee Account IDPayment account identifierConditionalstringPayee account ID
Payee Account NamePayment account nameOptionalstringPayee account name
Payee Institution BranchPayment service provider identifierOptionalstringPayee institution branch
Discount AmountTerms amountOptionalnumberDiscount amount
Card Holder NameOptionalstringCard holder name
Card NetworkOptionalstringCard network ID
Card PANOptionalstringCard primary account number
Direct Debit Mandate Ref IDOptionalstringDirect debit mandate reference
Payer Financial AccountOptionalstringPayer financial account
Payment Means TextOptionalstringPayment method description
Discount Due DateOptionaldateDiscount due date
Penalty AmountOptionalnumberPenalty amount
Penalty PercentageOptionalnumberPenalty percent
Settlement Discount PercentageOptionalnumberSettlement discount percent
Supporting Document IDProject referenceInvoiced object identifierSupporting document referenceOptionalstringSupporting document identifier
Supporting Document DescriptionSupporting document descriptionOptionalstringDescription of supporting document
Supporting Document URLExternal document locationOptionalstringReference URL
Attachment ContentAttached documentOptionalstringAttachment base64 content
Attachment Mime CodeAttached document Mime codeOptionalstringAttachment mime code
Attachment FilenameAttached document FilenameOptionalstringAttachment file name
Attachment ChecksumOptionalstringAttachment checksum
Attachment Content URLOptionalstringAttachment content URL
Attachment DescriptionOptionalstringAttachment description
Attachment SizeOptionalnumberAttachment size
Supporting Document TypeOptionalstringType of supporting document
Supporting Document Issue DateOptionaldateSupporting document issue date
Tax Point DateVAT point dateOptionaldateDate when VAT becomes accountable (BT-7). Critical for VAT compliance and tax period determination.
Buyer Accounting ReferenceBuyer referenceOptionalstringAccounting reference provided by the buyer.
Accounting CostBuyer accounting referenceOptionalstringBuyers accounting cost centre (BT-19).
Seller Identifier SchemeScheme identifierOptionalstringISO/IEC 6523 scheme ID for seller identifier (BT-29-1). Defines the format and authority of the seller identifier.
Registration Number SchemeScheme identifierScheme identifierOptionalstringScheme for seller legal registration identifier (BT-30-1). E.g. CBE, Handelsregister.
Identifier scheme: 243 codes
Seller Additional Legal InformationSeller additional legal informationOptionalstringAdditional legal information about the seller (BT-33). E.g. legal form (SPRL, SA, BV, NV, ASBL).
Seller Electronic Address SchemeSeller electronic address identification scheme identifierMandatorystringPeppol participant scheme identifier for seller (BT-34-1). For UAE typically 0235 (TRN) or 0088 (GLN).
Electronic address scheme: 90 codes
Buyer Identifier SchemeScheme identifierOptionalstringISO/IEC 6523 scheme ID for buyer identifier (BT-46-1). Defines the format and authority of the buyer identifier.
Identifier scheme: 243 codes
Buyer Electronic Address SchemeScheme identifierMandatorystringPeppol participant scheme identifier for buyer
Electronic address scheme: 90 codes
Payment Account Identifier SchemeScheme identifierOptionalstringScheme for payment account identifier (BT-84-1). Typically IBAN for SEPA credit transfers.
Invoice Total VAT Amount in Tax Accounting CurrencyInvoice total VAT amount in tax accounting currencyConditionalnumberTotal VAT amount expressed in tax accounting currency (BT-111). Required when taxCurrency differs from document currency.
Preceding Invoice Issue DateConditionaldateIssue date of the original preceding invoice (BT-26). Required for credit/debit notes and continuous supply.
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.
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.
Tax Point Date CodeOptionalstringCode indicating the tax point date type.
Credit Note Reason CodeCredit note reason codeConditionalstringInternal reason code for credit note. Accepted public enums are mapped into DL8.61.1.A, DL8.61.1.B, DL8.61.1.C, DL8.61.1.D, DL8.61.1.E, or VD. Mandatory for credit notes; optional for tax invoices. Credit note reason code required
SUPPLY_CANCELLEDIf the supply was cancelled.TAX_TREATMENT_CHANGEDIf the tax treatment of the supply has changed due to a change in the nature of the supply.CONSIDERATION_ALTEREDIf the previously agreed consideration for the supply was altered for any reason (i.e. bad debt relief).GOODS_OR_SERVICES_RETURNEDIf the recipient of goods or recipient of services returned them to the registrant in full or in part and the Consideration was returned in full or in part.TAX_APPLIED_IN_ERRORIf the tax was charged or tax treatment was applied in error.VOLUME_DISCOUNTVolume Discount.
Buyer Authority NameAuthority NameConditionalstringIssuing authority name for buyer registration. Required when the buyer legal registration type is Commercial/Trade license (TL).
Seller Authority NameAuthority NameConditionalstringIssuing authority name for seller registration. Required for certain registration types (e.g., passport-based).
Seller Passport Issuing Country CodePassport issuing Country codeConditionalstringCountry code for passport-based registration (seller). ISO 3166-1 alpha-2 format.
Country: 251 codes
Buyer Passport Issuing Country CodePassport issuing Country codeConditionalstringCountry code for passport-based registration (buyer).
Country: 251 codes
Beneficiary IDConditionalstringFree trade zone beneficiary ID. Required when the free_trade_zone modifier is selected. Mandatory with the free_trade_zone modifier. FTZ transaction
Principal TRNConditionalstringPrincipal TRN for disclosed agent billing scenarios. Required when isDisclosedAgent=true. Mandatory with the disclosed_agent modifier. UAE PINT-AE IBR-137-AE requires Principal ID for disclosed agent billing
Total Amount Including Tax in AEDConditionalnumberTotal invoice amount including tax in AED currency. Required when invoice currency is not AED.
Contract ValueOptionalnumberOptional contract value for contract-based invoicing scenarios.
Delivery Party TRNOptionalstringTax Registration Number of the delivery party.
Bank Address Line 1OptionalstringFirst line of the bank address.
Bank Address Line 2OptionalstringSecond line of the bank address.
Bank Address Line 3OptionalstringThird line of the bank address.
Bank Address CityOptionalstringCity of the bank address.
Bank Address CountryOptionalstringCountry of the bank address. ISO 3166-1 alpha-2 format.
Bank Address Postal CodeOptionalstringPostal code of the bank address.
Bank Address State or ProvinceOptionalstringState or province of the bank address.
Direct Debit Creditor ID SchemeOptionalstringScheme identifier for direct debit creditor ID.
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