Quick Start Guide Overview

❗️

Caution

To use this guide and the associated file, you need to have a user for the environment (usually the Sandbox environment) and have retrieved the access token so you can enter it when you install the sample files.

Taxamo provides a preconfigured set of collection files for the Postman tool. You can use it to model a sample scenario in your environment. This will help you understand how the API works.

To run the collection directly in Postman, use the following button:

You can also install the files from the public workspace in Postman. These steps are outlined in this documentation. After you complete these steps, you will have modelled a simple transaction lifecycle in your environment. You can also use the data that you create to test features like the reports.

For more information about how to install the sample files, see Installing the Quick Start Files.

In the sample scenario, the seller is selling goods from the UK to France. These goods are valued up to €150 and therefore are treated as IOSS transactions where Taxamo bears the liability. The sample files include sample data in the JSON objects attached to the sample requests. This is designed to help you understand the following:

• How to send requests to the API.
• How to attach information to the bodies of these requests.
• How the API returns information in the same format.
• What fields you need to understand such as the product code field.

The sample files here match the model of the transaction lifecycle (and requests) that are used by Taxamo.

For a guided walkthrough of the activity, see:

• Calculate Tax
• Store Transaction
• Confirm Transaction
• Refund Transaction