POST
Create a VAT rate
Company space For: Manager, Accountant · Permission: vat_rates.create Conditions
  • code must be unique within the fiscal profile.
  • rate is required, between 0 and 999.999999, with at most 6 decimals.
  • A VAT rate cannot be both default and inactive.
  • Creating the new default must not make a stored price impossible to calculate.
What else happens
  • When is_default is true the previous default rate of the profile loses its default flag; the new default applies to every taxable item without its own rate.
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.

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
required

Name of the VAT rate, up to 250 characters.

Maximum string length: 250
code
string
required

Code of the rate, up to 50 characters, unique within the company's fiscal profile.

Maximum string length: 50
rate
number
required

VAT rate, 0 to 999.999999 with up to 6 decimals.

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

standard, reduced, zero_rated or exempt. Defaults to standard when omitted.

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

Makes this the profile's default rate, replacing the current one. Defaults to false; a default rate must be active.

is_active
boolean | null

Whether the rate is active. Defaults to true.

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).