PUT
Edit a VAT rate
Company space For: Manager, Accountant · Permission: vat_rates.update Conditions
  • The current default rate cannot be un-defaulted: promote another active rate instead.
  • A VAT rate cannot be both default and inactive.
  • A rate used by a category or item configuration cannot be deactivated.
  • The change is refused when it would make a stored price impossible to calculate.
  • code cannot be changed.
What else happens
  • Promoting a rate to default clears the default flag of the previous default.
  • Changes VAT for every item that uses the rate, directly or through its category or as the default.
Part of Set up VAT and the other taxes.

Authorizations

Authorization
string
header
required

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

Path Parameters

vat_rate
string
required

Identifier of the VAT rate (27-character KSUID string), within the current company's fiscal profile.

Query Parameters

response
enum<string>
default:none

Response mode. Default none; none answers 204 No Content.

Available options:
none,
resource
fields
string

Comma-separated JSON keys of the root resource (id is always rendered). Available: id, country_code, fiscal_status, name, code, rate, treatment, is_default, is_active, created_at, updated_at.

include
string

Comma-separated include paths, each optionally followed by its fields in parentheses: units(id,sku),units.uomUnit(id,name). Max depth 6, max 40 paths. Available: .

Body

application/json
name
string | null

New name, up to 250 characters. Unchanged when omitted or null.

Maximum string length: 250
rate
number | null

New rate, 0 to 999.999999 with up to 6 decimals. Unchanged when omitted or null.

Required range: 0 <= x <= 999.999999
treatment
enum<string> | null

New treatment: standard, reduced, zero_rated or exempt.

Available options:
standard,
reduced,
zero_rated,
exempt
is_default
boolean | null

true promotes this rate to default, replacing the current one. The current default cannot be set to false.

is_active
boolean | null

Activates or deactivates the rate. Deactivation is refused while a category or item uses it, and a default rate cannot be inactive.

Response

Resource (only with response=resource).

id

Identifier of the VAT rate (27-character KSUID string).

country_code

Country of the fiscal profile the rate belongs to.

fiscal_status

Fiscal status of the profile the rate belongs to.

name

Name of the VAT rate.

code

Unique code of the rate within its fiscal profile.

rate

VAT rate, up to 6 decimals, sent as a decimal string.

treatment

standard, reduced, zero_rated or exempt: how VAT is treated for goods using this rate.

is_default
boolean

True for the profile's fallback rate, used by taxable items without their own rate. At most one rate per profile is the default.

is_active
boolean

Whether the rate can be assigned.

created_at

Date and time the record was created (ISO 8601, UTC).

updated_at

Date and time the record was last changed (ISO 8601, UTC).