Try in playground

Saudi Arabia: fields

Every GETS field a Saudi 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

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

DescriptionEnums
Invoice CurrencyMandatorystringDocument currency
Document NumberMandatorystringUnique document number
Document BaseMandatorystringBase document type (e.g., tax_invoice, credit_note, debit_note)
tax_invoiceTax invoicecredit_noteCredit notedebit_noteDebit notesimplified_invoiceSimplified invoicesimplified_credit_noteSimplified credit notesimplified_debit_noteSimplified debit note
Issue DateMandatorydateDocument issue date
Exchange RateConditionalnumberExchange rate when currency differs from tax currency Mandatory with the export modifier. Export requires exchange rate
Invoice Period EndConditionaldateEnd date of the invoiced period Mandatory with the summary or continuous_supply modifier. Summary invoice periodContinuous supply period
Invoice Period StartConditionaldateStart date of the invoiced period Mandatory with the summary or continuous_supply modifier. Summary invoice periodContinuous supply period
Note Issuance ReasonConditionalstringReason for credit/debit note Mandatory for credit notes, debit notes, simplified credit notes and simplified debit notes; optional for tax invoices and simplified invoices. ZATCA credit note requires note issuance reasonZATCA debit note requires note issuance reason
Additional NotesOptionalstringAdditional notes
Document IDOptionalstringInternal system document identifier (UUID or database ID)
Document ModifiersOptionalarrayDocument modifiers (e.g., export, summary, self-billed)
exportExportsummarySummarycontinuous_supplyContinuous supplyb2gB2Gthird_partyThird partynominal_supplyNominal supplynominalNominalself_billedSelf billed
Document VariantOptionalstringDocument variant (e.g., B2B, B2C)
prepaymentPrepayment
Due DateOptionaldatePayment due date
Exchange Rate DateOptionaldateExchange rate date
Exchange Source CurrencyOptionalstringExchange rate source currency
Exchange Target CurrencyOptionalstringExchange rate target currency
Invoice Period FrequencyOptionalstringFrequency of the billing period (monthly, weekly, etc.)
Issue TimeOptionalstringDocument issue time (HH:MM or HH:MM:SS:0000)
Reference IDOptionalstringOriginal invoice reference ID
Reference NumbersOptionalarrayReference to original invoice (notes)
Tax Accounting CurrencyOptionalstringTax currency (often same as document currency)
Seller CityMandatorystringSeller city
Seller CountryMandatorystringSeller country code
Seller NameMandatorystringSeller company name
Seller Registration TypeMandatorystringSeller registration type
Seller Registration ValueMandatorystringSeller registration value
Seller Tax ID TypeMandatorystringSeller tax ID type (VAT, TIN, etc.)
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 Additional NumberOptionalstringAdditional address number for seller (ZATCA requirement).
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 1OptionalstringSeller address line 1
Seller Address Line 2OptionalstringSeller address line 2
Seller Address Line 3OptionalstringSeller address line 3
Seller Postal CodeOptionalstringSeller postal code
Seller State/ProvinceOptionalstringSeller state/province
Seller Business ActivityOptionalstringSeller business activity
Seller Contact EmailOptionalstringSeller contact email
Seller Contact NameOptionalstringSeller contact name
Seller Contact PhoneOptionalstringSeller contact phone
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 NameMandatorystringBuyer company/name
Buyer CountryConditionalstringBuyer country code Mandatory for tax invoices, credit notes and debit notes; not used in simplified invoices, simplified credit notes and simplified debit notes.
Buyer Registration TypeConditionalstringBuyer registration type Mandatory for tax invoices, credit notes and debit notes; not used in simplified invoices, simplified credit notes and simplified debit notes.
Buyer Registration ValueConditionalstringBuyer registration value Mandatory for tax invoices, credit notes and debit notes; not used in simplified invoices, simplified credit notes and simplified debit notes.
Buyer Access Code BuildingOptionalstringbuyer access code building Optional for tax invoices, credit notes and debit notes; not used in simplified invoices, simplified credit notes and simplified debit notes.
Buyer Access Code GateOptionalstringbuyer access code gate Optional for tax invoices, credit notes and debit notes; not used in simplified invoices, simplified credit notes and simplified debit notes.
Buyer Access Code IntercomOptionalstringbuyer access code intercom Optional for tax invoices, credit notes and debit notes; not used in simplified invoices, simplified credit notes and simplified debit notes.
Buyer Address TypeOptionalstringbuyer address type Optional for tax invoices, credit notes and debit notes; not used in simplified invoices, simplified credit notes and simplified debit notes.
Buyer Address UsageOptionalstringbuyer address usage Optional for tax invoices, credit notes and debit notes; not used in simplified invoices, simplified credit notes and simplified debit notes.
Buyer ApartmentOptionalstringbuyer apartment Optional for tax invoices, credit notes and debit notes; not used in simplified invoices, simplified credit notes and simplified debit notes.
Buyer Attention ToOptionalstringbuyer attention to Optional for tax invoices, credit notes and debit notes; not used in simplified invoices, simplified credit notes and simplified debit notes.
Buyer Building NameOptionalstringbuyer building name Optional for tax invoices, credit notes and debit notes; not used in simplified invoices, simplified credit notes and simplified debit notes.
Buyer Building NumberOptionalstringBuyer building number Optional for tax invoices, credit notes and debit notes; not used in simplified invoices, simplified credit notes and simplified debit notes.
Buyer Business Hours CloseOptionalstringbuyer business hours close Optional for tax invoices, credit notes and debit notes; not used in simplified invoices, simplified credit notes and simplified debit notes.
Buyer Business Hours DaysOptionalarraybuyer business hours days Optional for tax invoices, credit notes and debit notes; not used in simplified invoices, simplified credit notes and simplified debit notes.
Buyer Business Hours OpenOptionalstringbuyer business hours open Optional for tax invoices, credit notes and debit notes; not used in simplified invoices, simplified credit notes and simplified debit notes.
Buyer Care OfOptionalstringbuyer care of Optional for tax invoices, credit notes and debit notes; not used in simplified invoices, simplified credit notes and simplified debit notes.
Buyer Delivery InstructionsOptionalstringbuyer delivery instructions Optional for tax invoices, credit notes and debit notes; not used in simplified invoices, simplified credit notes and simplified debit notes.
Buyer Delivery PointOptionalstringbuyer delivery point Optional for tax invoices, credit notes and debit notes; not used in simplified invoices, simplified credit notes and simplified debit notes.
Buyer DistrictOptionalstringBuyer district Optional for tax invoices, credit notes and debit notes; not used in simplified invoices, simplified credit notes and simplified debit notes.
Buyer Additional NumberOptionalstringAdditional address number for buyer (ZATCA requirement). Optional for tax invoices, credit notes and debit notes; not used in simplified invoices, simplified credit notes and simplified debit notes.
Buyer FloorOptionalstringbuyer floor Optional for tax invoices, credit notes and debit notes; not used in simplified invoices, simplified credit notes and simplified debit notes.
Buyer Geo Location LatitudeOptionalnumberbuyer geo location latitude Optional for tax invoices, credit notes and debit notes; not used in simplified invoices, simplified credit notes and simplified debit notes.
Buyer Geo Location LongitudeOptionalnumberbuyer geo location longitude Optional for tax invoices, credit notes and debit notes; not used in simplified invoices, simplified credit notes and simplified debit notes.
Buyer LandmarkOptionalstringbuyer landmark Optional for tax invoices, credit notes and debit notes; not used in simplified invoices, simplified credit notes and simplified debit notes.
Buyer Plus CodeOptionalstringbuyer plus code Optional for tax invoices, credit notes and debit notes; not used in simplified invoices, simplified credit notes and simplified debit notes.
Buyer PO BoxOptionalstringbuyer po box Optional for tax invoices, credit notes and debit notes; not used in simplified invoices, simplified credit notes and simplified debit notes.
Buyer Post OfficeOptionalstringbuyer post office Optional for tax invoices, credit notes and debit notes; not used in simplified invoices, simplified credit notes and simplified debit notes.
Buyer Room NumberOptionalstringbuyer room number Optional for tax invoices, credit notes and debit notes; not used in simplified invoices, simplified credit notes and simplified debit notes.
Buyer Street NameOptionalstringbuyer street name Optional for tax invoices, credit notes and debit notes; not used in simplified invoices, simplified credit notes and simplified debit notes.
Buyer Street NumberOptionalstringbuyer street number Optional for tax invoices, credit notes and debit notes; not used in simplified invoices, simplified credit notes and simplified debit notes.
Buyer Sub DistrictOptionalstringbuyer sub district Optional for tax invoices, credit notes and debit notes; not used in simplified invoices, simplified credit notes and simplified debit notes.
Buyer Time ZoneOptionalstringbuyer time zone Optional for tax invoices, credit notes and debit notes; not used in simplified invoices, simplified credit notes and simplified debit notes.
Buyer Valid FromOptionaldatebuyer valid from Optional for tax invoices, credit notes and debit notes; not used in simplified invoices, simplified credit notes and simplified debit notes.
Buyer Valid ToOptionaldatebuyer valid to Optional for tax invoices, credit notes and debit notes; not used in simplified invoices, simplified credit notes and simplified debit notes.
Buyer Verification DateOptionaldatebuyer verification date Optional for tax invoices, credit notes and debit notes; not used in simplified invoices, simplified credit notes and simplified debit notes.
Buyer Verification SourceOptionalstringbuyer verification source Optional for tax invoices, credit notes and debit notes; not used in simplified invoices, simplified credit notes and simplified debit notes.
Buyer VerifiedOptionalstringbuyer verified Optional for tax invoices, credit notes and debit notes; not used in simplified invoices, simplified credit notes and simplified debit notes.
Buyer WardOptionalstringbuyer ward Optional for tax invoices, credit notes and debit notes; not used in simplified invoices, simplified credit notes and simplified debit notes.
Buyer What Three WordsOptionalstringbuyer what three words Optional for tax invoices, credit notes and debit notes; not used in simplified invoices, simplified credit notes and simplified debit notes.
Buyer ZoneOptionalstringbuyer zone Optional for tax invoices, credit notes and debit notes; not used in simplified invoices, simplified credit notes and simplified debit notes.
Buyer Address Line 1OptionalstringBuyer address line 1 Optional for tax invoices, credit notes and debit notes; not used in simplified invoices, simplified credit notes and simplified debit notes.
Buyer Address Line 2OptionalstringBuyer address line 2 Optional for tax invoices, credit notes and debit notes; not used in simplified invoices, simplified credit notes and simplified debit notes.
Buyer Address Line 3OptionalstringBuyer address line 3 Optional for tax invoices, credit notes and debit notes; not used in simplified invoices, simplified credit notes and simplified debit notes.
Buyer CityOptionalstringBuyer city Optional for tax invoices, credit notes and debit notes; not used in simplified invoices, simplified credit notes and simplified debit notes.
Buyer Postal CodeOptionalstringBuyer postal code Optional for tax invoices, credit notes and debit notes; not used in simplified invoices, simplified credit notes and simplified debit notes.
Buyer State/ProvinceOptionalstringBuyer state/province Optional for tax invoices, credit notes and debit notes; not used in simplified invoices, simplified credit notes and simplified debit notes.
Buyer Business ActivityOptionalstringBuyer business activity Optional for tax invoices, credit notes and debit notes; not used in simplified invoices, simplified credit notes and simplified debit notes.
Buyer Contact EmailOptionalstringBuyer contact email Optional for tax invoices, credit notes and debit notes; not used in simplified invoices, simplified credit notes and simplified debit notes.
Buyer Contact NameOptionalstringBuyer contact name Optional for tax invoices, credit notes and debit notes; not used in simplified invoices, simplified credit notes and simplified debit notes.
Buyer Contact PhoneOptionalstringBuyer contact phone Optional for tax invoices, credit notes and debit notes; not used in simplified invoices, simplified credit notes and simplified debit notes.
Buyer Industry Classification CodeOptionalstringBuyer industry code Optional for tax invoices, credit notes and debit notes; not used in simplified invoices, simplified credit notes and simplified debit notes.
Buyer Industry Classification DescriptionOptionalstringBuyer industry description Optional for tax invoices, credit notes and debit notes; not used in simplified invoices, simplified credit notes and simplified debit notes.
Buyer Industry Classification SchemeOptionalstringBuyer industry scheme Optional for tax invoices, credit notes and debit notes; not used in simplified invoices, simplified credit notes and simplified debit notes.
Buyer Party IDOptionalstringBuyer internal party ID Optional for tax invoices, credit notes and debit notes; not used in simplified invoices, simplified credit notes and simplified debit notes.
Buyer Tax ID TypeOptionalstringBuyer tax ID type Optional for tax invoices, credit notes and debit notes; not used in simplified invoices, simplified credit notes and simplified debit notes.
Buyer Tax ID ValueOptionalstringBuyer tax ID value Optional for tax invoices, credit notes and debit notes; not used in simplified invoices, simplified credit notes and simplified debit notes.
Buyer Trade NameOptionalstringBuyer trade name Optional for tax invoices, credit notes and debit notes; not used in simplified invoices, simplified credit notes and simplified debit notes.
Delivery CountryConditionalstringDelivery country Mandatory with the third_party modifier. Third-party billing requires delivery party country
Delivery Party NameConditionalstringDelivery party name Mandatory with the third_party modifier. Third-party billing requires delivery party name
Delivery Tax ID ValueConditionalstringDelivery tax ID value Mandatory with the third_party modifier. Third-party billing requires delivery party tax ID
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 1OptionalstringDelivery address line 1
Delivery Address Line 2OptionalstringAdditional delivery address line
Delivery Address Line 3OptionalstringThird delivery address line
Delivery CityOptionalstringDelivery city
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)
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 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 Trade NameOptionalstringDelivery party trade name
Line Item IDMandatorystringLine item identifier
Line Item TotalMandatorynumberLine item total
Line Item NameMandatorystringLine item name/description
Item Net PriceMandatorynumberNet unit price excluding VAT.
Line Item QuantityMandatorynumberLine item quantity
Line Item Tax AmountMandatorynumberTax amount for the line item, excluding the net line amount.
Line Item Unit CodeMandatorystringUnit code (PCE, KGM, etc.)
Buyer Item CodeOptionalstringBuyer item code
Commodity Classification CodeOptionalstringCommodity classification code
Commodity Classification DescriptionOptionalstringCommodity classification description
Commodity Classification SchemeOptionalstringCommodity classification scheme
Commodity CodeOptionalstringTariff/commodity code
Country Of OriginOptionalstringCountry of origin
Line Item DescriptionOptionalstringLine item description
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 Taxable ValueOptionalnumberLine taxable value
Line TypeOptionalstringLine type
Base QuantityOptionalnumberBase quantity
Base Quantity Unit CodeOptionalstringBase quantity unit code
Item Gross PriceOptionalnumberUnit price before a price-level discount, excluding VAT.
Line Related Document TypeOptionalstringRelated document type
Line Related Document IDOptionalstringRelated document ID
Seller Item CodeOptionalstringSeller item code
Standard Item Code IDOptionalstringStandard item code ID
Standard Item Code SchemeOptionalstringStandard item code scheme
Line Tax CategoryOptionalstringLine tax category
Tax Exemption ReasonOptionalstringTax exemption reason
Tax Exemption Reason CodeOptionalstringTax exemption reason code
Line Tax RateOptionalnumberLine tax rate
Line Rounding AmountOptionalnumberKSA line-level RoundingAmount (ZATCA Phase 2).
Amount DueMandatorynumberAmount due
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 AmountOptionalnumberPrepaid amount
Rounding AmountOptionalnumberRounding adjustment
Total AllowancesOptionalnumberTotal allowances
Total ChargesOptionalnumberTotal charges
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 IDConditionalstringPayee account ID
Card Holder NameOptionalstringCard holder name
Card NetworkOptionalstringCard network ID
Card PANOptionalstringCard primary account number
Payee Account NameOptionalstringPayee account name
Payee Institution BranchOptionalstringPayee institution branch
Direct Debit Mandate Ref IDOptionalstringDirect debit mandate reference
Payer Financial AccountOptionalstringPayer financial account
Payment IDOptionalstringPayment identifier
Payment Means CodeOptionalstringPayment 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.
Payment Means TextOptionalstringPayment method description
Discount AmountOptionalnumberDiscount amount
Discount Due DateOptionaldateDiscount due date
Payment Terms NoteOptionalstringPayment terms note
Penalty AmountOptionalnumberPenalty amount
Penalty PercentageOptionalnumberPenalty percent
Settlement Discount PercentageOptionalnumberSettlement discount percent
Supporting Document TypeConditionalstringType of supporting document Mandatory with the b2g modifier. B2G requires supporting document type
Supporting Document IDConditionalstringSupporting document identifier Mandatory with the b2g modifier. B2G requires supporting document ID
Attachment ChecksumOptionalstringAttachment checksum
Attachment ContentOptionalstringAttachment base64 content
Attachment Content URLOptionalstringAttachment content URL
Attachment DescriptionOptionalstringAttachment description
Attachment FilenameOptionalstringAttachment file name
Attachment Mime CodeOptionalstringAttachment mime code
Attachment SizeOptionalnumberAttachment size
Supporting Document DescriptionOptionalstringDescription of supporting document
Supporting Document Issue DateOptionaldateSupporting document issue date
Supporting Document URLOptionalstringReference URL
Contract ReferenceOptionalstringContract reference for KSA XML rendering.
Digital SignatureOptionalstringBase64 encoded digital signature for ZATCA compliance.
Invoice Counter ValueOptionalstringInvoice counter value (ICV) for ZATCA invoice sequencing.
Previous Invoice HashOptionalstringPrevious invoice hash (PIH) for ZATCA invoice chaining.
Prepayment Adjustment AmountOptionalnumberAdjustment amount for the prepayment.
Prepayment DateOptionaldateDate of the prepayment.
Prepayment IDOptionalstringIdentifier for prepayment reference.
Prepayment Taxable AmountOptionalnumberTaxable amount for the prepayment.
Prepayment Tax AmountOptionalnumberTax amount for the prepayment.
Prepayment Tax CategoryOptionalstringTax category for the prepayment.
Prepayment Tax RateOptionalnumberTax rate for the prepayment.
Prepayment Type CodeOptionalstringType code for the prepayment.
Purchase Order ReferenceOptionalstringPurchase order reference for KSA XML rendering.
QR CodeOptionalstringBase64 encoded QR code for ZATCA compliance.
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