Rate Tables

Endpointhttps://api.kontorion.eu/v1

Rate tables provide structured lookup pricing - a grid of rates indexed by one or more dimensions. Use rate tables for complex pricing that depends on multiple variables like geography, volume tier, customer segment, or contract term.

Example: A shipping rate table with dimensions for weight range, origin country, and destination country.

List rate tables

GET

https://api.kontorion.eu/v1

/rate-tables

Lists all rate tables that belong to the caller's organization.

List rate tables › 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.

List rate tables › 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 rate tables › Responses

array | null · required

object · required

GET/rate-tables

curl --request GET \
  --url https://api.kontorion.eu/v1/rate-tables

shell

Example Responses

{
  "data": [
    {
      "created_at": "2024-08-25T15:00:00Z",
      "currency": "currency",
      "default_value": "default_value",
      "deleted_at": "2024-08-25T15:00:00Z",
      "description": "description",
      "head_version_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
      "id": "0f8fad5b-d9cb-469f-a165-70867728950e",
      "lifecycle_status": "draft",
      "name": "name",
      "on_missing_key": "error",
      "organization_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
      "requires_continuous_coverage": true,
      "slug": "slug",
      "table_type": "lookup",
      "updated_at": "2024-08-25T15:00:00Z"
    }
  ],
  "pagination": {
    "counts": {
      "key": {
        "key": 0
      }
    },
    "cursor": "cursor",
    "has_more": true,
    "total_count": 0
  }
}

json

application/json

Create a rate table

POST

https://api.kontorion.eu/v1

/rate-tables

Creates a new rate-table container scoped to the caller's organization. Versions and entries are added through the version sub-routes.

Create a rate table › 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 rate table › Request Body

currency

string

ISO 4217 currency for the entry values; defaults to the org's preferred currency when omitted.

default_value

string

Decimal value returned on a miss; required when on_missing_key=default_value.

description

string · maxLength: 2000

Optional description of the table's purpose.

name

string · maxLength: 200

Display name for the table.

on_missing_key

string · enum

Behaviour when no entry matches: 'error', 'zero', or 'default_value'.

Enum values:

error

zero

default_value

requires_continuous_coverage

boolean

When true, published versions may not leave a gap in the effective-date timeline.

slug

string · maxLength: 100

URL-safe unique identifier formulas reference this table by.

Example: icann_fees

table_type

string · enum

Matching mode: 'lookup' (exact key match) or 'bracket' (numeric range match).

Enum values:

lookup

bracket

Create a rate table › Responses

Created

object · required

POST/rate-tables

curl --request POST \
  --url https://api.kontorion.eu/v1/rate-tables \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <string>' \
  --data '
{
  "currency": "currency",
  "default_value": "default_value",
  "description": "description",
  "name": "name",
  "on_missing_key": "error",
  "requires_continuous_coverage": true,
  "slug": "icann_fees",
  "table_type": "lookup"
}
'

shell

Example Request Body

{
  "currency": "currency",
  "default_value": "default_value",
  "description": "description",
  "name": "name",
  "on_missing_key": "error",
  "requires_continuous_coverage": true,
  "slug": "icann_fees",
  "table_type": "lookup"
}

json

Example Responses

{
  "data": {
    "created_at": "2024-08-25T15:00:00Z",
    "currency": "currency",
    "default_value": "default_value",
    "deleted_at": "2024-08-25T15:00:00Z",
    "description": "description",
    "head_version_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "lifecycle_status": "draft",
    "name": "name",
    "on_missing_key": "error",
    "organization_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "requires_continuous_coverage": true,
    "slug": "slug",
    "table_type": "lookup",
    "updated_at": "2024-08-25T15:00:00Z"
  }
}

json

application/json

Get a rate table

GET

https://api.kontorion.eu/v1

/rate-tables/{id}

Returns the rate table's root row (slug, type, missing-key policy, currency, lifecycle status, head version pointer). Version content — the rows and entries — is served by the /rate-tables/{id}/versions endpoints.

Get a rate table › path Parameters

id

string · uuid · required

Rate table ID

Get a rate table › Headers

X-Workspace-Id

string

Workspace UUID or slug.

Get a rate table › Responses

object · required

GET/rate-tables/{id}

curl --request GET \
  --url https://api.kontorion.eu/v1/rate-tables/:id

shell

Example Responses

{
  "data": {
    "created_at": "2024-08-25T15:00:00Z",
    "currency": "currency",
    "default_value": "default_value",
    "deleted_at": "2024-08-25T15:00:00Z",
    "description": "description",
    "head_version_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "lifecycle_status": "draft",
    "name": "name",
    "on_missing_key": "error",
    "organization_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "requires_continuous_coverage": true,
    "slug": "slug",
    "table_type": "lookup",
    "updated_at": "2024-08-25T15:00:00Z"
  }
}

