Skip to main content
PATCH
/
accounting_tax_rates
/
{tax_rate_id}
Update a tax rate
curl --request PATCH \
  --url https://api.sandbox.monite.com/v1/accounting_tax_rates/{tax_rate_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-monite-entity-id: <x-monite-entity-id>' \
  --header 'x-monite-version: <x-monite-version>' \
  --data '
{
  "code": "<string>",
  "description": "<string>",
  "effective_tax_rate": 5000,
  "name": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "code": "<string>",
  "components": [
    {
      "is_compound": true,
      "name": "<string>",
      "rate": 123
    }
  ],
  "description": "<string>",
  "effective_tax_rate": 123,
  "is_external": false,
  "name": "<string>",
  "status": "<string>",
  "total_tax_rate": 123
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-monite-version
string<date>
required
​
x-monite-entity-id
string<uuid>
required

The ID of the entity that owns the requested resource.

Example:

"9d2b4c8f-2087-4738-ba91-7359683c49a4"

Path Parameters

​
tax_rate_id
string<uuid>
required

Body

application/json

Schema for updating an existing tax rate.

​
code
string

The new reference code of the tax rate.

Maximum string length: 500
Examples:

"vat-reduced"

"V1"

​
description
string

The new description of the tax rate.

Maximum string length: 2048
​
effective_tax_rate
integer

The new tax rate value as the percentage multiplied by 100. For example, 12.5% is represented as 1250.

Required range: 0 <= x <= 10000
​
name
string

The new display name of the tax rate.

Maximum string length: 500
Examples:

"20% (VAT on Income)"

"GST on Expenses"

Response

Successful Response

​
id
string<uuid>
required

A unique Monite-generated ID assigned to this tax rate. You can use this ID as the value of the accounting_tax_rate_id field in line items of payables, receivables, and receipts.

​
created_at
string<date-time>
required

UTC date and time when this tax rate was created in Monite. Timestamps follow the ISO 8601 format.

​
updated_at
string<date-time>
required

UTC date and time when this tax rate was last updated in Monite.

​
code
string

The reference code of the tax rate.

​
components
object[]

An array of tax components.

​
description
string

An arbitrary description of the tax rate.

​
effective_tax_rate
integer

The effective tax rate value as the percentage multiplied by 100. For example, 12.5% is represented as 1250.

For manually created tax rates (is_external=false), this is the tax rate value defined by the user.

For tax rates fetched from accounting systems (is_external=true), the effective tax rate is calculated based on the components.

  • In case of QuickBooks, effective_tax_rate is the same as total_tax_rate and is the sum of all tax components.
  • In case of Xero, the effective rate can be higher than the sum total. This happens in the compounded tax rate scenarios, where multiple taxes are applied in a sequence and later taxes are applied to amounts that already include earlier taxes.
​
is_external
boolean
default:false

true if this tax rate was fetched from the connected accounting system, or false if it was created manually by the entity.

​
name
string

The display name of the tax rate.

​
status
string
​
total_tax_rate
integer

Used only in tax rates fetched from accounting systems (is_external=true). Specifies the total (not compounded) tax rate value as the sum of all components. The value is the percentage multiplied by 100. For example, 12.5% is represented as 1250.

For QuickBoooks, total_tax_rate is the same as effective_tax_rate.