Complyance Logo

Field Mapping Payload Reference

Complete field mapping reference for all Unify API v3 payload fields organized by country.
Last Updated: 2024 · Scope: SA · MY · BE · DE · AE

Overview

This page provides a comprehensive field mapping reference organized by country sections. Each table includes:

  • Parameter: Human-readable field name (what the field represents, not JSON paths)
  • Required: Whether the field is mandatory (Yes), optional (No), or conditional (Conditional)
  • What It Means: Clear explanation of the field's purpose and business context
  • Example: Realistic example values for that field

Quick Navigation

Select your country:


Saudi Arabia (SA)

Document Header Fields

ParameterRequiredWhat It MeansExample
Document TypeYesThe type of document being submitted (Invoice, Credit Note, or Debit Note). Determines the base document classification for KSA e-invoicing.tax_invoice
Document IDYesUnique identifier for the invoice within the seller's sequence. Must be unique per seller and follow KSA format.INV-2024-001
Issue DateYesThe date the invoice was created in YYYY-MM-DD format. Used for ZATCA tax period determination.2024-01-15
Issue TimeYesThe time the invoice was created in HH:MM:SS format. Used for precise timestamping with ZATCA.14:30:00
Document CurrencyYesISO 4217 currency code. Defaults to SAR for KSA. Exchange rate required when currency differs from SAR.SAR
Exchange RateConditionalCurrency conversion rate (required only when currency differs from SAR).3.75
VAT CurrencyNoCurrency used for VAT calculations. Defaults to document currency.SAR
Supply Start DateConditionalRequired for period-based invoices. Start date of the supply period.2024-01-01
Supply End DateConditionalEnd date of the supply period. Used for consolidated invoices.2024-01-31
Billing FrequencyConditionalFrequency of billing for consolidated invoices (monthly, quarterly, annually, weekly).monthly
Due DateNoPayment due date. Optional but recommended for cash flow management.2024-02-15
Reference Invoice NumberConditionalReference to original invoice for credit/debit notes. Required for corrective documents.INV-2023-999
Note Issuance ReasonConditionalReason for issuing credit/debit note. Required for corrective documents.Goods returned

Seller Information Fields

ParameterRequiredWhat It MeansExample
Seller NameYesLegal registered name of the seller. Must match business registration with ZATCA.Tech Solutions LLC
Seller IDNoInternal ERP identifier for the seller. Optional but useful for system integration.SEL-001
VAT Number TypeYesVAT identification scheme for KSA (usually VAT or GVAT).VAT
VAT Number ValueYesKSA VAT number in 15-digit format. Must be valid and registered with ZATCA.310075588700003
Additional Seller ID NumberYesCommercial registration number (CRN). Required for business registration compliance.1234567890
Additional Seller ID TypeYesRegistration scheme type (CRN - Commercial Registration).CRN
Seller Industry ClassificationYesIndustry classification code for business activity identification.61110
Seller Contact NumberYesSeller contact phone number. Required for ZATCA communication.+966501234567
Seller EmailNoContact email. Optional but useful for electronic communication.info@techsolutions.sa
Address Line 1YesPrimary street address. Must be complete and accurate for ZATCA verification.King Fahd Road
Address Line 2NoSecondary address information.Suite 100
Building NumberYesBuilding number. Required in KSA for precise location identification.123
District/NeighbourhoodYesDistrict or neighbourhood. Required for local area identification.Olaya
CityYesCity name. Must match official city names for tax jurisdiction.Riyadh
StateYesState name. Required for tax jurisdiction and regional compliance.Riyadh Region
Postal CodeYesPostal/ZIP code. Required for address validation.11478
CountryYesCountry code. Must be 'SA' for KSA addresses.SA
Seller Peppol IDNoPeppol network identifier for cross-border e-invoicing. Optional for KSA.9930:SAxxxxxxxxxxxxxx

Buyer Information Fields (B2B)

