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)
SettingsOnboarding > dialogOnboarding > Bind a credentialOnboarding > Request compliance CSID (API)Providers > New / EditCountry profiles > New / EditRetry and outage policies > New / EditCode mappings > New / EditRejection codes > New / EditPartner endpoints > New / EditRetention policies > New / EditOutages > Report an outageOutages > Approve contingency (prompt)Received e-invoices > UploadReceived e-invoices > Upload (API)Received e-invoices > Reject (prompt)Received e-invoices > Draft the billSubmission record > Rebuild / Correct (prompt)Submissions API > hand over (no screen)
Settings
| Field | Arabic label | Type | Required | Rules and limits | Default | Example | Refused when |
|---|---|---|---|---|---|---|---|
| E-invoicing is on | الفوترة الإلكترونية مفعلة | Switch | No | Off: posting never creates a submission, the scheduler skips the company, POS returns 'E-invoicing is switched off.'. The sandbox start switches it on | Off | On | |
| Submit automatically when an invoice posts | الإرسال تلقائيًا عند ترحيل الفاتورة | Switch | No | On: a clean submission is queued inside the posting. Off: it waits as Pending until an operator presses Submit | On | Off | |
| Refuse to reverse an invoice that was sent | منع عكس فاتورة مرسلة | Switch | No | On: Accounting refuses reverse/cancel of an invoice with a sent submission (attempts > 0) | On | On | Reverse 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 number | No | 1 to 180; empty or 0 falls back to 30 | 30 | 45 | 0 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) | No | Used by 'Draft the bill' when a received line matches no product | Empty | A purchasable service product | A product of another company by API -> 'Choose a product.' |
| Commercial registration (KSA CRN) | السجل التجاري | Text (max 80) | Conditional | KSA profiles need exactly 10 digits. Empty falls back to the company's trade licence number. A company field rule can make it Required or Hidden | 1010000001 | KSA submission with 'AB123' -> 'Seller CRN 'AB123' is not a 10-digit commercial registration number.' | |
| Building number | رقم المبنى | Text (max 80) | Conditional | KSA: 4 digits; goes into the seller address of ZATCA invoices | 1234 | KSA with '12' -> 'Seller building number '12' is not a 4-digit building number.' | |
| District | الحي | Text (max 80) | Conditional | KSA: required on the seller address | Al Olaya | KSA with it empty -> 'Seller district is required by KSA ZATCA standard tax invoice (clearance).' | |
| Postal code | الرمز البريدي | Text (max 80) | Conditional | KSA: 5 digits; empty falls back to the company PO box | 12211 | KSA with '1221' -> 'Seller postal code '1221' is not a 5-digit postal code.' | |
| Additional number | الرقم الإضافي | Text (max 80) | Conditional | Saudi national address additional number (4 digits in practice); company field rule 'einvoicing.seller.additional_number' can require or hide it | 5678 | Rule set to Required and field empty -> save refused (field rule message) | |
| Our endpoint scheme | مخطط عنواننا | Text (max 80) | No | UAE: 0235 (UAE TIN). Empty falls back to 0235 for UAE companies | 0235 | ||
| Our endpoint identifier | معرّف عنواننا | Text (max 80) | Conditional | UAE PINT AE needs a seller endpoint; empty falls back to the company VAT/TRN | 100000000000003 | UAE with company TRN empty and this empty -> 'Seller electronic address (endpoint) is required by UAE PINT AE - business.' |
Onboarding > dialog
| Field | Arabic label | Type | Required | Rules and limits | Default | Example | Refused when |
|---|---|---|---|---|---|---|---|
| Provider | الموفر | Select (providers not archived) | Yes | Fixes the environment unless one is typed | SANDBOX | Provider of another company by API -> 'Choose the provider.' | |
| Environment | البيئة | Select (Test / Production) | No | Must equal the provider's environment | Provider's | test | Production on a test provider -> 'The onboarding's environment is the provider's.' |
| Only for profile (blank: every profile) | لملف محدد (فارغ: كل الملفات) | Select (profiles) | No | Must be a profile of this company in the same environment | Blank | SA-ZATCA-STD v1 | Production profile on a test onboarding -> 'Choose a profile in the same environment.' |
| Tax registration number | الرقم الضريبي | Text (max 40) | No | ZATCA CSID request needs exactly 15 digits (from here, else the company VAT number) | 300000000000003 | CSID request with '12345' -> 'The VAT number must be the 15 digits ZATCA registered.' | |
| Provider account | حساب الموفر | Text (max 120) | Conditional | The account the provider gave the company. Company field rule can make it Required or Hidden | sandbox-DXB01 | ||
| Endpoint scheme | مخطط العنوان | Text (max 10) | No | Peppol scheme such as 0235 | 0235 | ||
| Endpoint identifier | معرّف العنوان | Text (max 80) | No | The company's own participant identifier | 100000000000003 | ||
| Solution unit serial (ZATCA EGS) | الرقم التسلسلي لوحدة الحل | Text (max 120) | Conditional | Format 1-a2nsoft|2-erp|3-<unit>. Empty: the system makes one when the compliance CSID is requested. Field rule can require or hide it | 1-a2nsoft|2-erp|3-DXB01 | ||
| Onboarding evidence | دليل الاعتماد | Long text (max 4000) | No | Free 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) | Conditional | Production activation needs at least 10 characters (trimmed) | FTA / provider acceptance letter ref A-2026-0042 | Approve a production onboarding with 'ok' -> 'Blocked pending the authority's or provider's acceptance evidence.' | |
| Reason (Suspend prompt) | سبب الإيقاف | Text (max 300) | No | Asked in a browser prompt; empty becomes 'Suspended.' | Suspended. | Provider portal maintenance |
Onboarding > Bind a credential
| Field | Arabic label | Type | Required | Rules and limits | Default | Example | Refused when |
|---|---|---|---|---|---|---|---|
| Purpose | الغرض | Select (Authentication / Signing key / Callback secret) | Yes | Server default 'auth' | Authentication | Signing key | Other value by API -> 'Choose what the credential is for.' |
| Generate it here | إنشاؤه هنا | Switch | No | Signing: makes an ECDSA secp256k1 key (self-signed certificate only in test). Callback: makes a random 32-byte secret. Authentication: ignored | Off | On | Production 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) | Conditional | Authentication and callback (unless generated); stored sealed in the vault | test-token-0001 | Empty -> 'Enter the secret.' | |
| Private key (PEM) | المفتاح الخاص | Long text | Conditional | Signing 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 text | Conditional | Must belong to the key; production needs the authority's (not self-signed) | Matching test certificate | Another 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) | No | Authentication and callback credentials only; signing takes it from the certificate | 2027-03-31 | '31/12/2026' -> 'Use a date and time in ISO format.' | |
| Environment (sent, not shown) | البيئة | Hidden (defaults to the onboarding's) | No | Must equal the onboarding's environment | Onboarding's | test | 'test' on a production onboarding -> 'A test credential cannot be bound to a production onboarding.' |
Onboarding > Request compliance CSID (API)
| Field | Arabic label | Type | Required | Rules and limits | Default | Example | Refused when |
|---|---|---|---|---|---|---|---|
| One-time password (OTP) | كلمة المرور لمرة واحدة | Text 4-12 digits | Yes | From the Fatoora portal. NO field for it exists on screen today | 123456 | 'abc' -> 'Enter the one-time password from the Fatoora portal.' |
Providers > New / Edit
| Field | Arabic label | Type | Required | Rules and limits | Default | Example | Refused when |
|---|---|---|---|---|---|---|---|
| Code | الرمز | Text | Yes | Upper-cased; unique per company; column limit 30 | FATOORA | Duplicate -> 'Another provider has this code.'; empty -> 'Enter the code.' | |
| Name | الاسم | Text | Yes | Max 120 | ZATCA Fatoora (test portal) | Empty -> 'Enter the name.' | |
| Kind | النوع | Select (Sandbox / ZATCA Fatoora / UAE accredited service provider) | Yes | Sandbox = simulator; only the first two exist as real adapters beside the generic REST ASP | ZATCA Fatoora | Empty or unknown value -> 'Choose a kind.' | |
| Environment | البيئة | Select (Test / Production) | Yes | Sandbox must be Test; a provider is never both | Test | Test | Sandbox + Production -> 'The sandbox provider is only ever a test environment.' |
| Base URL | العنوان | Text (max 300) | Conditional | Required unless Sandbox. HTTPS only, host on the allowlist, standard port 443, public address, no user:password | https://gw-fatoora.zatca.gov.sa/e-invoicing/developer-portal | Empty -> '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) | Conditional | Host names only, or *.domain; no scheme, slash or port; no internal names (.local, .internal, localhost) and no private IPs | gw-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) | Yes | Not 'None' means the worker needs an active, unexpired auth credential | None | ZATCA CSID | |
| Capability version | إصدار القدرات | Text (max 300) | No | Free note, shown in the dialog | zatca-v2 | ||
| Answers status queries | يجيب على استعلامات الحالة | Switch | No | On: 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 | يرسل استدعاءات | Switch | No | On: the public callback URL accepts signed acknowledgements; otherwise a submitted item is polled by query | Off (sandbox: On) | On | |
| Timeout (seconds) | المهلة (ثوان) | Whole number | No | 1 to 120; a send is recorded as 'timeout' after this long | 20 | 30 | 0 -> 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) | No | Sandbox only; also changed live by the 'Sandbox behaviour' action; default accept | Accept | Reject | Action with 'foo' -> 'Choose one of: accept, reject, timeout_after_accept, unavailable, async.' |
| Sandbox reports buyer delivery | تُبلغ بيئة الاختبار بتسليم المشتري | Switch | No | Accepted documents also record a delivery receipt 'DLV-...' | On (sandbox) | On |
Country profiles > New / Edit
| Field | Arabic label | Type | Required | Rules and limits | Default | Example | Refused when |
|---|---|---|---|---|---|---|---|
| Code | الرمز | Text | Yes | Upper-cased; code + version unique; column limit 30 | AE-PINT-B2B | Empty -> 'Enter the code.' | |
| Name | الاسم | Text | Yes | Max 160; appears in validation messages | UAE PINT AE - business | ||
| Country | الدولة | Select (AE, SA, BH, OM, QA, KW) | Yes | Only AE (PINT AE) and SA (ZATCA) have formats today | AE | ||
| Customer type | نوع العميل | Select (Business / Consumer / Government) | Yes | Business customers are partners with market 'business'; everything else is consumer | Business | ||
| Documents | المستندات | Multi-select (Invoice, Credit note) | Yes | At least one | Invoice, Credit note | Invoice | None -> 'Choose at least one document.' |
| Format | الصيغة | Select (PINT AE / ZATCA UBL 2.1) | Yes | Must match the country | PINT AE | ZATCA 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)) | Yes | Decides the legal state: clearance = Pending clearance until accepted; reporting and post-audit = Issued at once | Exchange and report (UAE) | ||
| Issue order | ترتيب الإصدار | Select (Issue, then submit / Clear before issue) | Yes | Clearance flow must use Clear before issue | Issue, then submit | Clear before issue | Clearance + Issue then submit -> 'A clearance profile clears before it issues.' |
| Signed | موقعة | Switch | No | On: needs an active signing key on the onboarding before anything is sent | Off | On (KSA) | |
| Provider | الموفر | Select (providers) | Yes | Same company, same environment as the profile, and active at activation | SANDBOX | Archived/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) | Yes | Production activation needs certification evidence and a passed conformance run | Test | Test | |
| Customisation ID | معرّف التخصيص | Text (max 120) | No | PINT AE: urn:peppol:pint:billing-1@ae-1 is used when blank | urn:peppol:pint:billing-1@ae-1 | ||
| Effective from / Effective to | ساري من / ساري حتى | Dates | No | To may not be before From; a submission uses the profile whose dates cover the invoice date | Blank | 2026-01-01 | To before From -> 'The profile ends before it starts.'; 'x' -> 'Use a date as YYYY-MM-DD.' |
| Priority | الأولوية | Whole number | No | Lower number wins; two active profiles may not cover the same country, customer type, document and dates at the same priority | 10 | 10 | Second active profile -> '<code> v<n> already covers these documents and dates at the same priority.' |
| Extra required fields | حقول إضافية إلزامية | Tags (canonical paths) | No | Each path must be non-empty on the canonical invoice or the submission is blocked | buyer.address.postal | Path empty on invoice -> 'Postal is required by <profile name>.' (blocked) | |
| Transaction type flags (UAE) | أعلام نوع المعاملة | Text (max 8) | No | 8 flag characters written to ProfileExecutionID; '00000000' when empty | 00000000 | ||
| Certified / Certification evidence | معتمد / دليل الاعتماد | Switch + Long text | Conditional | Production activation: Certified ticked and evidence of at least 10 characters | Off | Certified, 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
| Field | Arabic label | Type | Required | Rules and limits | Default | Example | Refused when |
|---|---|---|---|---|---|---|---|
| Name | الاسم | Text (max 120) | Yes | KSA simplified - 24h | |||
| Profile | الملف | Select (profiles) | No | Blank = applies to every profile; a profile-specific policy wins | Blank | SA-ZATCA-SIMP v1 | |
| Retryable codes | الرموز القابلة لإعادة المحاولة | Tags | No | Seeded: 503, 429, timeout | 503, 429, timeout | ||
| Maximum attempts | الحد الأقصى للمحاولات | Whole number | No | 1 to 20 | 6 | 6 | 0 or 21 -> 'Between 1 and 20 attempts.' |
| First retry after (seconds) | أول إعادة بعد (ثوان) | Whole number | No | Back-off base: waits 60 x 2^(attempt-1), up to the longest wait | 60 | 60 | |
| Longest wait (seconds) | أطول انتظار (ثوان) | Whole number | No | Not shorter than the first retry | 3600 | 3600 | Less than first -> 'The longest wait is shorter than the first.' |
| Jitter % | نسبة التذبذب | Whole number | No | 0 to 50; each wait varies by up to this percent either way | 20 | 20 | 51 -> 'Jitter between 0 and 50%.' |
| Ask before resending | الاستعلام قبل إعادة الإرسال | Switch | No | On: a status_unknown submission is asked about before a resend | On | On | |
| Deadline (hours from issue) | المهلة (ساعات من الإصدار) | Whole number | No | Empty = no deadline. KSA simplified seeded at 24 | Empty | 24 | 'abc' -> 'Enter a whole number.' |
| Escalate after (hours) | التصعيد بعد (ساعات) | Whole number | No | Alert raised once when the deadline is within this many hours, a status has been unknown this long, or clearance has waited this long | 4 | 6 | |
| May issue while the provider is down | يمكن الإصدار أثناء توقف الموفر | Switch | No | Needs a named official rule; NOTE the flag is stored only | Off | On with a contingency | On with empty text -> 'Name the official rule that allows issuing while the provider is down.' |
| Contingency and its official source | خطة الطوارئ ومصدرها الرسمي | Long text (max 4000) | Conditional | At least 10 characters when offline is allowed | ZATCA simplified invoice contingency guideline 2025, section 4 |
Code mappings > New / Edit
| Field | Arabic label | Type | Required | Rules and limits | Default | Example | Refused when |
|---|---|---|---|---|---|---|---|
| List | القائمة | Select (Unit of measure / Tax category / Payment means / Document type / Exemption reason code) | Yes | Seeded: uom, tax_category, payment_means | Unit of measure | ||
| Our code | رمزنا | Text (max 60) | Yes | Unit and exemption keys are matched in lower case | carton | Empty -> 'Enter the our code.' | |
| Their code | رمزهم | Text (max 60) | Yes | Written into the XML (unitCode, tax category, payment means, type code) | CT | Empty -> 'Enter the their code.' | |
| Profile (blank: every profile) | الملف (فارغ: كل الملفات) | Select (profiles) | No | A profile's own row beats the generic row | Blank | AE-PINT-B2B v1 | |
| Code list version / Effective from / to | إصدار القائمة / ساري من / إلى | Text, dates | No | Informational; effective dates are stored but the map lookup uses status Active only | UNECE Rec 20 |
Rejection codes > New / Edit
| Field | Arabic label | Type | Required | Rules and limits | Default | Example | Refused when |
|---|---|---|---|---|---|---|---|
| Provider code | رمز الموفر | Text (max 60) | Yes | Unique per profile (or company-wide with blank profile) | SIM-ADDR-001 | Duplicate -> 'This code is already in the catalogue for that profile.' | |
| Profile | الملف | Select | No | Blank = every profile | Blank | ||
| Severity | الخطورة | Select (Error / Warning) | Yes | Error blocks a validation; warning does not | Error | Warning | |
| Field | الحقل | Text (max 300) | No | Canonical path, e.g. buyer.address.building_number | buyer.address.building_number | ||
| Meaning | المعنى | Long text (max 400 stored) | No | Shown on the submission's Issues tab when the provider returns this code without text | The buyer's building number is missing or not four digits. | ||
| How to repair | طريقة الإصلاح | Long text (max 400 stored) | No | Enter the building number on the partner endpoint. | |||
| Repaired by | المسؤول | Select (Billing / Tax / Master data / Integration) | Yes | Default billing | Billing | Master data | |
| Terminal (no resubmission) | نهائي (لا إعادة إرسال) | Switch | No | Informational flag in the catalogue (SIM-DUP is seeded terminal) | Off | On |
Partner endpoints > New / Edit
| Field | Arabic label | Type | Required | Rules and limits | Default | Example | Refused when |
|---|---|---|---|---|---|---|---|
| Partner | الشريك | Select (active partners) | Yes | Of this company | A business customer | Empty -> 'Choose a partner.' | |
| Endpoint scheme | مخطط العنوان | Select (None / 0235 UAE TIN / 0088 GLN / 9957 Peppol participant) | No | None = authority-only party | None | 0235 | |
| Endpoint identifier | معرّف العنوان | Text (max 80) | Conditional | 0235: 15 digits starting with 1. 0088: 13-digit GLN with valid check digit. Any scheme: required | 100000000000011 | Scheme 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) + text | No | TRN: 15 digits starting with 1. VAT: 15 digits starting and ending with 3. Overrides the partner's tax id on e-invoices | From the partner | VAT 310000000000003 | TRN '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) | Conditional | 4 digits when given. KSA standard invoices need the buyer's building number, street, district, postal, city | 4321 | '12' -> 'A building number is 4 digits.' | |
| Street / District / City / Postal code / Additional number / Country (ISO) | الشارع / الحي / المدينة / الرمز البريدي / الرقم الإضافي / الدولة | Text (max 80 each) | Conditional | Override the partner's invoice address on the canonical invoice; blank keeps the partner's | Prince Sultan Street / Al Rawdah / Jeddah / 23434 / 1111 / SA | ||
| Formats accepted | الصيغ المقبولة | Multi-select (PINT AE, ZATCA) | No | Informational | PINT AE | ||
| Active from / Active to | نشط من / إلى | Dates | No | The endpoint is used only on days inside the window (company local day) | Blank | 2026-10-01 |
Retention policies > New / Edit
| Field | Arabic label | Type | Required | Rules and limits | Default | Example | Refused when |
|---|---|---|---|---|---|---|---|
| Country | الدولة | Select (GCC) | Yes | Seeded drafts: AE 5 years, SA 6 years | AE | ||
| Record class | فئة السجلات | Text (max 300) | No | einvoice | einvoice | ||
| Years kept | عدد السنوات | Whole number | No | 1 to 30 | 6 | 5 | 0 or 31 -> 'Between 1 and 30 years.' |
| Legal hold | حجز قانوني | Switch | No | Shown in Archive integrity; no deletion job exists yet | Off | Off | |
| Encryption / Archive location | التشفير / موقع الأرشيف | Text (max 300) | No | Informational | application key / database | application key / database |
Outages > Report an outage
| Field | Arabic label | Type | Required | Rules and limits | Default | Example | Refused when |
|---|---|---|---|---|---|---|---|
| Provider | الموفر | Select | Yes | One open outage per provider | SANDBOX | No provider -> 'Choose the provider.'; second open case -> 'An outage is already open for this provider.' | |
| What is happening | ما الذي يحدث | Long text (max 300) | No | Empty becomes 'Reported by an operator.' | Reported by an operator. | Provider portal returning 503 |
Outages > Approve contingency (prompt)
| Field | Arabic label | Type | Required | Rules and limits | Default | Example | Refused when |
|---|---|---|---|---|---|---|---|
| Contingency and the official rule | خطة الطوارئ والقاعدة الرسمية | Text (max 4000) | Yes | At least 10 characters; a different person from whoever opened the case | Hold 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
| Field | Arabic label | Type | Required | Rules and limits | Default | Example | Refused when |
|---|---|---|---|---|---|---|---|
| File (.xml) | الملف | File (UBL Invoice or CreditNote XML) | Yes | Max 5 MB; no DOCTYPE or ENTITY at all; depth max 40; elements max 20,000 | supplier-invoice.xml | Over 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)
| Field | Arabic label | Type | Required | Rules and limits | Default | Example | Refused when |
|---|---|---|---|---|---|---|---|
| Sender scheme / Sender id | مخطط المرسل / معرف المرسل | Text (max 10 / max 80) | No | Used to find the supplier through a partner endpoint when the tax number matches nobody | From the file | 0235 / 100000000000044 |
Received e-invoices > Reject (prompt)
| Field | Arabic label | Type | Required | Rules and limits | Default | Example | Refused when |
|---|---|---|---|---|---|---|---|
| Reason | السبب | Text | No | Empty becomes 'no reason given'; appended to the errors as 'Rejected: <reason>' | Not our order |
Received e-invoices > Draft the bill
| Field | Arabic label | Type | Required | Rules and limits | Default | Example | Refused when |
|---|---|---|---|---|---|---|---|
| Supplier | المورد | Select (suppliers) | Conditional | Offered when the document matched no supplier; must be a supplier or both | A supplier partner | No supplier -> 'Choose the supplier this document is from.'; a customer by API -> 'Choose a supplier.' |
Submission record > Rebuild / Correct (prompt)
| Field | Arabic label | Type | Required | Rules and limits | Default | Example | Refused when |
|---|---|---|---|---|---|---|---|
| Reason | السبب | Text (max 500 on the note) | No | Rebuild: 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)
| Field | Arabic label | Type | Required | Rules and limits | Default | Example | Refused when |
|---|---|---|---|---|---|---|---|
| Invoice (document_id) and Idempotency-Key | الفاتورة ومفتاح عدم التكرار | Id + header (4-80 chars) | Yes | A posted invoice of this company posted before e-invoicing was on | A posted invoice id | Empty -> 'Choose a posted invoice.'; missing key -> 'Send an idempotency key with the command.'; draft invoice -> 'An invoice is e-invoiced once it is posted.' |