Tax Rules

Endpointhttps://api.kontorion.eu/v1

Tax rules define the tax rates applied to charges based on jurisdiction, product category, and customer location. Kontorion evaluates tax rules at invoicing time and adds the appropriate tax line items to each invoice.

Key concepts:

Jurisdiction - country and optional region the rule applies to
Tax type - vat, sales_tax, gst, hst, etc.
Inclusive vs. exclusive - whether the tax is included in the listed price or added on top
Compound tax - whether this tax is calculated on the pre-tax amount or on the amount including other taxes
Apply order - controls the sequence when multiple tax rules apply

List tax rules

GET

https://api.kontorion.eu/v1

/tax-rules

Lists tax rules with cursor-based pagination and the unified field.op=value filter grammar (jurisdiction_country, jurisdiction_region, tax_type, status, rate, valid_from, valid_to, version, created_at, updated_at, published_at, archived_at).

List tax rules › query Parameters

limit

integer · min: 1

Page size. Values above the server-side cap are clamped (standard default 50, cap 200; a few document-heavy lists use larger windows). Invalid values fall back to the default.

Example: 50

cursor

string

Opaque continuation token from the previous response's pagination.cursor. Omit for the first page. Cursors are stateless and do not expire, but are only valid for the list and filters that produced them.

jurisdiction_country

string

Filter by jurisdiction country (eq/in)

jurisdiction_region

string

Filter by jurisdiction region (eq/ne/in)

tax_type

string

Filter by tax type (eq/in)

status

string

Filter by status (eq/ne/in). Filterable fields accept apifilter operator suffixes, e.g. status__in=A,B

rate

string

Filter by rate (eq/ne/gt/gte/lt/lte)

valid_from

string

Filter by valid_from (eq/gt/gte/lt/lte)

valid_to

string

Filter by valid_to (eq/gt/gte/lt/lte)

created_at

string

Filter by created_at (eq/gt/gte/lt/lte)

List tax rules › Headers

X-Workspace-Id

string

Selects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.

Workspace UUID or slug.

List tax rules › Responses

array | null · required

object · required

GET/tax-rules

curl --request GET \
  --url https://api.kontorion.eu/v1/tax-rules

shell

Example Responses

{
  "data": [
    {
      "applies_to_customer_types": [
        "BUSINESS"
      ],
      "applies_to_product_categories": [
        "DEFAULT"
      ],
      "applies_to_supply_types": [
        "DOMESTIC"
      ],
      "apply_order": 0,
      "archived_at": "2024-08-25T15:00:00Z",
      "created_at": "2024-08-25T15:00:00Z",
      "id": "0f8fad5b-d9cb-469f-a165-70867728950e",
      "inclusive": true,
      "is_compound": true,
      "is_expired": true,
      "jurisdiction_country": "jurisdiction_country",
      "jurisdiction_region": "jurisdiction_region",
      "metadata": {
        "key": {}
      },
      "organization_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
      "published_at": "2024-08-25T15:00:00Z",
      "published_by": "0f8fad5b-d9cb-469f-a165-70867728950e",
      "rate": "49.5",
      "requires_continuous_coverage": true,
      "status": "status",
      "tax_type": "VAT",
      "updated_at": "2024-08-25T15:00:00Z",
      "valid_from": "2024-08-25T15:00:00Z",
      "valid_to": "2024-08-25T15:00:00Z",
      "version": 0
    }
  ],
  "pagination": {
    "counts": {
      "key": {
        "key": 0
      }
    },
    "cursor": "cursor",
    "has_more": true,
    "total_count": 0
  }
}

json

application/json

Create a tax rule

POST

https://api.kontorion.eu/v1

/tax-rules

Creates a new tax rule for the organization.

Create a tax rule › Headers

Idempotency-Key

string · required

Unique key that makes this POST safe to retry: repeats with the same key replay the first response instead of re-executing. Replays are scoped to the retrying principal (same API key / user) and kept for 24 hours. Required on every POST.

