Aller au contenu

API et environnements de la plateforme

Points d’accès

NomMéthodeChemin dans le documentObjetUtilisé par JooDax
Compliance CSIDPOST/complianceEnvoie la CSR avec un OTP obtenu sur le portail FATOORA et renvoie le certificat de conformité (binarySecurityToken), son secret et l'identifiant de la demande.Oui
Compliance invoice checkPOST/compliance/invoicesContrôle des documents d'exemple signés avec le certificat de conformité avant la délivrance du certificat de production. Les lignes directrices techniques prévoient trois documents par type : facture, note de débit, avoir.Oui
Production CSID (onboarding)POST/production/csidsÉchange l'identifiant de la demande de conformité contre le certificat de production (PCSID), utilisé dès lors pour le cachet et la déclaration.Oui
Production CSID (renewal)PATCH/production/csidsRenouvelle le certificat de production avec une nouvelle CSR et un nouvel OTP ; l'ancien certificat est révoqué.Non
Reporting (single)POST/invoices/reporting/singleDéclare un document simplifié signé (facture ou note) : 200 accepté, 202 accepté avec avertissements, 400 rejeté, 409 déjà déclaré.Oui
Clearance (single)POST/invoices/clearance/singleSoumet un document standard à validation préalable ; la plateforme le renvoie cacheté, avec un code QR (clearedInvoice). Renvoie 303 lorsque la ZATCA a désactivé la validation préalable ; le document est alors envoyé par la voie de la déclaration.Non

Environnements

EnvironnementObjet
Developer portal (Integration Sandbox)https://gw-fatoora.zatca.gov.sa/e-invoicing/developer-portalEnvironnement d'essai pour les développeurs ; rien de ce qui y est envoyé ne compte auprès de la ZATCA, et ses certificats ne fonctionnent pas en production. Les pages de l'API montrent des exemples d'OTP (comme 123345), mais n'indiquent pas que n'importe quel OTP est accepté.
Simulationhttps://gw-fatoora.zatca.gov.sa/e-invoicing/simulationEnvironnement facultatif pour des essais de bout en bout avant la production : les appareils y sont intégrés séparément de la production, avec un OTP obtenu sur le portail de simulation FATOORA et valable une heure.
Production (core)https://gw-fatoora.zatca.gov.sa/e-invoicing/coreEnvironnement réel pour la déclaration et la validation préalable. Les OTP sont obtenus sur le portail FATOORA (jusqu'à 100 par demande, chacun valable une heure) ; il n'existe pas d'API pour les obtenir.

Sources

  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

Vérifié le: 4 novembre 2026. Ce qui concerne JooDax est tiré du code même des programmes.