Sign in

v1

latestOpenAPI 3.1.02026-08-065163115.0 KB
Tax Rates

List tax rates

Returns a paginated list of tax rates for the given business, ordered by name.

For businesses with a connected accounting integration (Xero, MYOB, NetSuite, QuickBooks, Business Central), returns the tax rates synced from that integration. Otherwise, returns the business's own manually configured tax rates. Soft-deleted tax rates are excluded.

Beta: This endpoint is in beta and is being rolled out progressively. If tax rates are not yet enabled for your business, the endpoint returns an empty results array.

get/v1/businesses/{client_id}/tax-rates

Path parameters

client_idinteger required
Example:123

The ID of the business.

Query parameters

offsetinteger
Example:50

Offset to retrieve items from.

limitinteger
Example:50

Number of items per page.

Response

OK

countinteger

Total number of tax rates.

nextstring nullable

Pagination cursor for the next page.

previousstring nullable

Pagination cursor for the previous page.

Example response

{
  "count": 10,
  "next": "limit=50&offset=50",
  "results": [
    {
      "id": "e33b7c61-5124-4ba0-b238-e4c573133715",
      "name": "GST",
      "rate": 0.1,
      "code": "GST",
      "is_default_for": "DOMESTIC",
      "is_enabled": true,
      "source": "WEEL"
    }
  ]
}