GET
View a VAT rate
Company space For: Manager, Accountant · Permission: vat_rates.retrieve 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:resource

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

Available options:
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: .

Response

200 - application/json

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