json

application/json

Delete a rate table (draft only)

DELETE

https://api.kontorion.eu/v1

/rate-tables/{id}

Hard-deletes a rate table that has never had a published version. Once a version is published, use Archive instead.

Delete a rate table (draft only) › path Parameters

id

string · uuid · required

Rate table ID

Delete a rate table (draft only) › Headers

X-Workspace-Id

string

Workspace UUID or slug.

Delete a rate table (draft only) › Responses

No Content

No data returned

Update a rate table

PATCH

https://api.kontorion.eu/v1

/rate-tables/{id}

Updates editable fields on a rate table (name, description, etc.). With effective_at set, takes the table's latest draft version live — immediately or scheduled — and returns the affected version instead of the table.

Update a rate table › path Parameters

id

string · uuid · required

Rate table ID

Update a rate table › Headers

X-Workspace-Id

string

Workspace UUID or slug.

Update a rate table › Request Body

default_value

string

New default value; omit to leave unchanged.

description

string · maxLength: 2000

New description; omit to leave unchanged.

effective_at

string · date-time

Publish timestamp for this edit; mutually exclusive with save_as_draft.

name

string · maxLength: 200

New display name; omit to leave unchanged.

on_missing_key

string · enum

New missing-key behaviour ('error', 'zero', or 'default_value'); omit to leave unchanged.

Enum values:

error

zero

default_value

requires_continuous_coverage

boolean

New continuous-coverage requirement; omit to leave unchanged.

save_as_draft

boolean

When true, parks the edit in a draft version instead of publishing it; mutually exclusive with effective_at.

Update a rate table › Responses

required

Outcome-dependent: with effective_at the PATCH publishes the latest draft and returns the RateTableVersion; a plain display-field update returns the RateTable root row.

PATCH/rate-tables/{id}

curl --request PATCH \
  --url https://api.kontorion.eu/v1/rate-tables/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "default_value": "default_value",
  "description": "description",
  "effective_at": "2024-08-25T15:00:00Z",
  "name": "name",
  "on_missing_key": "error",
  "requires_continuous_coverage": true,
  "save_as_draft": true
}
'

shell

Example Request Body

{
  "default_value": "default_value",
  "description": "description",
  "effective_at": "2024-08-25T15:00:00Z",
  "name": "name",
  "on_missing_key": "error",
  "requires_continuous_coverage": true,
  "save_as_draft": true
}

json

Example Responses

{
  "data": {
    "archived_at": "2024-08-25T15:00:00Z",
    "created_at": "2024-08-25T15:00:00Z",
    "currency": "currency",
    "effective_from": "2024-08-25T15:00:00Z",
    "effective_to": "2024-08-25T15:00:00Z",
    "entries": [
      {
        "id": "0f8fad5b-d9cb-469f-a165-70867728950e",
        "lookup_key": "lookup_key",
        "range_max": "49.5",
        "range_min": "49.5",
        "value": "49.5"
      }
    ],
    "id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "note": "note",
    "published_at": "2024-08-25T15:00:00Z",
    "published_by": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "rate_table_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "status": "draft",
    "version": 0
  }
}

json

application/json

Archive a rate table (terminal)

POST

https://api.kontorion.eu/v1

/rate-tables/{id}/archive

Terminal transition: soft-deletes the table and archives all of its versions, returning 200 with the archived rate table. Use this once the table has at least one published version (Delete is reserved for never-published drafts).

Archive a rate table (terminal) › path Parameters

id

string · uuid · required

Rate table ID

Archive a rate table (terminal) › Headers

Idempotency-Key

string · required

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

X-Workspace-Id

string

Workspace UUID or slug.

Archive a rate table (terminal) › Responses

object · required

POST/rate-tables/{id}/archive

curl --request POST \
  --url https://api.kontorion.eu/v1/rate-tables/:id/archive \
  --header 'Idempotency-Key: <string>'

shell

Example Responses

{
  "data": {
    "created_at": "2024-08-25T15:00:00Z",
    "currency": "currency",
    "default_value": "default_value",
    "deleted_at": "2024-08-25T15:00:00Z",
    "description": "description",
    "head_version_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "lifecycle_status": "draft",
    "name": "name",
    "on_missing_key": "error",
    "organization_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "requires_continuous_coverage": true,
    "slug": "slug",
    "table_type": "lookup",
    "updated_at": "2024-08-25T15:00:00Z"
  }
}