ParameterRequiredWhat It MeansExample
Buyer NameConditionalBuyer name. Required for B2B transactions, optional for B2C.ABC Corporation
Buyer IDNoInternal identifier for the buyer. Optional for system integration.BUYER-001
Buyer VAT Number TypeConditionalVAT identification scheme. Required for B2B transactions.VAT
Buyer VAT Number ValueConditionalBuyer VAT number in 15-digit format. Required for B2B transactions.301234567890001
Buyer Additional ID NumberConditionalBuyer registration number. Required for B2B transactions.9876543210
Buyer Additional ID TypeConditionalBuyer registration scheme type. Required for B2B transactions.CRN
Buyer Peppol IDNoBuyer Peppol identifier for cross-border transactions. Optional.9930:SAyyyyyyyyyyyyyyyy
Buyer Contact NumberConditionalBuyer contact phone. Required for B2B transactions.+966501111111
Buyer EmailNoBuyer contact email. Optional but recommended.info@abccorp.sa
Buyer Address Line 1ConditionalBuyer primary address. Required for B2B transactions.Prince Road
Buyer Address Line 2NoBuyer secondary address.Floor 5
Buyer Building NumberNoBuyer building number. Optional.456
Buyer DistrictNoBuyer district. Optional.Downtown
Buyer CityConditionalBuyer city. Required for B2B transactions.Jeddah
Buyer StateConditionalBuyer state. Required for B2B transactions.Makkah Region
Buyer Postal CodeConditionalBuyer postal code. Required for B2B transactions.21461
Buyer CountryConditionalBuyer country code.SA

Line Items Fields

ParameterRequiredWhat It MeansExample
Line Item IDYesUnique identifier for each line item. Used for referencing items in the invoice.LINE-001
Item DescriptionYesDetailed description of the product or service. Supports multi-language.Professional consulting services
Item NameNoShort item name for product identification. Optional.Consultation
Unit PriceYesPrice per unit. Must be accurate for VAT calculations.1000.00
Line Item QtyYesQuantity of items ordered. Used for total calculations.5
Units of MeasurementNoUnit code (PCE for pieces, HUR for hours, SET for sets).HUR
Line Item DiscountNoDiscount amount for this line. Applied before VAT.100.00
Discount RateNoDiscount percentage.10
Discount Reason CodeNoCode explaining the discount.95
Charge AmountNoAny additional charges for this line.50.00
Charge Reason CodeNoCode explaining the charge.AA
Line Item Taxable AmountYesTotal line amount before VAT. Calculated as (Qty × Price) - Discounts.4900.00
VAT Category CodeYesVAT category (S=Standard 15%, Z=Zero, E=Exempt, O=Out of scope).S
VAT Rate On Line ItemYesVAT rate percentage.15
Line Item VAT AmountYesVAT amount for this line. Calculated as Taxable Amount × Rate.735.00
Line Item Sub TotalYesTotal including VAT. Calculated as Taxable Amount + VAT.5635.00
Item Classification CodeConditionalProduct classification code. Required for goods.39301
Item Classification NameNoDescription of the classification. Optional.Consulting Services
VAT Exemption Reason CodeConditionalExemption code (required if VAT Category = Exempt).VATEX-SA-32
VAT Exemption Reason TextConditionalText explaining the exemption.Export of services

Totals and Amounts Fields

ParameterRequiredWhat It MeansExample
Summation of Line Taxable ValuesYesSum of all line item taxable amounts. Used for VAT verification.14700.00
Total Taxable Amount Excluding VATYesTotal invoice amount before VAT.14700.00
VAT TotalYesTotal VAT amount for entire invoice. Sum of line VAT amounts.2205.00
Invoice Total AmountYesFinal amount payable including VAT.16905.00
Discount at document levelConditionalDocument-level discount. Applied after line-level calculations.500.00
Amount Due for PaymentYesFinal amount due. Calculated as total - prepaid amounts.16405.00
Pre-Paid AmountNoAmount already paid in advance.0.00
Rounding AmountNoRounding adjustment amount. Must be within acceptable limits.0.05

Payment Information Fields

