How to use this site
If you're new here, learn how to navigate these DigiTax UAE API Hub pages below
📖 Guides
This is the overview page of the Guides section.
Explore the guides as outlined on the left-hand menu.
Guide page features
-
Table of contents on the right-hand side (Desktop)
-
Hover to view Glossary definitions (mouseover): Acronyms and technical terms listed in the Glossary appear on a page underlined with a dotted line.
Like API, hover (or tap on mobile) to view the definition.
🚦 Interactive API Docs
For a great developer experience, the endpoints in the DigiTax UAE API reference are interactive.
Once you're set up in the DigiTax Dashboard, you can generate a sandbox or LIVE X-API-Key for authorization. Read more on the API prerequisites.
Explore the API endpoints.
Code samples
You can make use of code samples in over 20 programming languages for requests to get you started quickly.
Pagination
We support cursor-based pagination requests for endpoints whose GET requests return a list of objects.
Parameters for paginated requests
The following are optional query parameters for paginated requests like GET invoices.
| Parameter | Explanation |
|---|---|
before | A cursor pointer to an ID before which we want results (for previous page) |
after | A cursor pointer to an ID after which we want results (for next page) |
page_size | The maximum number of items to return per page (defaults to 20, maximum: 20) |
These are also explained on the API endpoint page(s).
Parameters
Parameters come in two types in the DigiTax UAE API: Query Params and Body Params.
- Query Params: Used in listing endpoints like GET invoices
- Body Params: Passed in JSON request bodies like POST items or POST invoices
💬 We're here to help
If you get stuck, email us or use the DigiTax chat on the bottom right of any page.
We're excited you're here! 💚
Updated about 1 month ago