Client-generated idempotency key (e.g. a UUID).

X-Workspace-Id

string

Workspace UUID or slug.

Create a tax rule › Request Body

applies_to_customer_types

array | null

applies_to_product_categories

array | null

applies_to_supply_types

array | null

apply_order

integer · int64

inclusive

boolean

is_compound

boolean

jurisdiction_country

string

jurisdiction_region

string

object

rate

string · pattern: ^-?\d+(\.\d+)?$

Decimal number encoded as a string to preserve precision.

Example: 49.5

requires_continuous_coverage

boolean

tax_type

string

valid_from

string · date-time

valid_to

string · date-time

Create a tax rule › Responses

Created

object · required

POST/tax-rules

curl --request POST \
  --url https://api.kontorion.eu/v1/tax-rules \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <string>' \
  --data '
{
  "applies_to_customer_types": [
    "string"
  ],
  "applies_to_product_categories": [
    "string"
  ],
  "applies_to_supply_types": [
    "string"
  ],
  "apply_order": 0,
  "inclusive": true,
  "is_compound": true,
  "jurisdiction_country": "jurisdiction_country",
  "jurisdiction_region": "jurisdiction_region",
  "metadata": {
    "key": {}
  },
  "rate": "49.5",
  "requires_continuous_coverage": true,
  "tax_type": "tax_type",
  "valid_from": "2024-08-25T15:00:00Z",
  "valid_to": "2024-08-25T15:00:00Z"
}
'

shell

Example Request Body

{
  "applies_to_customer_types": [
    "string"
  ],
  "applies_to_product_categories": [
    "string"
  ],
  "applies_to_supply_types": [
    "string"
  ],
  "apply_order": 0,
  "inclusive": true,
  "is_compound": true,
  "jurisdiction_country": "jurisdiction_country",
  "jurisdiction_region": "jurisdiction_region",
  "metadata": {
    "key": {}
  },
  "rate": "49.5",
  "requires_continuous_coverage": true,
  "tax_type": "tax_type",
  "valid_from": "2024-08-25T15:00:00Z",
  "valid_to": "2024-08-25T15:00:00Z"
}

json

Example Responses

{
  "data": {
    "applies_to_customer_types": [
      "BUSINESS"
    ],
    "applies_to_product_categories": [
      "DEFAULT"
    ],
    "applies_to_supply_types": [
      "DOMESTIC"
    ],
    "apply_order": 0,
    "archived_at": "2024-08-25T15:00:00Z",
    "created_at": "2024-08-25T15:00:00Z",
    "id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "inclusive": true,
    "is_compound": true,
    "is_expired": true,
    "jurisdiction_country": "jurisdiction_country",
    "jurisdiction_region": "jurisdiction_region",
    "metadata": {
      "key": {}
    },
    "organization_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "published_at": "2024-08-25T15:00:00Z",
    "published_by": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "rate": "49.5",
    "requires_continuous_coverage": true,
    "status": "status",
    "tax_type": "VAT",
    "updated_at": "2024-08-25T15:00:00Z",
    "valid_from": "2024-08-25T15:00:00Z",
    "valid_to": "2024-08-25T15:00:00Z",
    "version": 0
  }
}

json

application/json

Get a tax rule

GET

https://api.kontorion.eu/v1

/tax-rules/{id}

Get a tax rule › path Parameters

id

string · uuid · required

Tax rule UUID

Get a tax rule › Headers

X-Workspace-Id

string

Workspace UUID or slug.

Get a tax rule › Responses

object · required

GET/tax-rules/{id}

curl --request GET \
  --url https://api.kontorion.eu/v1/tax-rules/:id

shell

Example Responses

