Getting started

Sign Up and Obtain API Credentials

If you haven't done so already, sign up for an account on our platform. Once registered, don't hesitate to get in touch with your eezi account manager to activate your account, which will enable you to generate access tokens.

If you need access to our Enterprise API with multi-org management features, please contact your eezi account manager, who will guide you through the onboarding process.

API Authentication

To authenticate your API requests, include your API key in the request headers or follow the authentication method specified in our API documentation. This step ensures that only authorized users can access and interact with the API.

🚧

The Enterprise API will only work for enterprise API keys and not work with organisation-level keys. For more information, please contact your account manager or our friendly support team.

API Endpoints

Refer to our API reference to explore the available endpoints and resources supported by the e-Invoicing API. Each endpoint represents a specific function or action that can be performed using the API, and is broken into two sections:

1. Organisation API - For specific tasks related to a single organisation.
2. Enterprise API - For access and management of multiple organisations.

Request and Response Formats

Understand the request and response formats required to interact with the API. Our API documentation provides detailed information about the payload structure, required parameters, and response formats for each API endpoint. You can also find example requests and responses to assist you in crafting the right API calls.

Error Handling

Familiarize yourself with the error-handling process outlined in our documentation. In case of errors or unsuccessful API calls, our API returns informative error codes and messages. We provide guidance on how to interpret and handle these errors gracefully in your application.

Best Practices and Guidelines

Review the best practices and guidelines section to ensure optimal usage of the e-Invoicing API. This section provides recommendations, tips, and conventions for integrating with our API. Following these guidelines will help you build robust and efficient invoicing solutions.