Skip to main content
POST
Create VAT rate

Authorizations

X-API-KEY
string
header
required

Headers

Idempotency-Key
string

Optional. A unique value (a UUID works well) identifying this operation. If the request is repeated with the same key, the original response is replayed instead of the operation running again, so a retry cannot create a duplicate record. Results are replayable for 48 hours. Reusing a key with a different request body returns 422.

Maximum string length: 255

Body

application/json
country_code
enum<string>
required

Countries with a VAT system. Used to restrict API inputs to valid VAT jurisdictions.

Available options:
AE,
CH,
CW,
GB,
KR,
NO,
TH,
TZ,
MX,
ZA,
FR,
DE,
ES,
IT,
NL,
BE,
IE,
PT,
SE,
AT,
PL,
DK,
FI,
GR,
CZ,
RO,
HU,
BG,
HR,
SK,
SI,
LT,
LV,
EE,
CY,
MT,
LU
name
string
required
Maximum string length: 100
rate
required
Required range: 0 <= x <= 1
rate_type
enum<string>
required
Available options:
STANDARD,
REDUCED,
SUPER_REDUCED,
PARKING,
ZERO,
EXEMPT,
OUT_OF_SCOPE
tax_type
enum<string>
required
Available options:
INPUT_OUTPUT,
ZERO_RATED,
EXEMPT,
REVERSE_CHARGE,
OUT_OF_SCOPE
valid_from
string<date>
required
valid_to
string<date> | null
description
string | null
tax_asset_account_id
integer | null
tax_liability_account_id
integer | null
is_non_deductible
boolean
default:false
deductible
Required range: 0 <= x <= 1
non_deductible_cost_account_id
integer | null
vatex_code
enum<string> | null

The CEF VATEX code to store on an exempt VAT rate. Omit or set null when the rate has no default.

Available options:
VATEX-EU-79-C,
VATEX-EU-132,
VATEX-EU-132-1A,
VATEX-EU-132-1B,
VATEX-EU-132-1C,
VATEX-EU-132-1D,
VATEX-EU-132-1E,
VATEX-EU-132-1F,
VATEX-EU-132-1G,
VATEX-EU-132-1H,
VATEX-EU-132-1I,
VATEX-EU-132-1J,
VATEX-EU-132-1K,
VATEX-EU-132-1L,
VATEX-EU-132-1M,
VATEX-EU-132-1N,
VATEX-EU-132-1O,
VATEX-EU-132-1P,
VATEX-EU-132-1Q,
VATEX-EU-135-1,
VATEX-EU-144,
VATEX-EU-146-1E,
VATEX-EU-148,
VATEX-EU-148-A,
VATEX-EU-148-B,
VATEX-EU-148-C,
VATEX-EU-148-D,
VATEX-EU-148-E,
VATEX-EU-148-F,
VATEX-EU-148-G,
VATEX-EU-151,
VATEX-EU-151-1A,
VATEX-EU-151-1AA,
VATEX-EU-151-1B,
VATEX-EU-151-1C,
VATEX-EU-151-1D,
VATEX-EU-151-1E,
VATEX-EU-153,
VATEX-EU-159,
VATEX-EU-309

Response

Created

Output schema for VAT rate.

id
integer
required
country_code
string
required
name
string
required
rate
string
required
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,6}0*$
rate_type
enum<string>
required
Available options:
STANDARD,
REDUCED,
SUPER_REDUCED,
PARKING,
ZERO,
EXEMPT,
OUT_OF_SCOPE
tax_type
enum<string>
required
Available options:
INPUT_OUTPUT,
ZERO_RATED,
EXEMPT,
REVERSE_CHARGE,
OUT_OF_SCOPE
valid_from
string<date>
required
valid_to
string<date> | null
required
is_active
boolean
required
is_system
boolean
required
description
string | null
required
tax_asset_account_id
integer | null
tax_liability_account_id
integer | null
is_non_deductible
boolean
default:false
deductible
string | null
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,6}0*$
non_deductible_cost_account_id
integer | null
vatex_code
enum<string> | null

The CEF VATEX code of this exempt VAT rate. null when the rate has no default.

Available options:
VATEX-EU-79-C,
VATEX-EU-132,
VATEX-EU-132-1A,
VATEX-EU-132-1B,
VATEX-EU-132-1C,
VATEX-EU-132-1D,
VATEX-EU-132-1E,
VATEX-EU-132-1F,
VATEX-EU-132-1G,
VATEX-EU-132-1H,
VATEX-EU-132-1I,
VATEX-EU-132-1J,
VATEX-EU-132-1K,
VATEX-EU-132-1L,
VATEX-EU-132-1M,
VATEX-EU-132-1N,
VATEX-EU-132-1O,
VATEX-EU-132-1P,
VATEX-EU-132-1Q,
VATEX-EU-135-1,
VATEX-EU-144,
VATEX-EU-146-1E,
VATEX-EU-148,
VATEX-EU-148-A,
VATEX-EU-148-B,
VATEX-EU-148-C,
VATEX-EU-148-D,
VATEX-EU-148-E,
VATEX-EU-148-F,
VATEX-EU-148-G,
VATEX-EU-151,
VATEX-EU-151-1A,
VATEX-EU-151-1AA,
VATEX-EU-151-1B,
VATEX-EU-151-1C,
VATEX-EU-151-1D,
VATEX-EU-151-1E,
VATEX-EU-153,
VATEX-EU-159,
VATEX-EU-309