تخطَّ إلى المحتوى

الواجهات

الاسمالطريقةالمسار في المستندالغرضيستعمله جوداكس
Compliance CSIDPOST/complianceيرسل طلب الشهادة (CSR) مع رمز OTP من بوابة فاتورة، ويعيد شهادة الامتثال (binarySecurityToken) وسرّها ورقم الطلب.نعم
Compliance invoice checkPOST/compliance/invoicesيفحص مستندات نموذجية موقّعة بشهادة الامتثال قبل إصدار شهادة الإنتاج. الإرشادات الفنية تذكر ثلاثة مستندات لكل نوع: فاتورة وإشعار مدين وإشعار دائن.نعم
Production CSID (onboarding)POST/production/csidsيستبدل رقم طلب الامتثال بشهادة الإنتاج (PCSID) التي يُختم بها ويُبلَّغ بعد ذلك.نعم
Production CSID (renewal)PATCH/production/csidsيجدد شهادة الإنتاج بطلب شهادة جديد ورمز OTP جديد، فتُلغى الشهادة القديمة.لا
Reporting (single)POST/invoices/reporting/singleيبلّغ مستنداً مبسطاً موقّعاً (فاتورة أو إشعار): 200 مقبول، 202 مقبول مع تحذيرات، 400 مرفوض، 409 سبق إبلاغه.نعم
Clearance (single)POST/invoices/clearance/singleيعتمد مستنداً ضريبياً فتعيده المنصة مختوماً برمز استجابة سريعة (clearedInvoice). يعيد 303 إذا أوقفت الهيئة الاعتماد، فيُرسل المستند عبر الإبلاغ.لا

البيئات

البيئةالغرض
Developer portal (Integration Sandbox)https://gw-fatoora.zatca.gov.sa/e-invoicing/developer-portalبيئة تجريب للمطورين؛ لا تقبل الهيئة ما يُرسل إليها، وشهاداتها لا تعمل في الإنتاج. صفحات الواجهة تعرض رموز OTP نموذجية (مثل 123345)، ولا تذكر صراحة أن أي رمز يُقبل.
Simulationhttps://gw-fatoora.zatca.gov.sa/e-invoicing/simulationبيئة اختيارية لتجربة المسار كاملاً قبل الإنتاج، بأجهزة تُربط منفصلة عن الإنتاج، ورمز OTP من «بوابة فاتورة - المحاكاة» صالح ساعة.
Production (core)https://gw-fatoora.zatca.gov.sa/e-invoicing/coreالبيئة الفعلية للإبلاغ والاعتماد. رموز OTP من بوابة فاتورة (حتى 100 رمز في الطلب، كل رمز صالح ساعة)، ولا توجد واجهة برمجية لطلبها.

المصادر

  1. Integration Sandbox API pages (Swagger): reporting, clearance, compliance, production CSID, renewal (ve-Invoicing Sandbox Release 2.1.0 (page lists 2.1.1 as latest)) — ZATCA

تاريخ المراجعة: 4 نوفمبر 2026. ما يخص جوداكس مأخوذ من شيفرة البرامج نفسها.