Docs
API Reference

Tax Rates

Manage the tax rates applied to services, inventory, quotes, and invoices

A tax rate defines a named percentage (e.g. "GST 10%") that services and inventory items reference by taxRateId. Rates can be inclusive or exclusive, and exactly one rate can be marked as the organisation default.

Only one default

Setting defaultEnabled: true on a tax rate automatically clears the default flag on every other rate — there is always at most one default.

Required scopes: tax-rates:read / tax-rates:write / tax-rates:delete.

Endpoints

  • GET/organisations/{orgId}/tax-rates — List tax rates
  • POST/organisations/{orgId}/tax-rates — Create tax rate
  • GET/organisations/{orgId}/tax-rates/{taxRateId} — Get tax rate
  • PUT/organisations/{orgId}/tax-rates/{taxRateId} — Update tax rate
  • DELETE/organisations/{orgId}/tax-rates/{taxRateId} — Delete tax rate

Machine-readable version: OpenAPI spec.

On this page