Overview

RESTful APIs

Our APIs are built using a RESTful architecture.

---

JSON Responses

All our responses are in JSON format.

---

API Key

To access API.1, you'll need to create an API Key in the Client Portal.

You must pass your API key in the following HTTP header with every API call:

x-api-key: YOUR_API_KEY_HERE

Remember to replace YOUR_API_KEY_HERE with your actual API key.

---

Correlation ID

For better traceability and support, you must generate and pass a unique Correlation ID (GUID) with each API request.

For example:

x-correlation-id: YOUR_UNIQUE_GUID

A GUID (Globally Unique Identifier) is a unique reference number used for identification.

---

Polling

You access data from connected accounting systems by polling API.1.