Sign in

v1

latestOpenAPI 3.1.02026-08-065163115.0 KB
Tax Rates

Get tax rate

Returns a single tax rate for the given business. Returns 404 if the tax rate does not exist or does not belong to the business.

Beta: This endpoint is in beta and is being rolled out progressively. If tax rates are not yet enabled for your business, this endpoint returns 404.

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

Path parameters

client_idinteger required
Example:123

The ID of the business.

tax_rate_idstring uuid required
Example:e33b7c61-5124-4ba0-b238-e4c573133715

The ID of the tax rate.

Response

OK

idstring uuid

The ID of the tax rate.

namestring

The name of the tax rate.

ratenumber

The tax rate as a decimal fraction.

codestring nullable

The tax rate code.

is_default_for'DOMESTIC' | 'INTERNATIONAL' | 'BOTH' | 'NONE'

Which transaction types the tax rate is the default for.

is_enabledboolean

Whether the tax rate is enabled.

source'WEEL' | 'MANUAL' | 'ASP'

The source of the tax rate.

Example response

{
  "id": "e33b7c61-5124-4ba0-b238-e4c573133715",
  "name": "GST",
  "rate": 0.1,
  "code": "GST",
  "is_default_for": "DOMESTIC",
  "is_enabled": true,
  "source": "WEEL"
}