Field reference

Every field on every E-invoicing form: label in English and Arabic, type, whether it is required, its limits, a valid example and what the system refuses.

On this page (19)

Settings

FieldArabic labelTypeRequiredRules and limitsDefaultExampleRefused when
E-invoicing is onالفوترة الإلكترونية مفعلةSwitchNoOff: posting never creates a submission, the scheduler skips the company, POS returns 'E-invoicing is switched off.'. The sandbox start switches it onOffOn
Submit automatically when an invoice postsالإرسال تلقائيًا عند ترحيل الفاتورةSwitchNoOn: a clean submission is queued inside the posting. Off: it waits as Pending until an operator presses SubmitOnOff
Refuse to reverse an invoice that was sentمنع عكس فاتورة مرسلةSwitchNoOn: Accounting refuses reverse/cancel of an invoice with a sent submission (attempts > 0)OnOnReverse a sent invoice -> '<invoice no> was sent for e-invoicing as <EIN-no>; it cannot be reversed. Issue a credit note to correct it.'
Warn before a credential expires (days)التنبيه قبل انتهاء بيانات الاعتماد (أيام)Whole numberNo1 to 180; empty or 0 falls back to 3030450 is replaced by 30; 181 -> 'Warn between 1 and 180 days before a credential expires.'
Product for unmatched received linesمنتج البنود المستلمة غير المطابقةSelect (purchasable products of this company)NoUsed by 'Draft the bill' when a received line matches no productEmptyA purchasable service productA product of another company by API -> 'Choose a product.'
Commercial registration (KSA CRN)السجل التجاريText (max 80)ConditionalKSA profiles need exactly 10 digits. Empty falls back to the company's trade licence number. A company field rule can make it Required or Hidden1010000001KSA submission with 'AB123' -> 'Seller CRN 'AB123' is not a 10-digit commercial registration number.'
Building numberرقم المبنىText (max 80)ConditionalKSA: 4 digits; goes into the seller address of ZATCA invoices1234KSA with '12' -> 'Seller building number '12' is not a 4-digit building number.'
DistrictالحيText (max 80)ConditionalKSA: required on the seller addressAl OlayaKSA with it empty -> 'Seller district is required by KSA ZATCA standard tax invoice (clearance).'
Postal codeالرمز البريديText (max 80)ConditionalKSA: 5 digits; empty falls back to the company PO box12211KSA with '1221' -> 'Seller postal code '1221' is not a 5-digit postal code.'
Additional numberالرقم الإضافيText (max 80)ConditionalSaudi national address additional number (4 digits in practice); company field rule 'einvoicing.seller.additional_number' can require or hide it5678Rule set to Required and field empty -> save refused (field rule message)
Our endpoint schemeمخطط عنوانناText (max 80)NoUAE: 0235 (UAE TIN). Empty falls back to 0235 for UAE companies0235
Our endpoint identifierمعرّف عنوانناText (max 80)ConditionalUAE PINT AE needs a seller endpoint; empty falls back to the company VAT/TRN100000000000003UAE with company TRN empty and this empty -> 'Seller electronic address (endpoint) is required by UAE PINT AE - business.'

Onboarding > dialog

