Overview
Every endpoint, with its parameters and responses. Send real requests from the page.
Pick an endpoint from the sidebar. Each page shows the parameters, example requests in several languages and the responses you can expect.
Try a request
Every endpoint has a Send panel. To use it:
- Choose the server. Use Production for your real data.
- Paste your API key into the authorization field. It is only used for the request you send.
- Fill in any parameters and press Send.
Real requests
Requests sent from these pages go to the server you choose, with your key. They are read-only, but they count towards your key's rate limit.
Areas
- Meta: health check and what your key can do.
- Company: your company, branches and payment methods.
- Transactions: transactions, their line items and their payments.
- Payments: payment records.
- Reports: sales summary, product sales and takings by payment type.