ParameterRequiredWhat It MeansExample
Payment MeansYesPayment method code (CASH, CREDIT, PAYMENT_TO_BANK_ACCOUNT, BANK_CARD, INSTRUMENT_NOT_DEFINED).PAYMENT_TO_BANK_ACCOUNT
Payee Bank Account NumberConditionalSupplier's IBAN for payment. Required for bank transfers. Format: SA + 22 digits.SA1234567890123456789012
Payment Terms descriptionNoFree-text description of payment terms.Payment due within 30 days
Prepayment Reference NumberNoReference number for prepayments. Optional.PREP-2024-001

KSA Digital Fields

ParameterRequiredWhat It MeansExample
Invoice Counter ValueYesSequential counter for ZATCA digital signature. Required for compliance.1
Previous Invoice HashYesHash of previous invoice for chain verification. Required for ZATCA.NWZlY2E3YzcxNzQ...
QR CodeYesBase64 encoded QR data. Required for ZATCA compliance.A0A0A0A0A0A0A0...
Digital SignatureYesDigital signature data for authenticity. Required for ZATCA.MEUCIQD...
Prepayment IDConditionalUnique identifier for prepayments.PREP-001
Prepayment Issue Date & TimeConditionalDate when prepayment issued.2024-01-10
Prepayment Issue TimeConditionalTime when prepayment issued.10:00:00
Prepayment Document Type CodeConditionalDocument type for prepayment (always '386' for KSA).386
Prepayment VAT Category CodeConditionalVAT category for prepayment. Must match final invoice.S
Prepayment VAT RateConditionalVAT rate for prepayment. Must match final invoice.15
Prepayment Taxable AmountConditionalTaxable amount of prepayment.1000.00
Prepayment Tax AmountConditionalVAT amount of prepayment.150.00
Prepayment Adjustment AmountConditionalAdjustment amount for prepayment.0.00

Malaysia (MY)

Document Header Fields

ParameterRequiredWhat It MeansExample
E-Invoice Type CodeYesE-Invoice type (01=Invoice, 02=Credit Note, 03=Debit Note). Maps to LHDN requirements.01
E-Invoice Code / NumberYesUnique identifier for the e-invoice. Must be unique per seller.INV-MY-2024-001
E-Invoice DateYesDate the e-invoice was issued in YYYY-MM-DD format.2024-01-15
E-Invoice TimeYesTime the e-invoice was issued in HH:MM:SS format.14:30:00
Invoice Currency CodeYesISO 4217 currency code. Defaults to MYR for Malaysia.MYR
Currency Exchange RateConditionalExchange rate (required only when currency differs from MYR).4.65
Tax CurrencyNoCurrency used for tax calculations. Defaults to document currency.MYR
Billing Period Start DateConditionalStart date for period-based invoices.2024-01-01
Billing Period End DateConditionalEnd date for period-based invoices.2024-01-31
Frequency of BillingConditionalBilling frequency (monthly, quarterly, annually, weekly).monthly
Due DateNoPayment due date. Optional but recommended.2024-02-15
Original E-Invoice Reference NumberConditionalReference to original e-invoice for credit/debit notes.INV-MY-2023-999
Note Issuance ReasonConditionalReason for issuing credit/debit note.Goods returned

Seller Information Fields

ParameterRequiredWhat It MeansExample
Supplier's NameYesLegal registered name of the supplier. Must match LHDN registration.Tech Solutions Sdn Bhd
Supplier IDNoInternal ERP identifier for the supplier. Optional.SEL-001
Supplier's TINYesTax identification scheme (usually TIN).TIN
Supplier's TIN NumberYesMalaysia TIN number in format C12345678901.C12345678901
Supplier's Registration NumberYesBusiness registration number (BRN).BRN1234567
Supplier's Registration scheme IDYesRegistration scheme type.BRN
Supplier's SST Registration NumberConditionalSST registration number. Required for SST-registered businesses.SST-001-12345678
Supplier's Tourism Tax Registration NumberConditionalTourism tax registration. Required for hospitality businesses.TTX-001-12345678
Supplier's MSIC CodeYesMSIC code for business activity identification with LHDN.61110
Seller Peppol IDNoPeppol network identifier for cross-border e-invoicing.0177:C12345678901
Supplier's Contact NumberYesContact phone number. Required for LHDN communication.+60312345678
Supplier's e-mailNoContact email. Optional but useful.info@techsolutions.my
Address Line 1YesPrimary street address. Must be complete and accurate.Jalan Merdeka
Address Line 2NoSecondary address information.Unit 200
Building NumberNoBuilding number. Optional.123
DistrictNoDistrict. Optional.Kuala Lumpur
City NameYesCity name. Must match official city names.Kuala Lumpur
StateYesState. Required for tax jurisdiction.Wilayah Persekutuan
Postal ZoneYesPostal code. Required for address validation.50460
CountryYesCountry code. Must be 'MY' for Malaysia.MY
Supplier's Business ActivityYesDescription of business activities. Supports multi-language.Information Technology Consulting