{
  "data": {
    "applies_to_customer_types": [
      "BUSINESS"
    ],
    "applies_to_product_categories": [
      "DEFAULT"
    ],
    "applies_to_supply_types": [
      "DOMESTIC"
    ],
    "apply_order": 0,
    "archived_at": "2024-08-25T15:00:00Z",
    "created_at": "2024-08-25T15:00:00Z",
    "id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "inclusive": true,
    "is_compound": true,
    "is_expired": true,
    "jurisdiction_country": "jurisdiction_country",
    "jurisdiction_region": "jurisdiction_region",
    "metadata": {
      "key": {}
    },
    "organization_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "published_at": "2024-08-25T15:00:00Z",
    "published_by": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "rate": "49.5",
    "requires_continuous_coverage": true,
    "status": "status",
    "tax_type": "VAT",
    "updated_at": "2024-08-25T15:00:00Z",
    "valid_from": "2024-08-25T15:00:00Z",
    "valid_to": "2024-08-25T15:00:00Z",
    "version": 0
  }
}

json

application/json

Update a tax rule

PUT

https://api.kontorion.eu/v1

/tax-rules/{id}

Updates an existing tax rule. Flipping a DRAFT rule to status=active publishes it through the supersede atom (ADR-0006 edit-as-publish); PUT with effective_at= schedules a version.

Update a tax rule › path Parameters

id

string · uuid · required

Tax rule UUID

Update a tax rule › Headers

X-Workspace-Id

string

Workspace UUID or slug.

Update a tax rule › Request Body

applies_to_customer_types

string[]

applies_to_product_categories

string[]

applies_to_supply_types

string[]

apply_order

integer · int64

effective_at

string · date-time

inclusive

boolean

is_compound

boolean

jurisdiction_country

string

jurisdiction_region

string

object

rate

string · pattern: ^-?\d+(\.\d+)?$

Decimal number encoded as a string to preserve precision.

Example: 49.5

requires_continuous_coverage

boolean

save_as_draft

boolean

status

string

tax_type

string

valid_from

string · date-time

valid_to

string · date-time

Update a tax rule › Responses

object · required

PUT/tax-rules/{id}

curl --request PUT \
  --url https://api.kontorion.eu/v1/tax-rules/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "applies_to_customer_types": [
    "string"
  ],
  "applies_to_product_categories": [
    "string"
  ],
  "applies_to_supply_types": [
    "string"
  ],
  "apply_order": 0,
  "effective_at": "2024-08-25T15:00:00Z",
  "inclusive": true,
  "is_compound": true,
  "jurisdiction_country": "jurisdiction_country",
  "jurisdiction_region": "jurisdiction_region",
  "metadata": {
    "key": {}
  },
  "rate": "49.5",
  "requires_continuous_coverage": true,
  "save_as_draft": true,
  "status": "status",
  "tax_type": "tax_type",
  "valid_from": "2024-08-25T15:00:00Z",
  "valid_to": "2024-08-25T15:00:00Z"
}
'

shell

Example Request Body

{
  "applies_to_customer_types": [
    "string"
  ],
  "applies_to_product_categories": [
    "string"
  ],
  "applies_to_supply_types": [
    "string"
  ],
  "apply_order": 0,
  "effective_at": "2024-08-25T15:00:00Z",
  "inclusive": true,
  "is_compound": true,
  "jurisdiction_country": "jurisdiction_country",
  "jurisdiction_region": "jurisdiction_region",
  "metadata": {
    "key": {}
  },
  "rate": "49.5",
  "requires_continuous_coverage": true,
  "save_as_draft": true,
  "status": "status",
  "tax_type": "tax_type",
  "valid_from": "2024-08-25T15:00:00Z",
  "valid_to": "2024-08-25T15:00:00Z"
}

json

Example Responses

