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 over the REST API.
REST API Authentication
The Tax Balance API is available at:
https://<your-tax-balance-url>/api
Replacing <your-tax-balance-url>
with the URL that you host your Tax Balance instance on.
You will need an API key to access the API. You can get your API key from the API itself. 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...
Learn more about how to create an API key.
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 and go to https://<your-tax-balance-url>/swagger/index.html
.