FieldArabic labelTypeRequiredRules and limitsDefaultExampleRefused when
ProviderالموفرSelect (providers not archived)YesFixes the environment unless one is typedSANDBOXProvider of another company by API -> 'Choose the provider.'
EnvironmentالبيئةSelect (Test / Production)NoMust equal the provider's environmentProvider'stestProduction on a test provider -> 'The onboarding's environment is the provider's.'
Only for profile (blank: every profile)لملف محدد (فارغ: كل الملفات)Select (profiles)NoMust be a profile of this company in the same environmentBlankSA-ZATCA-STD v1Production profile on a test onboarding -> 'Choose a profile in the same environment.'
Tax registration numberالرقم الضريبيText (max 40)NoZATCA CSID request needs exactly 15 digits (from here, else the company VAT number)300000000000003CSID request with '12345' -> 'The VAT number must be the 15 digits ZATCA registered.'
Provider accountحساب الموفرText (max 120)ConditionalThe account the provider gave the company. Company field rule can make it Required or Hiddensandbox-DXB01
Endpoint schemeمخطط العنوانText (max 10)NoPeppol scheme such as 02350235
Endpoint identifierمعرّف العنوانText (max 80)NoThe company's own participant identifier100000000000003
Solution unit serial (ZATCA EGS)الرقم التسلسلي لوحدة الحلText (max 120)ConditionalFormat 1-a2nsoft|2-erp|3-<unit>. Empty: the system makes one when the compliance CSID is requested. Field rule can require or hide it1-a2nsoft|2-erp|3-DXB01
Onboarding evidenceدليل الاعتمادLong text (max 4000)NoFree text; compliance CSID requests append a line 'Compliance CSID <id> issued <time> UTC.'Provider welcome e-mail dated 1 Oct 2026
Production acceptance evidenceدليل القبول للإنتاجLong text (max 4000)ConditionalProduction activation needs at least 10 characters (trimmed)FTA / provider acceptance letter ref A-2026-0042Approve a production onboarding with 'ok' -> 'Blocked pending the authority's or provider's acceptance evidence.'
Reason (Suspend prompt)سبب الإيقافText (max 300)NoAsked in a browser prompt; empty becomes 'Suspended.'Suspended.Provider portal maintenance

Onboarding > Bind a credential

