API and developers
Add Oman e-invoicing to your system through one versioned API
Submit documents, receive validation results and read lifecycle status through a versioned REST API — documented in OpenAPI 3.1, with a Postman collection and a quick-start guide to get your first call working.
- /api/v1/
- OpenAPI 3.1
- Postman collection
What does the Invoice And Tax API offer?
A versioned REST API under /api/v1/. You authenticate with bearer API keys that are shown once and scoped to an organisation or branch. The API is described by an OpenAPI 3.1 specification and comes with a Postman collection and a quick-start guide.
Outcomes
What developers get
-
Versioned REST API
A stable /api/v1/ surface, so your integration does not break when the platform evolves.
-
Scoped bearer keys
API keys are shown once at creation and scoped to an organisation or branch.
-
OpenAPI 3.1 specification
A machine-readable contract for generating clients and validating requests.
-
Postman collection and quick start
Make your first authenticated call quickly, then build from working examples.
How it works
The request flow
Your application authenticates with an organisation-scoped API key, submits a document, receives the validation result and reads the document's lifecycle status. Documents submitted through the API pass the same versioned validation rules as every other source.
- Authenticate with a scoped API key
- Submit a document
- Read validation result and lifecycle status
By role
What it means for each role
-
Finance team
Automation without rekeying
Invoices flow from your ERP or billing system straight into validation.
-
Accountant
Consistent results
API documents follow the same rules as everything else, so finance sees one standard.
-
IT
A contract you can build on
OpenAPI 3.1, a Postman collection and scoped keys make integration predictable.
API questions
How do I authenticate?
With a bearer API key. Keys are shown once when created and are scoped to an organisation or branch.
Is there an API specification?
Yes, an OpenAPI 3.1 specification, along with a Postman collection and a quick-start guide.
Is the API versioned?
Yes. The current version is served under /api/v1/.
How do I get access?
Contact us with a short description of your integration and we will set you up.