Tax rates

The tax rates endpoint returns the rates an organization has set up, so you can put the right taxRateId on invoice and bill lines. An account’s defaultTaxRateId in the chart of accounts also points into this list.

Requires the tax_rates:read scope. See Authentication.

Endpoints

Method	Path	Scope	Description
GET	/api/v1/tax-rates	tax_rates:read	List tax rates.

List tax rates

curl https://app.accountfun.com/api/v1/tax-rates \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Query parameters

Parameter	Type	Default	Description
includeInactive	boolean	false	Also return deactivated rates. An inactive rate can’t be used on a new invoice or bill.

Response — 200 OK

{
  "taxRates": [
    {
      "id": "00000000-0000-0000-0000-0000000000f1",
      "name": "GST on Expenses",
      "kind": "COMPONENT",
      "rate": "5",
      "isActive": true,
      "isSystem": false,
      "components": [
        { "id": "...", "name": "GST", "rate": "5", "recoverable": true }
      ]
    }
  ]
}

Field	Description
rate	The effective percentage as a string — "5" is 5%, "9.975" is 9.975%.
kind	COMPONENT (built from the listed components) or SIMPLE (one flat percentage, no components).
components[].recoverable	Whether tax paid on purchases at this component can be claimed back.
isSystem	A built-in rate (such as Tax Exempt) that can’t be deleted.

Rates are sorted with the built-in ones first, then by name.