{
  "data": {
    "applies_to_customer_types": [
      "BUSINESS"
    ],
    "applies_to_product_categories": [
      "DEFAULT"
    ],
    "applies_to_supply_types": [
      "DOMESTIC"
    ],
    "apply_order": 0,
    "archived_at": "2024-08-25T15:00:00Z",
    "created_at": "2024-08-25T15:00:00Z",
    "id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "inclusive": true,
    "is_compound": true,
    "is_expired": true,
    "jurisdiction_country": "jurisdiction_country",
    "jurisdiction_region": "jurisdiction_region",
    "metadata": {
      "key": {}
    },
    "organization_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "published_at": "2024-08-25T15:00:00Z",
    "published_by": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "rate": "49.5",
    "requires_continuous_coverage": true,
    "status": "status",
    "tax_type": "VAT",
    "updated_at": "2024-08-25T15:00:00Z",
    "valid_from": "2024-08-25T15:00:00Z",
    "valid_to": "2024-08-25T15:00:00Z",
    "version": 0
  }
}

json

application/json

Delete a draft tax rule

DELETE

https://api.kontorion.eu/v1

/tax-rules/{id}

Hard-deletes a draft tax rule. Active and archived rules are immutable - use the /archive endpoint instead.

Delete a draft tax rule › path Parameters

id

string · uuid · required

Tax rule UUID

Delete a draft tax rule › Headers

X-Workspace-Id

string

Workspace UUID or slug.

Delete a draft tax rule › Responses

No Content

No data returned

Archive a tax rule version

POST

https://api.kontorion.eu/v1

/tax-rules/{id}/archive

Marks an active tax rule version as archived. Subsequent invoice runs will use the next applicable version (if any).

Archive a tax rule version › path Parameters

id

string · uuid · required

Tax rule UUID

Archive a tax rule version › Headers

Idempotency-Key

string · required

Client-generated idempotency key (e.g. a UUID).

X-Workspace-Id

string

Workspace UUID or slug.

Archive a tax rule version › Responses

No Content

No data returned

Copy a tax rule version as a new draft

POST

https://api.kontorion.eu/v1

/tax-rules/{id}/copy

Creates a new draft tax rule version seeded from the supplied source version. Use to iterate on rates or jurisdiction logic without disturbing the active version.

Copy a tax rule version as a new draft › path Parameters

id

string · uuid · required

Source tax rule version UUID

Copy a tax rule version as a new draft › Headers

Idempotency-Key

string · required

Client-generated idempotency key (e.g. a UUID).

X-Workspace-Id

string

Workspace UUID or slug.

Copy a tax rule version as a new draft › Request Body

object

valid_from

string · date-time

valid_to

string · date-time

Copy a tax rule version as a new draft › Responses

Created

object · required

POST/tax-rules/{id}/copy

curl --request POST \
  --url https://api.kontorion.eu/v1/tax-rules/:id/copy \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <string>' \
  --data '
{
  "metadata": {
    "key": {}
  },
  "valid_from": "2024-08-25T15:00:00Z",
  "valid_to": "2024-08-25T15:00:00Z"
}
'

shell

Example Request Body

{
  "metadata": {
    "key": {}
  },
  "valid_from": "2024-08-25T15:00:00Z",
  "valid_to": "2024-08-25T15:00:00Z"
}

json

Example Responses

{
  "data": {
    "applies_to_customer_types": [
      "BUSINESS"
    ],
    "applies_to_product_categories": [
      "DEFAULT"
    ],
    "applies_to_supply_types": [
      "DOMESTIC"
    ],
    "apply_order": 0,
    "archived_at": "2024-08-25T15:00:00Z",
    "created_at": "2024-08-25T15:00:00Z",
    "id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "inclusive": true,
    "is_compound": true,
    "is_expired": true,
    "jurisdiction_country": "jurisdiction_country",
    "jurisdiction_region": "jurisdiction_region",
    "metadata": {
      "key": {}
    },
    "organization_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "published_at": "2024-08-25T15:00:00Z",
    "published_by": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "rate": "49.5",
    "requires_continuous_coverage": true,
    "status": "status",
    "tax_type": "VAT",
    "updated_at": "2024-08-25T15:00:00Z",
    "valid_from": "2024-08-25T15:00:00Z",
    "valid_to": "2024-08-25T15:00:00Z",
    "version": 0
  }
}

