Skip to main content
POST
Create a tax rate

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

Unique per company, case-insensitively. This is the value transactions and invoices reference in their vat field.

Required string length: 1 - 100
Example:

"VAT 8.1%"

rate
string

Single-rate tax: percentage 0..100 with up to 4 decimals, as a string. Mutually exclusive with components.

Required string length: 1 - 20
Example:

"8.1"

components
object[]

Component stack (1-10); the stored rate becomes the derived total. Mutually exclusive with rate.

Required array length: 1 - 10 elements
description
string
Maximum string length: 500
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 created

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