Skip to main content
PATCH
Update a tax rate

Path Parameters

id
string
required

Tax rate ID

Example:

"7"

Query Parameters

orgId
string
required

Organization ID. Use GET /v1/companies to discover available org/company pairs.

Example:

"1"

companyId
string
required

Company ID. Use GET /v1/companies to discover available companies and their access levels.

Example:

"1"

Body

application/json
name
string
Required string length: 1 - 100
rate
string

Switch to (or change) a single rate. Sending a rate clears any component stack.

Required string length: 1 - 20
components
object[] | null

Replace the component stack (the rate becomes the derived total). Null flattens the tax to a single rate at its stored total.

Required array length: 1 - 10 elements
description
string
Maximum string length: 500
isArchived
boolean

Archive (true) or restore (false). Archived rates stay on existing rows but leave the pickers.

xeroTaxType
string | null

Xero TaxType code (from the Xero organisation's tax rates). Null clears.

Maximum string length: 100
qboTaxCode
string | null

QuickBooks TaxCode id. Null clears.

Maximum string length: 100
vatGlAccount
string | null

Chart account CODE for the input VAT line: the native invoice accrual journal and OUT transaction rows (purchases) naming the rate. Null clears. Once the company has a chart of accounts, a rate above 0 needs at least one of vatGlAccount / outputVatGlAccount and every code must exist in the chart (400 otherwise).

Maximum string length: 100
outputVatGlAccount
string | null

Chart account CODE for the output VAT line on IN transaction rows (sales) naming the rate. Null clears.

Maximum string length: 100

Response

Tax rate updated

success
enum<boolean>
required
Available options:
true
data
object
required
Last modified on November 13, 2026