Skip to main content
GET
List Required Additional Tax Fields by Country

Authorizations

Authorization
string
header
required

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

Headers

X-MultiTenantKey
string

Required when using a Platform API token. The tenant key identifying which business to operate on.

Query Parameters

country
string
required
version
string

Describe the fields for a pinned ruleset version, for example v2.1.0. Omit for the current ruleset. A version that cannot be pinned is rejected with a 400.

Response

Required tax fields by country

version
string

The tax ruleset version these fields belong to.

Example:

"v2.1.0"

effectiveFrom
string

Date this ruleset version takes effect.

pinnable
boolean

Whether this version can be pinned on a calculation.

data
object[]
schema
object

JSON Schema (draft 2020-12) describing the same fields and their cross-field relationships, extended with x-cadana-* keywords for rules no standard keyword expresses. Additive — data stays the flat, back-compatible list; adopt schema when you want to render and validate onboarding forms directly from the response.

schemaVersion
string

JSON Schema dialect the schema document targets (e.g. "2020-12").