FieldArabic labelTypeRequiredRules and limitsDefaultExampleRefused when
PurposeالغرضSelect (Authentication / Signing key / Callback secret)YesServer default 'auth'AuthenticationSigning keyOther value by API -> 'Choose what the credential is for.'
Generate it hereإنشاؤه هناSwitchNoSigning: makes an ECDSA secp256k1 key (self-signed certificate only in test). Callback: makes a random 32-byte secret. Authentication: ignoredOffOnProduction signing with Generate and no certificate: key is generated but the production gate needs the authority's certificate
Token or secretالرمز أو السرPassword (never shown again)ConditionalAuthentication and callback (unless generated); stored sealed in the vaulttest-token-0001Empty -> 'Enter the secret.'
Private key (PEM)المفتاح الخاصLong textConditionalSigning key without Generate; up to 20,000 characters-----BEGIN PRIVATE KEY----- (test key)Empty and Generate off -> 'Generate a key, or paste the private key and its certificate.'
Certificate (PEM)الشهادةLong textConditionalMust belong to the key; production needs the authority's (not self-signed)Matching test certificateAnother key's certificate -> 'The certificate is not the key's.'; garbage -> 'The certificate or key could not be read.'; self-signed on production -> 'A production key needs the authority's certificate.'
Valid toصالح حتىDate-time (ISO)NoAuthentication and callback credentials only; signing takes it from the certificate2027-03-31'31/12/2026' -> 'Use a date and time in ISO format.'
Environment (sent, not shown)البيئةHidden (defaults to the onboarding's)NoMust equal the onboarding's environmentOnboarding'stest'test' on a production onboarding -> 'A test credential cannot be bound to a production onboarding.'

Onboarding > Request compliance CSID (API)

FieldArabic labelTypeRequiredRules and limitsDefaultExampleRefused when
One-time password (OTP)كلمة المرور لمرة واحدةText 4-12 digitsYesFrom the Fatoora portal. NO field for it exists on screen today123456'abc' -> 'Enter the one-time password from the Fatoora portal.'

Providers > New / Edit

FieldArabic labelTypeRequiredRules and limitsDefaultExampleRefused when
CodeالرمزTextYesUpper-cased; unique per company; column limit 30FATOORADuplicate -> 'Another provider has this code.'; empty -> 'Enter the code.'
NameالاسمTextYesMax 120ZATCA Fatoora (test portal)Empty -> 'Enter the name.'
KindالنوعSelect (Sandbox / ZATCA Fatoora / UAE accredited service provider)YesSandbox = simulator; only the first two exist as real adapters beside the generic REST ASPZATCA FatooraEmpty or unknown value -> 'Choose a kind.'
EnvironmentالبيئةSelect (Test / Production)YesSandbox must be Test; a provider is never bothTestTestSandbox + Production -> 'The sandbox provider is only ever a test environment.'
Base URLالعنوانText (max 300)ConditionalRequired unless Sandbox. HTTPS only, host on the allowlist, standard port 443, public address, no user:passwordhttps://gw-fatoora.zatca.gov.sa/e-invoicing/developer-portalEmpty -> 'Enter the provider's HTTPS address.'; http:// -> 'A provider address must use HTTPS.'; host not listed -> 'The provider's address must be on its reviewed allowlist.'; https://localhost/x or 10.0.0.5 -> 'That address points at this machine or an internal network.'; :8443 -> 'Providers are reached on the standard HTTPS port.'; https://user:pw@host -> 'Credentials do not belong in the address; add them as a credential.'
Allowed hostsالمضيفات المسموحةTags (comma separated)ConditionalHost names only, or *.domain; no scheme, slash or port; no internal names (.local, .internal, localhost) and no private IPsgw-fatoora.zatca.gov.sa'localhost' -> 'localhost cannot be a provider host.'; 'https://x.com' -> 'https://x.com cannot be a provider host.'; '192.168.1.5' -> '192.168.1.5 is not a public address.'
AuthenticationالمصادقةSelect (None / Bearer token / Basic / ZATCA CSID)YesNot 'None' means the worker needs an active, unexpired auth credentialNoneZATCA CSID
Capability versionإصدار القدراتText (max 300)NoFree note, shown in the dialogzatca-v2
Answers status queriesيجيب على استعلامات الحالةSwitchNoOn: after a timeout the provider is asked first. ZATCA itself publishes no status query (the adapter says so and the identical bytes are resent)On (new provider)On
Sends callbacksيرسل استدعاءاتSwitchNoOn: the public callback URL accepts signed acknowledgements; otherwise a submitted item is polled by queryOff (sandbox: On)On
Timeout (seconds)المهلة (ثوان)Whole numberNo1 to 120; a send is recorded as 'timeout' after this long20300 -> 20 is used; 121 -> 'A timeout between 1 and 120 seconds.'; 'abc' -> 'Enter a whole number.'
Sandbox behaviourسلوك بيئة الاختبارSelect (Accept / Reject / Accept, then time out / Unavailable / Asynchronous)NoSandbox only; also changed live by the 'Sandbox behaviour' action; default acceptAcceptRejectAction with 'foo' -> 'Choose one of: accept, reject, timeout_after_accept, unavailable, async.'
Sandbox reports buyer deliveryتُبلغ بيئة الاختبار بتسليم المشتريSwitchNoAccepted documents also record a delivery receipt 'DLV-...'On (sandbox)On

Country profiles > New / Edit

FieldArabic labelTypeRequiredRules and limitsDefaultExampleRefused when
CodeالرمزTextYesUpper-cased; code + version unique; column limit 30AE-PINT-B2BEmpty -> 'Enter the code.'
NameالاسمTextYesMax 160; appears in validation messagesUAE PINT AE - business
CountryالدولةSelect (AE, SA, BH, OM, QA, KW)YesOnly AE (PINT AE) and SA (ZATCA) have formats todayAE
Customer typeنوع العميلSelect (Business / Consumer / Government)YesBusiness customers are partners with market 'business'; everything else is consumerBusiness
DocumentsالمستنداتMulti-select (Invoice, Credit note)YesAt least oneInvoice, Credit noteInvoiceNone -> 'Choose at least one document.'
FormatالصيغةSelect (PINT AE / ZATCA UBL 2.1)YesMust match the countryPINT AEZATCA with country AE -> 'ZATCA documents are for Saudi companies.'; PINT AE with SA -> 'PINT AE documents are for UAE companies.'
FlowالمسارSelect (Exchange and report (UAE) / Clearance before issue (KSA standard) / Reporting after issue (KSA simplified))YesDecides the legal state: clearance = Pending clearance until accepted; reporting and post-audit = Issued at onceExchange and report (UAE)
Issue orderترتيب الإصدارSelect (Issue, then submit / Clear before issue)YesClearance flow must use Clear before issueIssue, then submitClear before issueClearance + Issue then submit -> 'A clearance profile clears before it issues.'
SignedموقعةSwitchNoOn: needs an active signing key on the onboarding before anything is sentOffOn (KSA)
ProviderالموفرSelect (providers)YesSame company, same environment as the profile, and active at activationSANDBOXArchived/other company -> 'Choose a provider.'; inactive at activation -> 'Its provider is not active.'; different environment -> 'The profile and its provider are in different environments.'
EnvironmentالبيئةSelect (Test / Production)YesProduction activation needs certification evidence and a passed conformance runTestTest
Customisation IDمعرّف التخصيصText (max 120)NoPINT AE: urn:peppol:pint:billing-1@ae-1 is used when blankurn:peppol:pint:billing-1@ae-1
Effective from / Effective toساري من / ساري حتىDatesNoTo may not be before From; a submission uses the profile whose dates cover the invoice dateBlank2026-01-01To before From -> 'The profile ends before it starts.'; 'x' -> 'Use a date as YYYY-MM-DD.'
PriorityالأولويةWhole numberNoLower number wins; two active profiles may not cover the same country, customer type, document and dates at the same priority1010Second active profile -> '<code> v<n> already covers these documents and dates at the same priority.'
Extra required fieldsحقول إضافية إلزاميةTags (canonical paths)NoEach path must be non-empty on the canonical invoice or the submission is blockedbuyer.address.postalPath empty on invoice -> 'Postal is required by <profile name>.' (blocked)
Transaction type flags (UAE)أعلام نوع المعاملةText (max 8)No8 flag characters written to ProfileExecutionID; '00000000' when empty00000000
Certified / Certification evidenceمعتمد / دليل الاعتمادSwitch + Long textConditionalProduction activation: Certified ticked and evidence of at least 10 charactersOffCertified, evidence 'FTA letter 2026/114'Activate a production profile without it -> 'A production profile needs the authority's or provider's acceptance evidence.'

Retry and outage policies > New / Edit

FieldArabic labelTypeRequiredRules and limitsDefaultExampleRefused when
NameالاسمText (max 120)YesKSA simplified - 24h
ProfileالملفSelect (profiles)NoBlank = applies to every profile; a profile-specific policy winsBlankSA-ZATCA-SIMP v1
Retryable codesالرموز القابلة لإعادة المحاولةTagsNoSeeded: 503, 429, timeout503, 429, timeout
Maximum attemptsالحد الأقصى للمحاولاتWhole numberNo1 to 20660 or 21 -> 'Between 1 and 20 attempts.'
First retry after (seconds)أول إعادة بعد (ثوان)Whole numberNoBack-off base: waits 60 x 2^(attempt-1), up to the longest wait6060
Longest wait (seconds)أطول انتظار (ثوان)Whole numberNoNot shorter than the first retry36003600Less than first -> 'The longest wait is shorter than the first.'
Jitter %نسبة التذبذبWhole numberNo0 to 50; each wait varies by up to this percent either way202051 -> 'Jitter between 0 and 50%.'
Ask before resendingالاستعلام قبل إعادة الإرسالSwitchNoOn: a status_unknown submission is asked about before a resendOnOn
Deadline (hours from issue)المهلة (ساعات من الإصدار)Whole numberNoEmpty = no deadline. KSA simplified seeded at 24Empty24'abc' -> 'Enter a whole number.'
Escalate after (hours)التصعيد بعد (ساعات)Whole numberNoAlert raised once when the deadline is within this many hours, a status has been unknown this long, or clearance has waited this long46
May issue while the provider is downيمكن الإصدار أثناء توقف الموفرSwitchNoNeeds a named official rule; NOTE the flag is stored onlyOffOn with a contingencyOn with empty text -> 'Name the official rule that allows issuing while the provider is down.'
Contingency and its official sourceخطة الطوارئ ومصدرها الرسميLong text (max 4000)ConditionalAt least 10 characters when offline is allowedZATCA simplified invoice contingency guideline 2025, section 4

Code mappings > New / Edit

FieldArabic labelTypeRequiredRules and limitsDefaultExampleRefused when
ListالقائمةSelect (Unit of measure / Tax category / Payment means / Document type / Exemption reason code)YesSeeded: uom, tax_category, payment_meansUnit of measure
Our codeرمزناText (max 60)YesUnit and exemption keys are matched in lower casecartonEmpty -> 'Enter the our code.'
Their codeرمزهمText (max 60)YesWritten into the XML (unitCode, tax category, payment means, type code)CTEmpty -> 'Enter the their code.'
Profile (blank: every profile)الملف (فارغ: كل الملفات)Select (profiles)NoA profile's own row beats the generic rowBlankAE-PINT-B2B v1
Code list version / Effective from / toإصدار القائمة / ساري من / إلىText, datesNoInformational; effective dates are stored but the map lookup uses status Active onlyUNECE Rec 20

Rejection codes > New / Edit

FieldArabic labelTypeRequiredRules and limitsDefaultExampleRefused when
Provider codeرمز الموفرText (max 60)YesUnique per profile (or company-wide with blank profile)SIM-ADDR-001Duplicate -> 'This code is already in the catalogue for that profile.'
ProfileالملفSelectNoBlank = every profileBlank
SeverityالخطورةSelect (Error / Warning)YesError blocks a validation; warning does notErrorWarning
FieldالحقلText (max 300)NoCanonical path, e.g. buyer.address.building_numberbuyer.address.building_number
MeaningالمعنىLong text (max 400 stored)NoShown on the submission's Issues tab when the provider returns this code without textThe buyer's building number is missing or not four digits.
How to repairطريقة الإصلاحLong text (max 400 stored)NoEnter the building number on the partner endpoint.
Repaired byالمسؤولSelect (Billing / Tax / Master data / Integration)YesDefault billingBillingMaster data
Terminal (no resubmission)نهائي (لا إعادة إرسال)SwitchNoInformational flag in the catalogue (SIM-DUP is seeded terminal)OffOn

Partner endpoints > New / Edit

FieldArabic labelTypeRequiredRules and limitsDefaultExampleRefused when
PartnerالشريكSelect (active partners)YesOf this companyA business customerEmpty -> 'Choose a partner.'
Endpoint schemeمخطط العنوانSelect (None / 0235 UAE TIN / 0088 GLN / 9957 Peppol participant)NoNone = authority-only partyNone0235
Endpoint identifierمعرّف العنوانText (max 80)Conditional0235: 15 digits starting with 1. 0088: 13-digit GLN with valid check digit. Any scheme: required100000000000011Scheme 0235 and empty -> 'Enter the endpoint identifier.'; '12345' -> 'A 0235 endpoint is the 15-digit UAE TIN/TRN.'; '1234567890123' -> 'A 0088 endpoint is a 13-digit GLN with a valid check digit.'
Registration (scheme) / Registration numberالتسجيل / رقم التسجيلSelect (From the partner / UAE TRN / KSA VAT / Commercial registration / National ID) + textNoTRN: 15 digits starting with 1. VAT: 15 digits starting and ending with 3. Overrides the partner's tax id on e-invoicesFrom the partnerVAT 310000000000003TRN '200000000000003' -> 'A UAE TRN is 15 digits starting with 1.'; VAT '300000000000001' -> 'A KSA VAT number is 15 digits that start and end with 3.'
Building numberرقم المبنىText (max 80)Conditional4 digits when given. KSA standard invoices need the buyer's building number, street, district, postal, city4321'12' -> 'A building number is 4 digits.'
Street / District / City / Postal code / Additional number / Country (ISO)الشارع / الحي / المدينة / الرمز البريدي / الرقم الإضافي / الدولةText (max 80 each)ConditionalOverride the partner's invoice address on the canonical invoice; blank keeps the partner'sPrince Sultan Street / Al Rawdah / Jeddah / 23434 / 1111 / SA
Formats acceptedالصيغ المقبولةMulti-select (PINT AE, ZATCA)NoInformationalPINT AE
Active from / Active toنشط من / إلىDatesNoThe endpoint is used only on days inside the window (company local day)Blank2026-10-01

Retention policies > New / Edit

FieldArabic labelTypeRequiredRules and limitsDefaultExampleRefused when
CountryالدولةSelect (GCC)YesSeeded drafts: AE 5 years, SA 6 yearsAE
Record classفئة السجلاتText (max 300)Noeinvoiceeinvoice
Years keptعدد السنواتWhole numberNo1 to 30650 or 31 -> 'Between 1 and 30 years.'
Legal holdحجز قانونيSwitchNoShown in Archive integrity; no deletion job exists yetOffOff
Encryption / Archive locationالتشفير / موقع الأرشيفText (max 300)NoInformationalapplication key / databaseapplication key / database

Outages > Report an outage

FieldArabic labelTypeRequiredRules and limitsDefaultExampleRefused when
ProviderالموفرSelectYesOne open outage per providerSANDBOXNo provider -> 'Choose the provider.'; second open case -> 'An outage is already open for this provider.'
What is happeningما الذي يحدثLong text (max 300)NoEmpty becomes 'Reported by an operator.'Reported by an operator.Provider portal returning 503

Outages > Approve contingency (prompt)

FieldArabic labelTypeRequiredRules and limitsDefaultExampleRefused when
Contingency and the official ruleخطة الطوارئ والقاعدة الرسميةText (max 4000)YesAt least 10 characters; a different person from whoever opened the caseHold clearance invoices pending; report within 24h per guideline'ok' -> 'Describe the contingency and the rule that allows it.'; same person -> 'Somebody other than the person who prepared this outage's contingency must approve it.'

Received e-invoices > Upload

FieldArabic labelTypeRequiredRules and limitsDefaultExampleRefused when
File (.xml)الملفFile (UBL Invoice or CreditNote XML)YesMax 5 MB; no DOCTYPE or ENTITY at all; depth max 40; elements max 20,000supplier-invoice.xmlOver 5 MB -> 'The document is larger than 5 MB.'; with DOCTYPE -> 'The document declares a DOCTYPE or entities, which is never accepted.'; broken XML -> 'The document is not well-formed XML: ...'

Received e-invoices > Upload (API)

FieldArabic labelTypeRequiredRules and limitsDefaultExampleRefused when
Sender scheme / Sender idمخطط المرسل / معرف المرسلText (max 10 / max 80)NoUsed to find the supplier through a partner endpoint when the tax number matches nobodyFrom the file0235 / 100000000000044

Received e-invoices > Reject (prompt)

FieldArabic labelTypeRequiredRules and limitsDefaultExampleRefused when
ReasonالسببTextNoEmpty becomes 'no reason given'; appended to the errors as 'Rejected: <reason>'Not our order

Received e-invoices > Draft the bill

FieldArabic labelTypeRequiredRules and limitsDefaultExampleRefused when
SupplierالموردSelect (suppliers)ConditionalOffered when the document matched no supplier; must be a supplier or bothA supplier partnerNo supplier -> 'Choose the supplier this document is from.'; a customer by API -> 'Choose a supplier.'

Submission record > Rebuild / Correct (prompt)

FieldArabic labelTypeRequiredRules and limitsDefaultExampleRefused when
ReasonالسببText (max 500 on the note)NoRebuild: audit text (default 'repair'). Correct: the credit note's note (default 'Correction of <invoice> after e-invoice <EIN-no>')Buyer building number fixed

Submissions API > hand over (no screen)

FieldArabic labelTypeRequiredRules and limitsDefaultExampleRefused when
Invoice (document_id) and Idempotency-Keyالفاتورة ومفتاح عدم التكرارId + header (4-80 chars)YesA posted invoice of this company posted before e-invoicing was onA posted invoice idEmpty -> 'Choose a posted invoice.'; missing key -> 'Send an idempotency key with the command.'; draft invoice -> 'An invoice is e-invoiced once it is posted.'