json

application/json

List a tax rule's version timeline

GET

https://api.kontorion.eu/v1

/tax-rules/{id}/timeline

Returns all versions ordered by effective_from. Active and scheduled versions are returned by default; pass include=all to include drafts and archived versions.

List a tax rule's version timeline › path Parameters

id

string · uuid · required

Entity UUID

List a tax rule's version timeline › query Parameters

include

string

Set to 'all' to include draft and archived versions

limit

integer · min: 1

Page size. Values above the server-side cap are clamped (standard default 50, cap 200; a few document-heavy lists use larger windows). Invalid values fall back to the default.

Example: 50

cursor

string

List a tax rule's version timeline › Headers

X-Workspace-Id

string

Workspace UUID or slug.

List a tax rule's version timeline › Responses

array | null · required

object · required

GET/tax-rules/{id}/timeline

curl --request GET \
  --url https://api.kontorion.eu/v1/tax-rules/:id/timeline

shell

Example Responses

{
  "data": [
    {
      "archived_reason": "archived_reason",
      "batch_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
      "batch_label": "batch_label",
      "cancelled_at": "2024-08-25T15:00:00Z",
      "created_at": "2024-08-25T15:00:00Z",
      "depends_on_version_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
      "effective_from": "2024-08-25T15:00:00Z",
      "effective_to": "2024-08-25T15:00:00Z",
      "entity_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
      "id": "0f8fad5b-d9cb-469f-a165-70867728950e",
      "organization_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
      "published_at": "2024-08-25T15:00:00Z",
      "published_by": "0f8fad5b-d9cb-469f-a165-70867728950e",
      "release_strategy": "release_strategy",
      "status": "draft",
      "version": 0,
      "warnings": [
        {
          "current_value": {},
          "field": "field",
          "raised_at": "raised_at",
          "raised_by": "raised_by",
          "scheduled_value": {},
          "type": "type"
        }
      ]
    }
  ],
  "pagination": {
    "counts": {
      "key": {
        "key": 0
      }
    },
    "cursor": "cursor",
    "has_more": true,
    "total_count": 0
  }
}

json

application/json

List tax-rule versions (with lifecycle filter)

GET

https://api.kontorion.eu/v1

/tax-rules/{id}/versions

Returns version rows for the entity, keyset-paginated (default 100, max 200 per page). The status filter accepts draft, scheduled, published, archived; the default excludes draft (ADR-0007). Supports ?include=usage_count and ?archived_reason=.

List tax-rule versions (with lifecycle filter) › path Parameters

id

string · uuid · required

Entity UUID

List tax-rule versions (with lifecycle filter) › query Parameters

status

string

Lifecycle status filter (repeatable / comma-separated): draft, scheduled, published, archived. Default excludes draft.

archived_reason

string

Narrow archived rows by reason (repeatable / comma-separated): canceled, discarded, errored, superseded

include

string

Comma-separated includes. Currently supports usage_count.

limit

integer · min: 1

Page size. Values above the server-side cap are clamped (standard default 50, cap 200; a few document-heavy lists use larger windows). Invalid values fall back to the default.

Example: 50

cursor

string

List tax-rule versions (with lifecycle filter) › Headers

X-Workspace-Id

string

Workspace UUID or slug.

List tax-rule versions (with lifecycle filter) › Responses

array | null · required

object · required

GET/tax-rules/{id}/versions

curl --request GET \
  --url https://api.kontorion.eu/v1/tax-rules/:id/versions

shell

Example Responses

