test-pages

Home | Getting started | Postman | Swagger

Postman sample collection

The Postman collection is available to help you get started integrating to the Tax Agile API; and is published with each version of the API; it has example requests that are setup ready to go, all you need to do is plug in your credentials and send the requests.

Using the tools built into Postman you can view the requests in different client implementation languages, you can also duplicate the sample collection and modify the requests to meet your implementation.

Setup

• Download the sample collection
• Setup an Environment and set these three fields…

API_ROOT

This is the server hosting the API you want to make requests to, possible values are:

Server	API_ROOT
Production	https://api.taxagile.io
Test	https://test-api.taxagile.io

ACCOUNT_ID

This is your Tax Agile tenant on our platform, so this is not a username, but instead a identifier of your account as a whole.

We will provide you your Account Id and API key when you start to implement to our API.

Note: these credentials will be provisioned against a server, so you must use Production credentials with the Production API_ROOT.

API_KEY

This is a uuid string which will be provided by us when you start to implement to our API.

Demo requests

In the collection we have included the use-cases which match what our customers use; but there may be options available on the API which are not demonstrated in the collection, please check our Swagger for all the available options.

There is a logical order to these requests, by first doing an Auth, the Bearer token is automatically used on the following requests. In order for the GET requests to work, you must have POST a VAT Determination with the commit=true parameter to save the transaction on the platform.

Name	Functionality
POST Auth	Takes ACCOUNT_ID and API_KEY environment variables and creates a new Bearer token.
POST VAT Determination	Makes a VAT Determination which is not committed (saved).
POST VAT Determination with commit	Makes a VAT Determination with the commit=true parameter so save the transaction.
GET VAT Determination by ID	Returns a summary of the request sent and response given for the transaction; using the uuid returned on the commited determination as the ID.
GET VAT Determination for date range	Queries the commited (saved) transactions and returns a paged result set. The example shows a date/time range filter, but other filter options are set on the request and can be enabled.