Update a tax rate | Monite Documentation

Only tax rates that were manually added by the entity (as indicated by is_external = false) can be updated.

Tax rates fetched from accounting systems as part of the accounting integration (indicated by is_external = true) cannot be updated from within Monite.

Authentication

AuthorizationBearer

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

Path parameters

tax_rate_idstringRequired

Request

This endpoint expects an object.

codestringOptional<=500 characters

The new reference code of the tax rate.

descriptionstringOptional<=2048 characters

The new description of the tax rate.

effective_tax_rateintegerOptional>=0<=10000

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

namestringOptional<=500 characters

The new display name of the tax rate.

Response

Successful Response

idstringformat: "uuid"

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_atdatetime

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

updated_atdatetime

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

codestring or null

The reference code of the tax rate.

componentslist of objects or null

An array of tax components.

descriptionstring or null

An arbitrary description of the tax rate.

effective_tax_rateinteger or null

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.

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_externalboolean or nullDefaults to false

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

namestring or null

The display name of the tax rate.

statusstring or null

total_tax_rateinteger or null

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.

Errors