مواد پر جائیں

پلیٹ فارم کے API اور ماحول

اینڈ پوائنٹس

نامطریقہدستاویز میں راستہمقصدجوداکس استعمال کرتا ہے
Compliance CSIDPOST/complianceفاتورہ (FATOORA) پورٹل سے لیے گئے OTP کے ساتھ CSR بھیجتا ہے اور کمپلائنس سرٹیفکیٹ (binarySecurityToken)، اس کا secret اور درخواست کی ID واپس کرتا ہے۔ہاں
Compliance invoice checkPOST/compliance/invoicesپروڈکشن سرٹیفکیٹ جاری ہونے سے پہلے کمپلائنس سرٹیفکیٹ سے دستخط شدہ نمونہ دستاویزات کی جانچ کرتا ہے۔ تکنیکی رہنما اصول ہر قسم کی تین دستاویزات بتاتے ہیں: انوائس، ڈیبٹ نوٹ، کریڈٹ نوٹ۔ہاں
Production CSID (onboarding)POST/production/csidsکمپلائنس درخواست کی ID کے بدلے پروڈکشن سرٹیفکیٹ (PCSID) دیتا ہے، جو اس کے بعد مہر اور رپورٹنگ کے لیے استعمال ہوتا ہے۔ہاں
Production CSID (renewal)PATCH/production/csidsنئے CSR اور نئے OTP کے ساتھ پروڈکشن سرٹیفکیٹ کی تجدید کرتا ہے؛ پرانا سرٹیفکیٹ منسوخ ہو جاتا ہے۔نہیں
Reporting (single)POST/invoices/reporting/singleدستخط شدہ سادہ دستاویز (انوائس یا نوٹ) رپورٹ کرتا ہے: 200 قبول، 202 وارننگز کے ساتھ قبول، 400 مسترد، 409 پہلے ہی رپورٹ ہو چکی۔ہاں
Clearance (single)POST/invoices/clearance/singleمعیاری دستاویز کو کلیئر کرتا ہے؛ پلیٹ فارم اسے QR کوڈ کے ساتھ مہر لگا کر واپس کرتا ہے (clearedInvoice)۔ جب ZATCA نے کلیئرنس بند کی ہو تو 303 واپس کرتا ہے، اور اس صورت میں دستاویز رپورٹنگ کے ذریعے بھیجی جاتی ہے۔نہیں

ماحول

ماحولمقصد
Developer portal (Integration Sandbox)https://gw-fatoora.zatca.gov.sa/e-invoicing/developer-portalڈویلپرز کے لیے ٹیسٹ ماحول؛ وہاں بھیجی گئی کوئی چیز ZATCA کے ہاں شمار نہیں ہوتی اور اس کے سرٹیفکیٹ پروڈکشن میں کام نہیں کرتے۔ API کے صفحات نمونہ OTP دکھاتے ہیں (جیسے 123345) لیکن یہ نہیں کہتے کہ کوئی بھی OTP قبول ہو جاتا ہے۔
Simulationhttps://gw-fatoora.zatca.gov.sa/e-invoicing/simulationپروڈکشن سے پہلے پورے عمل کی جانچ کے لیے ایک اختیاری ماحول، جس میں ڈیوائسز پروڈکشن سے الگ آن بورڈ ہوتی ہیں اور فاتورہ (FATOORA) کے سمیولیشن پورٹل سے لیا گیا OTP ایک گھنٹے کے لیے کارآمد ہوتا ہے۔
Production (core)https://gw-fatoora.zatca.gov.sa/e-invoicing/coreرپورٹنگ اور کلیئرنس کا لائیو ماحول۔ OTP فاتورہ (FATOORA) پورٹل سے ملتے ہیں (ایک درخواست میں 100 تک، ہر ایک ایک گھنٹے کے لیے کارآمد)؛ ان کے لیے کوئی API نہیں۔

ماخذ

  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. جوداکس سے متعلق ہر بات پروگراموں کے اپنے کوڈ سے لی گئی ہے.