Tax Balance is built API-first. All data and operations are available over its REST API. The Tax Balance Web Portal is built on top of this API so all the data and operations you can see and perform in the Tax Balance Web Portal can be performed via the REST API.

The Tax Balance API is available at:

Replacing <your-tax-balance-url> with the URL that you host your Tax Balance instance on.

REST API Authentication

You will need an API key to access the API. Once you have a key, you can provide it to the API through the Authorization HTTP header with the value ApiKey <your-api-key>, replacing <your-api-key> with the created API key, e.g., API-123....

REST API Swagger Documentation

Tax Balance includes the default Swagger UI for displaying the API documentation in a nice human readable way.

To browse that UI just open your browser at:

Replacing <your-tax-balance-url> with the URL that you host your Tax Balance instance on.