json

application/json

List rate-table versions (with lifecycle filter)

GET

https://api.kontorion.eu/v1

/rate-tables/{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 rate-table versions (with lifecycle filter) › path Parameters

id

string · uuid · required

Entity UUID

List rate-table 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 rate-table versions (with lifecycle filter) › Headers

X-Workspace-Id

string

Workspace UUID or slug.

List rate-table versions (with lifecycle filter) › Responses

array | null · required

object · required

GET/rate-tables/{id}/versions

curl --request GET \
  --url https://api.kontorion.eu/v1/rate-tables/: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

Create a draft rate-table version

POST

https://api.kontorion.eu/v1

/rate-tables/{id}/versions

Creates a new draft version under the given rate table. Entries must be added separately via the import endpoint before the version can be published. Returns 409 while another draft is open - a table has at most ONE open draft, because publish-with-effective_at always takes the latest one.

Create a draft rate-table version › path Parameters

id

string · uuid · required

Rate table ID

Create a draft rate-table version › Headers

Idempotency-Key

string · required

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

X-Workspace-Id

string

Workspace UUID or slug.

Create a draft rate-table version › Request Body

array | null · maxItems: 1000

Bracket entries to create for the version.

clone_from_version_id

string · uuid

Optional existing version to seed the new version's entries from.

Example: 0f8fad5b-d9cb-469f-a165-70867728950e

effective_from

string · date-time

When the new version starts being effective on the billing timeline.

effective_to

string · date-time

Optional timestamp at which the new version stops being effective.

array | null · maxItems: 1000

Raw entry rows (lookup or bracket) for the version.

array | null · maxItems: 1000

Lookup entries to create for the version.

note

string · maxLength: 2000

Optional note describing the version.

Create a draft rate-table version › Responses

Created

object · required

POST/rate-tables/{id}/versions

curl --request POST \
  --url https://api.kontorion.eu/v1/rate-tables/:id/versions \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <string>' \
  --data '
{
  "bracket_entries": [
    {
      "range_max": "1000",
      "range_min": "0",
      "value": "49.50"
    }
  ],
  "clone_from_version_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
  "effective_from": "2024-08-25T15:00:00Z",
  "effective_to": "2024-08-25T15:00:00Z",
  "entries": [
    {
      "id": "0f8fad5b-d9cb-469f-a165-70867728950e",
      "lookup_key": "lookup_key",
      "range_max": "49.5",
      "range_min": "49.5",
      "value": "49.5"
    }
  ],
  "lookup_entries": [
    {
      "key": "key",
      "value": "49.50"
    }
  ],
  "note": "note"
}
'

shell

Example Request Body

{
  "bracket_entries": [
    {
      "range_max": "1000",
      "range_min": "0",
      "value": "49.50"
    }
  ],
  "clone_from_version_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
  "effective_from": "2024-08-25T15:00:00Z",
  "effective_to": "2024-08-25T15:00:00Z",
  "entries": [
    {
      "id": "0f8fad5b-d9cb-469f-a165-70867728950e",
      "lookup_key": "lookup_key",
      "range_max": "49.5",
      "range_min": "49.5",
      "value": "49.5"
    }
  ],
  "lookup_entries": [
    {
      "key": "key",
      "value": "49.50"
    }
  ],
  "note": "note"
}

json

Example Responses

{
  "data": {
    "archived_at": "2024-08-25T15:00:00Z",
    "created_at": "2024-08-25T15:00:00Z",
    "currency": "currency",
    "effective_from": "2024-08-25T15:00:00Z",
    "effective_to": "2024-08-25T15:00:00Z",
    "entries": [
      {
        "id": "0f8fad5b-d9cb-469f-a165-70867728950e",
        "lookup_key": "lookup_key",
        "range_max": "49.5",
        "range_min": "49.5",
        "value": "49.5"
      }
    ],
    "id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "note": "note",
    "published_at": "2024-08-25T15:00:00Z",
    "published_by": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "rate_table_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "status": "draft",
    "version": 0
  }
}

json

application/json

Get the currently active rate-table version

GET

https://api.kontorion.eu/v1

/rate-tables/{id}/versions/active

Returns the rate-table version that is active at the current wall-clock time.

Get the currently active rate-table version › path Parameters

id

string · uuid · required

Rate table ID

Get the currently active rate-table version › Headers

X-Workspace-Id

string

Workspace UUID or slug.

Get the currently active rate-table version › Responses

object · required

GET/rate-tables/{id}/versions/active

curl --request GET \
  --url https://api.kontorion.eu/v1/rate-tables/:id/versions/active

shell

Example Responses

{
  "data": {
    "archived_at": "2024-08-25T15:00:00Z",
    "created_at": "2024-08-25T15:00:00Z",
    "currency": "currency",
    "effective_from": "2024-08-25T15:00:00Z",
    "effective_to": "2024-08-25T15:00:00Z",
    "entries": [
      {
        "id": "0f8fad5b-d9cb-469f-a165-70867728950e",
        "lookup_key": "lookup_key",
        "range_max": "49.5",
        "range_min": "49.5",
        "value": "49.5"
      }
    ],
    "id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "note": "note",
    "published_at": "2024-08-25T15:00:00Z",
    "published_by": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "rate_table_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "status": "draft",
    "version": 0
  }
}

json

application/json

Get a rate-table version snapshot

GET

https://api.kontorion.eu/v1

/rate-tables/{id}/versions/{version}

Maps the version number to its version row and returns the full snapshot, including the version's rows and entries.

Get a rate-table version snapshot › path Parameters

id

string · uuid · required

Entity UUID

version

string · required

Version number

Get a rate-table version snapshot › Headers

X-Workspace-Id

string

Workspace UUID or slug.

Get a rate-table version snapshot › Responses

object · required

GET/rate-tables/{id}/versions/{version}

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

shell

Example Responses

{
  "data": {
    "archived_at": "2024-08-25T15:00:00Z",
    "created_at": "2024-08-25T15:00:00Z",
    "currency": "currency",
    "effective_from": "2024-08-25T15:00:00Z",
    "effective_to": "2024-08-25T15:00:00Z",
    "entries": [
      {
        "id": "0f8fad5b-d9cb-469f-a165-70867728950e",
        "lookup_key": "lookup_key",
        "range_max": "49.5",
        "range_min": "49.5",
        "value": "49.5"
      }
    ],
    "id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "note": "note",
    "published_at": "2024-08-25T15:00:00Z",
    "published_by": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "rate_table_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "status": "draft",
    "version": 0
  }
}

json

application/json

Delete a draft rate-table version

DELETE

https://api.kontorion.eu/v1

/rate-tables/{id}/versions/{version}

Hard-deletes a rate-table version, addressed by its version number (the same key GET /rate-tables/{id}/versions/{version} returns). Only allowed on draft versions; active or archived versions are immutable - archive them instead.

Delete a draft rate-table version › path Parameters

id

string · uuid · required

Rate table ID

version

integer · int64 · required

Version number

Delete a draft rate-table version › Headers

X-Workspace-Id

string

Workspace UUID or slug.

Delete a draft rate-table version › Responses

No Content

No data returned

Archive a rate-table version

POST

https://api.kontorion.eu/v1

/rate-tables/{id}/versions/{version}/archive

Terminal transition - archived versions cannot be edited or re-activated, addressed by version number (the same key GET /rate-tables/{id}/versions/{version} returns). Use the copy endpoint to spin a new draft from an archived one.

Archive a rate-table version › path Parameters

id

string · uuid · required

Rate table ID

version

integer · int64 · required

Version number

Archive a rate-table version › Headers

Idempotency-Key

string · required

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

X-Workspace-Id

string

Workspace UUID or slug.

Archive a rate-table version › Responses

No Content

No data returned

Copy a rate-table version into a new draft

POST

https://api.kontorion.eu/v1

/rate-tables/{id}/versions/{version}/copy

Creates a new draft version cloned from the named source (any status), addressed by version number (the same key GET /rate-tables/{id}/versions/{version} returns). Entries are duplicated. Used to revive archived versions or to branch a new edit from an already-active version. Returns 409 while another draft is open - discard or publish it first.

Copy a rate-table version into a new draft › path Parameters

id

string · uuid · required

Rate table ID

version

integer · int64 · required

Source version number

Copy a rate-table version into 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 rate-table version into a new draft › Request Body

effective_from

string · date-time

Effective-from timestamp for the new draft version.

effective_to

string · date-time

Optional effective-to timestamp for the new draft version.

note

string · maxLength: 2000

Optional note for the new draft version.

Copy a rate-table version into a new draft › Responses

Created

object · required

POST/rate-tables/{id}/versions/{version}/copy

curl --request POST \
  --url https://api.kontorion.eu/v1/rate-tables/:id/versions/:version/copy \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <string>' \
  --data '
{
  "effective_from": "2024-08-25T15:00:00Z",
  "effective_to": "2024-08-25T15:00:00Z",
  "note": "note"
}
'

shell

Example Request Body

{
  "effective_from": "2024-08-25T15:00:00Z",
  "effective_to": "2024-08-25T15:00:00Z",
  "note": "note"
}

json

Example Responses

{
  "data": {
    "archived_at": "2024-08-25T15:00:00Z",
    "created_at": "2024-08-25T15:00:00Z",
    "currency": "currency",
    "effective_from": "2024-08-25T15:00:00Z",
    "effective_to": "2024-08-25T15:00:00Z",
    "entries": [
      {
        "id": "0f8fad5b-d9cb-469f-a165-70867728950e",
        "lookup_key": "lookup_key",
        "range_max": "49.5",
        "range_min": "49.5",
        "value": "49.5"
      }
    ],
    "id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "note": "note",
    "published_at": "2024-08-25T15:00:00Z",
    "published_by": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "rate_table_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "status": "draft",
    "version": 0
  }
}

json

application/json

Export rate-table version entries as CSV

GET

https://api.kontorion.eu/v1

/rate-tables/{id}/versions/{version}/export

Streams the version's entries as CSV with columns lookup_key, range_min, range_max, value, addressed by version number (the same key GET /rate-tables/{id}/versions/{version} returns). Suitable for round-tripping back through the import endpoint.

Export rate-table version entries as CSV › path Parameters

id

string · uuid · required

Rate table ID

version

integer · int64 · required

Version number

Export rate-table version entries as CSV › Headers

X-Workspace-Id

string

Workspace UUID or slug.

Export rate-table version entries as CSV › Responses

CSV body

string

Import entries into a draft rate-table version

POST

https://api.kontorion.eu/v1

/rate-tables/{id}/versions/{version}/import

Replaces the draft version's entries with the supplied list (full replace, not merge), addressed by version number (the same key GET /rate-tables/{id}/versions/{version} returns). After importing, the version can be published or scheduled.

Import entries into a draft rate-table version › path Parameters

id

string · uuid · required

Rate table ID

version

integer · int64 · required

Version number

Import entries into a draft rate-table version › Headers

Idempotency-Key

string · required

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

X-Workspace-Id

string

Workspace UUID or slug.

Import entries into a draft rate-table version › Request Body

array | null · maxItems: 1000

Import entries into a draft rate-table version › Responses

object · required

POST/rate-tables/{id}/versions/{version}/import

curl --request POST \
  --url https://api.kontorion.eu/v1/rate-tables/:id/versions/:version/import \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <string>' \
  --data '
{
  "entries": [
    {
      "id": "0f8fad5b-d9cb-469f-a165-70867728950e",
      "lookup_key": "lookup_key",
      "range_max": "49.5",
      "range_min": "49.5",
      "value": "49.5"
    }
  ]
}
'

shell

Example Request Body

{
  "entries": [
    {
      "id": "0f8fad5b-d9cb-469f-a165-70867728950e",
      "lookup_key": "lookup_key",
      "range_max": "49.5",
      "range_min": "49.5",
      "value": "49.5"
    }
  ]
}

json

Example Responses

{
  "data": {
    "archived_at": "2024-08-25T15:00:00Z",
    "created_at": "2024-08-25T15:00:00Z",
    "currency": "currency",
    "effective_from": "2024-08-25T15:00:00Z",
    "effective_to": "2024-08-25T15:00:00Z",
    "entries": [
      {
        "id": "0f8fad5b-d9cb-469f-a165-70867728950e",
        "lookup_key": "lookup_key",
        "range_max": "49.5",
        "range_min": "49.5",
        "value": "49.5"
      }
    ],
    "id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "note": "note",
    "published_at": "2024-08-25T15:00:00Z",
    "published_by": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "rate_table_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "status": "draft",
    "version": 0
  }
}

json

application/json

List rate-table version referrers

GET

https://api.kontorion.eu/v1

/rate-tables/{id}/versions/{version}/referrers

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

List rate-table version referrers › path Parameters

id

string · uuid · required

Entity UUID

version

string · required

Version number (positive integer)

List rate-table 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 rate-table version referrers › Headers

X-Workspace-Id

string

Workspace UUID or slug.

List rate-table version referrers › Responses

array | null · required

object · required

GET/rate-tables/{id}/versions/{version}/referrers

curl --request GET \
  --url https://api.kontorion.eu/v1/rate-tables/: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 rate-table version usage summary

GET

https://api.kontorion.eu/v1

/rate-tables/{id}/versions/{version}/usage

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

Get rate-table version usage summary › path Parameters

id

string · uuid · required

Entity UUID

version

string · required

Version number (positive integer)

Get rate-table version usage summary › Headers

X-Workspace-Id

string

Workspace UUID or slug.

Get rate-table version usage summary › Responses

object · required

Price Formulas Promotions