{
  "data": [
    {
      "archived_reason": "archived_reason",
      "created_at": "2024-08-25T15:00:00Z",
      "created_by": "created_by",
      "effective_from": "2024-08-25T15:00:00Z",
      "effective_to": "2024-08-25T15:00:00Z",
      "id": "id",
      "published_at": "2024-08-25T15:00:00Z",
      "status": "draft",
      "usage_count": 0,
      "version": 0,
      "warnings": [
        {
          "field": "field",
          "type": "type"
        }
      ]
    }
  ],
  "pagination": {
    "counts": {
      "key": {
        "key": 0
      }
    },
    "cursor": "cursor",
    "has_more": true,
    "total_count": 0
  }
}

json

application/json

Get a tax-rule version snapshot

GET

https://api.kontorion.eu/v1

/tax-rules/{id}/versions/{version}

Resolves the natural key (country, region, tax_type) from {id} and returns the row whose version matches.

Get a tax-rule version snapshot › path Parameters

id

string · uuid · required

Entity UUID

version

string · required

Version number

Get a tax-rule version snapshot › Headers

X-Workspace-Id

string

Workspace UUID or slug.

Get a tax-rule version snapshot › Responses

object · required

GET/tax-rules/{id}/versions/{version}

curl --request GET \
  --url https://api.kontorion.eu/v1/tax-rules/:id/versions/:version

shell

Example Responses

{
  "data": {
    "applies_to_customer_types": [
      "BUSINESS"
    ],
    "applies_to_product_categories": [
      "DEFAULT"
    ],
    "applies_to_supply_types": [
      "DOMESTIC"
    ],
    "apply_order": 0,
    "archived_at": "2024-08-25T15:00:00Z",
    "created_at": "2024-08-25T15:00:00Z",
    "id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "inclusive": true,
    "is_compound": true,
    "is_expired": true,
    "jurisdiction_country": "jurisdiction_country",
    "jurisdiction_region": "jurisdiction_region",
    "metadata": {
      "key": {}
    },
    "organization_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "published_at": "2024-08-25T15:00:00Z",
    "published_by": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "rate": "49.5",
    "requires_continuous_coverage": true,
    "status": "status",
    "tax_type": "VAT",
    "updated_at": "2024-08-25T15:00:00Z",
    "valid_from": "2024-08-25T15:00:00Z",
    "valid_to": "2024-08-25T15:00:00Z",
    "version": 0
  }
}

json

application/json

Cancel a scheduled tax rule version

POST

https://api.kontorion.eu/v1

/tax-rules/{id}/versions/{version}/cancel

Archives the version and stamps cancelled_at so it never goes active. Cancellation is only available before the version has been applied.

Cancel a scheduled tax rule version › path Parameters

id

string · uuid · required

Entity UUID

version

integer · int64 · required

Version number

Cancel a scheduled tax rule version › Headers

Idempotency-Key

string · required

Client-generated idempotency key (e.g. a UUID).

X-Workspace-Id

string

Workspace UUID or slug.

Cancel a scheduled tax rule version › Responses

object · required

POST/tax-rules/{id}/versions/{version}/cancel

curl --request POST \
  --url https://api.kontorion.eu/v1/tax-rules/:id/versions/:version/cancel \
  --header 'Idempotency-Key: <string>'

shell

Example Responses

{
  "data": {
    "archived_reason": "archived_reason",
    "batch_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "batch_label": "batch_label",
    "cancelled_at": "2024-08-25T15:00:00Z",
    "created_at": "2024-08-25T15:00:00Z",
    "depends_on_version_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "effective_from": "2024-08-25T15:00:00Z",
    "effective_to": "2024-08-25T15:00:00Z",
    "entity_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "organization_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "published_at": "2024-08-25T15:00:00Z",
    "published_by": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "release_strategy": "release_strategy",
    "status": "draft",
    "version": 0,
    "warnings": [
      {
        "current_value": {},
        "field": "field",
        "raised_at": "raised_at",
        "raised_by": "raised_by",
        "scheduled_value": {},
        "type": "type"
      }
    ]
  }
}