Line Items Fields

ParameterRequiredWhat It MeansExample
Line IDYesUnique identifier for each line item.LINE-001
DescriptionYesDetailed description of product or service. Supports multi-language.Professional consulting services for IT projects
Item NameNoShort item name. Optional.Consultation
Unit PriceYesPrice per unit. Must be accurate for SST calculations.1000.00
QuantityYesQuantity of items. Used for total calculations.5
MeasurementNoUnit code (PCE, HUR, SET, etc.). Optional.HUR
Total Excluding TaxYesLine total before SST. Calculated as (Qty × Price) - Discounts.4900.00
Tax TypeYesTax type (TX=Taxable, Z=Zero-rated, E=Exempt).TX
Tax RateYesSST rate (6% for services, 10% for goods, 0% for zero-rated).6
Tax AmountYesSST amount for line. Calculated as Taxable Amount × Rate.294.00
Line TotalYesTotal including SST. Calculated as Taxable + Tax.5194.00

Totals and Amounts Fields

ParameterRequiredWhat It MeansExample
Sum of Line Level Taxable AmountsYesSum of all line taxable amounts. Used for SST verification.14700.00
Total Excluding TaxYesTotal invoice amount before SST.14700.00
Total Tax AmountYesTotal SST amount for entire invoice.882.00
Invoice Total Including TaxYesFinal amount payable including SST.15582.00
Total Payable AmountYesFinal amount due after prepayments.15082.00

Malaysia Digital Fields

ParameterRequiredWhat It MeansExample
Issuer's Digital SignatureYesDigital signature for LHDN compliance. Required.MEUCIQD...
LHDN Submission IDYesLHDN submission tracking ID. Required.LHDN-2024-001

Belgium (BE)

Document Header Fields

ParameterRequiredWhat It MeansExample
Invoice Type CodeYesDocument type (380=Invoice, 381=Credit Note, 383=Debit Note). Must be valid UBL type.380
Document NumberYesUnique invoice number. Must follow Belgium format.BE-INV-2024-001
Issue DateYesInvoice issue date in YYYY-MM-DD format. Required for all invoices.2024-01-15
Issue TimeNoInvoice issue time in HH:MM:SSZ format. Optional but recommended.14:30:00Z
Document Currency CodeYesISO 4217 currency code. Defaults to EUR for Belgium.EUR
Exchange RateConditionalExchange rate (required only when currency differs from EUR).1.10
Due DateYesPayment due date. Required for B2B transactions in Belgium.2024-02-15
Reference IDConditionalReference to original invoice for credit/debit notes.BE-INV-2023-999
Note Issuance ReasonConditionalReason for credit/debit note. Required for corrective documents.Goods returned

Seller Information Fields

