ZATCA

Number of APIs: 8

Welcome to Antna's API Documentation. We've designed this document to help developers and Antna users fully understand and integrate our API for a seamless and easy deployment. These APIs enable you to utilise most of your Antna account's ZATCA features fully.

We've listed all the APIs, their required parameters, and their example requests and responses on the right for easy understanding. The easiest way to start using the Antna APIs is by clicking the Run in Qodex button above. The Qodex is a free tool that helps developers run and debug API requests.

Our APIs are based around REST architecture and use the basic HTTP request methods. Our APIs accept JSON - encoded body requests and return data in the same form.

Read through the following sections for the integration process.

API Workflows:

B2C Tax Document Flow:

B2B Tax Document Flow:

Getting Started

First, you need to register with Antna and create an account. Click on this link and refer to this video to complete the sign-up process.

Document and API Usage Guidelines

Our APIs use the basic HTTP request codes: POST, GET, PATCH, & PUT.
You can select the required response and request code language by selecting it from the drop-down menu on the top.
You can import and test all our full API collection in the Qodex app by clicking on the ' Run in Qodex' button.
Note: Any requests made using the valid API credentials will affect the real-time data in your Antna account.
Authorization: accessToken
All the APIs are provided with their appropriate example requests and responses for successful and failed calls. The example definitions are:
- Successful Call: The API call was correct.
- Invalid Data: The data entered was incorrect.
- Missing Fields: Some of the required fields are missing.
- Wrong Format: There is a syntax error in the code.

Errors and Response codes

While using Antna's APIs, you may run into some standard response and error codes. The most common ones are listed along with their descriptions as follows:

RESPONSE CODE	DESCRIPTION
`200` & `202` - OK & Accepted	Everything worked as expected, and you'll get a response. Some APIs may respond with an error message if data is invalid.
`400` - Bad Request	The request was invalid or cannot be otherwise served.
`401` - Unauthorized	There is some error during validation. You need to check your token or credentials.
`404` - Not Found	The URI requested is invalid or the resource requested does not exist.
`429` - Too Many Requests	You have exceeded the API call rate limit.
`500`, `502`, `503`, `504` - Server Errors	Some server error has occurred. Some APIs may show this due to syntax or parameter errors. Try contacting support if this persists.

Support:

All the required information on integration is in this document. Please read it thoroughly.
For any integration and API-related support, you can feel free to drop us an email at support@antna.co.in.
For any other issues, please email us at: support@antna.co.in.
The Antna terms of service are listed here: Terms Of Service