Connector Details
Type
SaaS & APIs
Runs on
Google Cloud Platform
Last Update
24 October, 2024
Category
Big data, Analytics, DevOps
ZATCA Connector
Overview
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.
Integration Overview
This document provides a detailed guide for each integration point, its purpose, configuration, and workflow support using the ZATCA custom connector.
Supported Integration Points
- 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.
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
- Successful: Returns test CSID and Request ID.
- Failure: Indicates invalid CSR or missing parameters.
Workflow Example
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 Example
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 Example
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 Example
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 Example
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.
Workflow Creation with the Connector
Example Workflow: Submitting a Standard Invoice
Prepare Invoice
Generate the invoice in XML format.
Validate Invoice
- Use the Validation integration point to ensure compliance.
- Address any issues based on validation feedback.
Submit Invoice for Clearance
- Encode the XML invoice using Base64.
- Use the Clearance integration to submit the invoice for stamping.
- Retrieve the stamped invoice from the response.
Monitor Submission
1. Monitor Submission
Additional Notes
- Each integration requires a valid cryptographic stamp (CSID) for secure communication.
- Ensure all XML payloads comply with ZATCA’s published schema and security standards.
- Use GCP tools like Cloud Run, Functions, and Storage to automate and scale integration workflows effectively.
-
Pricing
iSolution logo - white - transparent 250 px