ParameterRequiredWhat It MeansExample
Seller NameYesLegal registered name. Must match business registration.Tech Solutions SPRL
Tax ID TypeYesTax ID scheme. Fixed value: VAT for Belgium.VAT
Tax ID ValueYesBelgian VAT number. Format: BE + 10 digits. Must be valid.BE0123456789
Registration NumberYesCompany registration number (CBE). Format: 0123.456.789.0123.456.789
Street NameYesStreet name. Must be complete and accurate.Avenue Louise
Building NumberYesBuilding number. Required.123
CityYesCity name. Required.Bruxelles
Postal CodeYesPostal code. Format: 4 digits.1050
CountryYesCountry code. Must be "BE".BE
Seller PhoneNoContact phone number. Optional but recommended.+32212345678
Seller EmailNoContact email. Optional but recommended.info@techsolutions.be
Seller Peppol IDNoPeppol endpoint identifier. Format: 9925:BE0123456789.9925:BE0123456789

Buyer Information Fields (B2B)

ParameterRequiredWhat It MeansExample
Buyer NameConditionalBuyer name. Required for B2B transactions.ABC Corporation
Buyer Tax ID TypeConditionalTax ID scheme. Required for B2B. Fixed value: VAT.VAT
Buyer Tax ID ValueConditionalBuyer VAT number. Must be valid EU VAT.BE0987654321
Buyer Registration NumberConditionalBuyer company registration (CBE). Format: 0987.654.321.0987.654.321
Buyer Street NameConditionalBuyer street name. Required for B2B.Rue de la Loi
Buyer Building NumberNoBuyer building number. Optional.16
Buyer CityConditionalBuyer city. Required for B2B.Bruxelles
Buyer Postal CodeConditionalBuyer postal code. Format: 4 digits.1000
Buyer CountryConditionalBuyer country. Required for B2B.BE
Buyer PhoneNoBuyer contact phone. Optional.+32287654321
Buyer EmailNoBuyer contact email. Optional.info@abccorp.be

Line Items Fields

ParameterRequiredWhat It MeansExample
Line IDYesUnique identifier for each line item.LINE-001
Item NameYesShort item name. Required.Service conseil
Item DescriptionNoDetailed description. Optional.Professional consulting services
Item PriceYesUnit price. Required.100.00
Invoiced QuantityYesQuantity invoiced. Required.10.00
Unit CodeYesUnit of measurement. UN/ECE format.HUR
Line Taxable AmountYesLine taxable amount excluding VAT. Required.950.00
VAT CategoryYesVAT category. Required.S
VAT RateYesVAT rate percentage. Must match Belgian rates.21.0
Line Tax AmountYesVAT amount for line. Required.21.00
Line TotalYesLine total including VAT. Required.121.00

Totals and Amounts Fields

ParameterRequiredWhat It MeansExample
Total Line Taxable AmountYesSum of all line taxable amounts.1900.00
Total Amount Excluding TaxYesTotal excluding VAT.1850.00
Total Tax AmountYesTotal VAT amount.388.50
Total Amount Including TaxYesTotal including VAT.2238.50
Amount DueYesFinal amount due.1738.50

Payment Information Fields

ParameterRequiredWhat It MeansExample
Payment Means CodeNoPayment means code. UN/ECE 4461 format.30
Payee IBANConditionalPayee IBAN. Required for credit transfer.BE6853900754703
Payee Account NameNoPayee account holder name. Optional.Tech Solutions SPRL
BIC CodeConditionalBank BIC/SWIFT code. Required for credit transfer.KREDBEBB
Payment TermsYesPayment terms description. Required for B2B.Net 30 days

Germany (DE)

Document Header Fields

ParameterRequiredWhat It MeansExample
Document TypeYesDocument Type for XRechnung.380
Invoice NumberYesInvoice number. Required.RG2024-001
Issue DateYesInvoice issue date. Required.2024-01-15
Currency CodeYesCurrency code. Defaults to EUR.EUR
Payment Due DateNoPayment due date. Optional.2024-02-15

Seller Information Fields

ParameterRequiredWhat It MeansExample
Seller NameYesSeller name. Required.Tech Solutions GmbH
Tax ID TypeYesTax ID scheme.VAT
Tax ID ValueYesTax ID number. Must be valid.DE123456789
Legal Registration IDYesBusiness registration ID.HRB123456
Address Line 1YesStreet address.Hauptstrasse 123
Seller CityYesCity name.Berlin
Seller Postal CodeYesPostal code.10115
Seller Country CodeYesCountry code.DE

