Skip to main content
GET
/
api
/
tax-rates
Retrieves the tax rates.
curl --request GET \
  --url https://api.example.com/api/tax-rates \
  --header 'Authorization: <authorization>' \
  --header 'organization-id: <organization-id>'
{
  "data": [
    {
      "id": 1,
      "name": "VAT",
      "nameFormatted": "VAT [10%]",
      "code": "VAT",
      "rate": 10,
      "rateFormatted": "10%",
      "isNonRecoverable": false,
      "isCompound": false,
      "active": true,
      "createdAt": "2024-03-20T10:00:00Z",
      "updatedAt": "2024-03-20T10:00:00Z",
      "description": "Value Added Tax"
    }
  ]
}

Headers

​
Authorization
string
required

Value must be 'Bearer ' where is an API key prefixed with 'bc_' or a JWT token.

Example:

"Bearer bc_1234567890abcdef"

​
organization-id
string
required

Required if Authorization is a JWT token. The organization ID to operate within.

Response

200 - application/json

The tax rates have been successfully retrieved.

​
data
object[]