json

application/json

Reconfirm a stale tax rule version

POST

https://api.kontorion.eu/v1

/tax-rules/{id}/versions/{version}/reconfirm

Clears warnings on a scheduled version after the operator has acknowledged that an upstream change does not invalidate the scheduled payload. Use PUT to amend the payload itself.

Reconfirm a stale tax rule version › path Parameters

id

string · uuid · required

Entity UUID

version

integer · int64 · required

Version number

Reconfirm a stale tax rule version › Headers

Idempotency-Key

string · required

Client-generated idempotency key (e.g. a UUID).

X-Workspace-Id

string

Workspace UUID or slug.

Reconfirm a stale tax rule version › Responses

object · required

POST/tax-rules/{id}/versions/{version}/reconfirm

curl --request POST \
  --url https://api.kontorion.eu/v1/tax-rules/:id/versions/:version/reconfirm \
  --header 'Idempotency-Key: <string>'

shell

Example Responses

{
  "data": {
    "archived_reason": "archived_reason",
    "batch_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "batch_label": "batch_label",
    "cancelled_at": "2024-08-25T15:00:00Z",
    "created_at": "2024-08-25T15:00:00Z",
    "depends_on_version_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "effective_from": "2024-08-25T15:00:00Z",
    "effective_to": "2024-08-25T15:00:00Z",
    "entity_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "organization_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "published_at": "2024-08-25T15:00:00Z",
    "published_by": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "release_strategy": "release_strategy",
    "status": "draft",
    "version": 0,
    "warnings": [
      {
        "current_value": {},
        "field": "field",
        "raised_at": "raised_at",
        "raised_by": "raised_by",
        "scheduled_value": {},
        "type": "type"
      }
    ]
  }
}

json

application/json

List tax-rule version referrers

GET

https://api.kontorion.eu/v1

/tax-rules/{id}/versions/{version}/referrers

Offset-paginated drill-down of the referrers of one type for one version of the entity.

List tax-rule version referrers › path Parameters

id

string · uuid · required

Entity UUID

version

string · required

Version number (positive integer)

List tax-rule version referrers › query Parameters

type

string

Referrer type to list (required)

limit

integer · min: 1

Page size. Values above the server-side cap are clamped (standard default 50, cap 200; a few document-heavy lists use larger windows). Invalid values fall back to the default.

Example: 50

offset

string

Row offset (default 0)

List tax-rule version referrers › Headers

X-Workspace-Id

string

Workspace UUID or slug.

List tax-rule version referrers › Responses

array | null · required

object · required

GET/tax-rules/{id}/versions/{version}/referrers

curl --request GET \
  --url https://api.kontorion.eu/v1/tax-rules/:id/versions/:version/referrers

shell

Example Responses

{
  "data": [
    {
      "created_at": "2024-08-25T15:00:00Z",
      "customer_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
      "customer_name": "customer_name",
      "id": "0f8fad5b-d9cb-469f-a165-70867728950e",
      "invoice_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
      "invoice_number": "invoice_number",
      "label": "label",
      "since": "2024-08-25T15:00:00Z",
      "sub_label": "sub_label",
      "type": "type"
    }
  ],
  "pagination": {
    "counts": {
      "key": {
        "key": 0
      }
    },
    "cursor": "cursor",
    "has_more": true,
    "total_count": 0
  }
}

json

application/json

Get tax-rule version usage summary

GET

https://api.kontorion.eu/v1

/tax-rules/{id}/versions/{version}/usage

Referrer counts for one version of the entity, grouped by referrer type. Powers the version-switcher hover card.

Get tax-rule version usage summary › path Parameters

id

string · uuid · required

Entity UUID

version

string · required

Version number (positive integer)

Get tax-rule version usage summary › Headers

X-Workspace-Id

string

Workspace UUID or slug.

Get tax-rule version usage summary › Responses

object · required

Payment Methods Tax Compliance