Line Items Fields

ParameterRequiredWhat It MeansExample
Item NameYesItem name. Required.Beratungsleistungen
Item PriceYesUnit price. Required.100.00
Invoiced QuantityYesQuantity. Required.10
Line Taxable AmountYesLine taxable amount. Required.1000.00
VAT CategoryYesVAT category. Required.S
VAT RateYesVAT rate percentage. Required.19.0
Line Tax AmountYesVAT amount. Required.190.00
Line TotalYesLine total with VAT. Required.1190.00

Totals and Amounts Fields

ParameterRequiredWhat It MeansExample
Total Line Taxable AmountYesSum of line taxable amounts.1900.00
Total Amount Excluding TaxYesTotal excluding VAT.1900.00
Total Tax AmountYesTotal VAT amount.361.00
Total Amount Including TaxYesTotal including VAT.2261.00
Amount DueYesAmount due for payment.2261.00

United Arab Emirates (AE)

Document Header Fields

ParameterRequiredWhat It MeansExample
Invoice type codeYesDocument type (invoice, credit_note, debit_note).invoice
Invoice numberYesUnique invoice number. Required.INV-AE-2024-001
Invoice issue dateYesInvoice issue date. Required.2024-01-15
Invoice issue timeYesInvoice issue time. Required.14:30:00
Invoice currency codeYesCurrency code. Defaults to AED.AED
Payment due dateNoPayment due date. Optional.2024-02-15

Seller Information Fields

ParameterRequiredWhat It MeansExample
Seller nameYesLegal registered name. Required.Tech Solutions LLC
Seller VAT identifierYesVAT number for UAE. Required.123456789012345
Seller legal registration identifierYesBusiness registration number. Required.REG-123456
Seller address line 1YesStreet address. Required.Sheikh Zayed Road
Seller cityYesCity name. Required.Dubai
Seller post codeYesPostal code. Required.00000
Seller country codeYesCountry code. Required.AE
Seller contact telephone numberNoContact phone. Optional.+971234567890
Seller contact email addressNoContact email. Optional.info@techsolutions.ae

Buyer Information Fields (B2B)

ParameterRequiredWhat It MeansExample
Buyer nameConditionalBuyer name.ABC Corporation
Buyer VAT identifierConditionalBuyer VAT number.123456789012346
Buyer legal registration identifierConditionalBusiness registration number.REG-654321
Buyer address line 1ConditionalStreet address.Al Khaleej Road
Buyer cityConditionalCity name.Abu Dhabi
Buyer post codeConditionalPostal code.00000
Buyer countryConditionalCountry code.AE

Line Items Fields

ParameterRequiredWhat It MeansExample
Line Item IDYesUnique line identifier. Required.LINE-001
Item NameYesItem name. Required.Consulting Services
Unit PriceYesUnit price. Required.1000.00
Invoiced QuantityYesQuantity. Required.5
Line Taxable AmountYesTaxable amount. Required.5000.00
Line TotalYesTotal with VAT. Required.5250.00

Totals and Amounts Fields

ParameterRequiredWhat It MeansExample
Total Line Taxable AmountYesSum of line taxable amounts.5000.00
Total Amount Excluding TaxYesTotal excluding VAT.5000.00
Total Amount Including TaxYesTotal including VAT.5250.00
Amount DueYesAmount due for payment.5250.00

Data Formatting Guidelines

  • Dates: All dates must be in YYYY-MM-DD format (e.g., 2024-01-15)
  • Times: All times must be in HH:MM:SS or HH:MM:SSZ format (e.g., 14:30:00)
  • Decimal Amounts: Use . as decimal separator (e.g., 1000.00)
  • Currency Codes: Follow ISO 4217 standard (e.g., SAR, MYR, EUR, AED)
  • Country Codes: Follow ISO 3166-1 alpha-2 standard (e.g., SA, MY, BE, DE, AE)
  • Phone Numbers: Include country code (e.g., +966501234567)
  • Amounts: Always include two decimal places (e.g., 1234.56)

See Also