Live sandbox available now

Connect your system to Saudi e-invoicing workflows with one API

One request enters the integration and the corresponding e-invoicing response is returned. Your team keeps its own system while BOT Solutions supports the integration workflow and technical implementation.

// Example sandbox submission.
POST /api/method/zatca_gateway.api.submit_invoice

{
  "external_invoice_id": "POS-2026-00451",
  "invoice_type": "simplified",
  "items": [{
    "description": "Consulting service",
    "qty": 1,
    "rate": 250.00,
    "tax_rate": 15
  }],
  "payment_method": "cash"
}
200 · accepted_with_warnings example UUID, hash and QR response fields

Add Saudi e-invoicing workflows without replacing your core system

The gateway is designed to connect existing business systems with invoice submission, response handling, document generation, and certificate-related workflows. Final scope depends on the source system, invoice types, onboarding status, and customer controls.

  • Your system sends invoice details — customer, line items, payment method
  • The gateway maps the request into the configured e-invoicing workflow
  • The configured workflow submits or reports the document and returns the corresponding response data
  • Returned with the integration response

Built for existing systems, not only ERPNext

BOT Solutions can scope the gateway around an existing ERP, database, point-of-sale system, or custom application.

Enterprise-system integration experience

A delivered integration connected an Oracle database used by the Saudi branch of a Kuwait-based company to the e-invoicing workflow. The client name remains private pending publication approval.

Qualified solution-provider listing

BOT Solutions is listed in ZATCA’s indicative Solution Providers Directory. ZATCA states that listed providers have passed applicable qualification criteria, while the directory is non-binding and is not approval of every supplied solution.

View the official ZATCA directory

Part of our broader Phase 2 capability

The Gateway API complements contracting and progress billing, advance recovery, retention and deduction handling, and PDF/A-3 invoices with embedded XML for Aramco Vendor Portal submission.

Explore all Phase 2 capabilities

Built for how real integrations actually work

The capabilities below describe the integration workflows supported by the service. Validation scope depends on the customer configuration and test environment.

Idempotent by design

Idempotency controls can use the external invoice identifier to handle retries according to the configured workflow.

Errors that actually explain

Validation responses can identify request fields and workflow issues so the calling system can handle them appropriately.

Full & partial credit notes

Return specific line items or the whole invoice — matched and validated against the original.

XML on every response

The signed UBL 2.1 record you're required to retain, included by default — or fetch it any time later.

ZATCA outage? Handled

Retry and queue behavior can be configured for temporary connection failures and reviewed during integration testing.

Standard authentication

Plain API key/secret tokens. A dedicated, revocable identity for your integration — nothing custom.

See it work, before you commit to anything

Use the playground to explore request formats and test responses in an integration environment. Sandbox activity is not a production invoice or a guarantee of a customer’s compliance.

Everything your developer needs

Two ways in, depending on how you like to work.

Sandbox Playground

Choose an endpoint, edit an example request, submit it in the test environment, and inspect the response shape before planning a production integration.

Open Playground

Developer Integration Guide

The full field-by-field reference — every request field marked required or optional, every error shape, authentication, idempotency, and exactly what happens if ZATCA itself goes down. Browse it online, or grab the PDF to keep.

Read the Guide Download PDF

ZATCA Gateway API questions

Direct answers for technical and business teams evaluating an integration.

Does the gateway require ERPNext?

No. It can be scoped around an existing ERP, database, point-of-sale platform, or custom application when suitable integration access is available.

Does a sandbox test guarantee production compliance?

No. Sandbox testing helps validate the integration workflow. Production readiness still depends on onboarding, configuration, invoice data, controls, testing, and the taxpayer meeting current ZATCA requirements.

What should be reviewed before integration?

Review the source system, invoice types, data mapping, identifiers, certificates, authentication, error handling, reconciliation, retention, security, and rollout responsibilities.

Is BOT Solutions approved by ZATCA?

BOT Solutions is listed in ZATCA’s indicative Solution Providers Directory after passing applicable qualification criteria. ZATCA states that the directory is non-binding and is not approval of every solution supplied by a listed provider.

Light Mode Image