Custom Connector
ZATCA Connector
KSA
The ZATCA Connector enables seamless integration with ZATCA’s e-Invoicing system, facilitating compliance with Saudi Arabian tax regulations. This connector provides functionalities such as onboarding, renewal, validation, reporting, and clearance of invoices.
Overview
Integration Overview
This document provides a detailed guide for each integration point, its purpose, configuration, and workflow support using the ZATCA custom connector.
- Onboarding integration. Generates cryptographic stamps (CSID) for new systems.
- Renewal integration. Renews expiring cryptographic stamps.
- Validation integration. Validates XML invoices and QR codes.
- Reporting integration. Submits simplified invoices for reporting.
- Clearance integration. Submits standard invoices for clearance with ZATCA’s backend.
Documentation
Detailed Integration Documentation
Onboarding integration
| Purpose | Generates a compliance cryptographic stamp identifier (CSID) required for authentication within the ZATCA ecosystem. |
|---|---|
| Input details | Required fields: Certificate Signing Request (CSR), VAT Registration Number. Configuration: ensure JDK (≥11, <15) is installed on the server for generating and signing CSRs. |
| Output | Success: returns test CSID and Request ID. Failure: indicates invalid CSR or missing parameters. |
| Workflow | 1. Generate a CSR using the JDK. 2. Use the Onboarding integration point to obtain the CSID. 3. Use the CSID for subsequent integrations. |
Renewal integration
| Purpose | Renews the compliance CSID to maintain integration capabilities. |
|---|---|
| Input details | XML invoice (Base64 encoded). Supported invoice types include Standard and Simplified Tax Invoices. |
| Workflow | 1. Pre-process invoices with the connector. 2. Use this integration to check compliance before submission. |
Validation integration
| Purpose | Validates XML invoices for compliance with ZATCA standards. |
|---|---|
| Input details | XML invoice (Base64 encoded). Supported invoice types include Standard and Simplified Tax Invoices. |
| Output | Valid: confirms invoice compliance. Invalid: returns validation errors and recommendations. |
| Workflow | 1. Pre-process invoices with the connector. 2. Use this integration to check compliance before submission. |
Reporting integration
| Purpose | Submits simplified invoices for reporting to ZATCA. |
|---|---|
| Workflow | 1. Validate the invoice using the Validation integration point. 2. Submit the validated invoice for reporting through the connector. |
Clearance integration
| Purpose | Submits standard invoices for clearance and stamping by ZATCA. |
|---|---|
| Workflow | 1. Validate the invoice and generate the hash using the connector. 2. Use the Clearance integration point to submit the invoice. 3. Retrieve the stamped invoice for record-keeping and compliance. |
Support
For technical support, contact custom-connectors-support@isolutions.sa.