RateTables

Endpointhttps://api.kontorion.eu/v1

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 › Responses

List of rate tables

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 › Request Body

default_value

string

description

string

name

string

on_missing_key

string

requires_continuous_coverage

boolean

slug

string

table_type

string

Create a rate table › Responses

Created rate table

created_at

string

default_value

string

deleted_at

string

description

string

head_version_id

string

id

string

lifecycle_status

string

draft | active | archived

name

string

on_missing_key

string

error | zero | default_value

organization_id

string

requires_continuous_coverage

boolean

slug

string

table_type

string

lookup | bracket

updated_at

string

POST/rate-tables

curl --request POST \
  --url https://api.kontorion.eu/v1/rate-tables \
  --header 'Content-Type: application/json' \
  --data '
{
  "default_value": "default_value",
  "description": "description",
  "name": "name",
  "on_missing_key": "on_missing_key",
  "requires_continuous_coverage": true,
  "slug": "slug",
  "table_type": "table_type"
}
'

shell

Example Request Body

{
  "default_value": "default_value",
  "description": "description",
  "name": "name",
  "on_missing_key": "on_missing_key",
  "requires_continuous_coverage": true,
  "slug": "slug",
  "table_type": "table_type"
}

json

Example Responses

{
  "created_at": "created_at",
  "default_value": "default_value",
  "deleted_at": "deleted_at",
  "description": "description",
  "head_version_id": "head_version_id",
  "id": "id",
  "lifecycle_status": "lifecycle_status",
  "name": "name",
  "on_missing_key": "on_missing_key",
  "organization_id": "organization_id",
  "requires_continuous_coverage": true,
  "slug": "slug",
  "table_type": "table_type",
  "updated_at": "updated_at"
}

json

application/json

Get a rate table

GET

https://api.kontorion.eu/v1

/rate-tables/{id}

Returns a single rate table by ID, scoped to the caller's organization.

Get a rate table › path Parameters

id

string · required

Rate table ID

Get a rate table › Responses

Rate table

created_at

string

default_value

string

deleted_at

string

description

string

head_version_id

string

id

string

lifecycle_status

string

draft | active | archived

name

string

on_missing_key

string

error | zero | default_value

organization_id

string

requires_continuous_coverage

boolean

slug

string

table_type

string

lookup | bracket

updated_at

string

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 · required

Rate table ID

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.). Version data is mutated through the version sub-routes.

Update a rate table › path Parameters

id

string · required

Rate table ID

Update a rate table › Request Body

default_value

string

description

string

effective_at

string

ADR-0006 edit-as-publish controls.

name

string

on_missing_key

string

requires_continuous_coverage

boolean

save_as_draft

boolean

Update a rate table › Responses

Updated rate table

created_at

string

default_value

string

deleted_at

string

description

string

head_version_id

string

id

string

lifecycle_status

string

draft | active | archived

name

string

on_missing_key

string

error | zero | default_value

organization_id

string

requires_continuous_coverage

boolean

slug

string

table_type

string

lookup | bracket

updated_at

string

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": "effective_at",
  "name": "name",
  "on_missing_key": "on_missing_key",
  "requires_continuous_coverage": true,
  "save_as_draft": true
}
'

shell

Example Request Body

{
  "default_value": "default_value",
  "description": "description",
  "effective_at": "effective_at",
  "name": "name",
  "on_missing_key": "on_missing_key",
  "requires_continuous_coverage": true,
  "save_as_draft": true
}

json

Example Responses

{
  "created_at": "created_at",
  "default_value": "default_value",
  "deleted_at": "deleted_at",
  "description": "description",
  "head_version_id": "head_version_id",
  "id": "id",
  "lifecycle_status": "lifecycle_status",
  "name": "name",
  "on_missing_key": "on_missing_key",
  "organization_id": "organization_id",
  "requires_continuous_coverage": true,
  "slug": "slug",
  "table_type": "table_type",
  "updated_at": "updated_at"
}

json

application/json

Archive a rate table

POST

https://api.kontorion.eu/v1

/rate-tables/{id}/archive

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

Archive a rate table › path Parameters

id

string · required

Rate table ID

Archive a rate table › Responses

No content

No data returned

List rate-table versions (with lifecycle filter)

GET

https://api.kontorion.eu/v1

/rate-tables/{id}/versions

List rate-table versions (with lifecycle filter) › path Parameters

id

string · required

Rate table UUID

List rate-table versions (with lifecycle filter) › query Parameters

status

string[] · style: form

Lifecycle status filter (repeatable)

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

200

object[]

archived_reason

string

created_at

string

created_by

string

effective_from

string

effective_to

string

id

string

ID is the *_versions.id UUID. Phase 2.D needs it so the FE stage-mode chip can wire selection→pin map without a separate number→ID lookup; older clients can ignore the field.

published_at

string

status

string

usage_count

integer

version

integer

object[]

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.

Create a draft rate-table version › path Parameters

id

string · required

Rate table ID

Create a draft rate-table version › Request Body

object[]

clone_from_version_id

string

effective_from

string

effective_to

string

object[]

note

string

Create a draft rate-table version › Responses

Created draft version

archived_at

string

created_at

string

effective_from

string

effective_to

string

object[]

id

string

note

string

published_at

string

published_by

string

rate_table_id

string

status

string

draft | active | archived

version

integer

POST/rate-tables/{id}/versions

curl --request POST \
  --url https://api.kontorion.eu/v1/rate-tables/:id/versions \
  --header 'Content-Type: application/json' \
  --data '
{
  "bracket_entries": [
    {
      "range_max": 0,
      "range_min": 0,
      "value": 0
    }
  ],
  "clone_from_version_id": "clone_from_version_id",
  "effective_from": "effective_from",
  "effective_to": "effective_to",
  "entries": [
    {
      "id": "id",
      "lookup_key": "lookup_key",
      "range_max": 0,
      "range_min": 0,
      "value": 0
    }
  ],
  "lookup_entries": [
    {
      "key": "key",
      "value": 0
    }
  ],
  "note": "note"
}
'

shell

Example Request Body

{
  "bracket_entries": [
    {
      "range_max": 0,
      "range_min": 0,
      "value": 0
    }
  ],
  "clone_from_version_id": "clone_from_version_id",
  "effective_from": "effective_from",
  "effective_to": "effective_to",
  "entries": [
    {
      "id": "id",
      "lookup_key": "lookup_key",
      "range_max": 0,
      "range_min": 0,
      "value": 0
    }
  ],
  "lookup_entries": [
    {
      "key": "key",
      "value": 0
    }
  ],
  "note": "note"
}

json

Example Responses

{
  "archived_at": "archived_at",
  "created_at": "created_at",
  "effective_from": "effective_from",
  "effective_to": "effective_to",
  "entries": [
    {
      "id": "id",
      "lookup_key": "lookup_key",
      "range_max": 0,
      "range_min": 0,
      "value": 0
    }
  ],
  "id": "id",
  "note": "note",
  "published_at": "published_at",
  "published_by": "published_by",
  "rate_table_id": "rate_table_id",
  "status": "status",
  "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. Useful for clients that just want "the prices in effect right now".

Get the currently active rate-table version › path Parameters

id

string · required

Rate table ID

Get the currently active rate-table version › Responses

Active rate-table version

archived_at

string

created_at

string

effective_from

string

effective_to

string

object[]

id

string

note

string

published_at

string

published_by

string

rate_table_id

string

status

string

draft | active | archived

version

integer

Get a rate-table version snapshot

GET

https://api.kontorion.eu/v1

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

Get a rate-table version snapshot › path Parameters

id

string · required

Rate table UUID

version

integer · required

Version number

Get a rate-table version snapshot › Responses

200

archived_at

string

created_at

string

effective_from

string

effective_to

string

object[]

id

string

note

string

published_at

string

published_by

string

rate_table_id

string

status

string

draft | active | archived

version

integer

Delete a draft rate-table version

DELETE

https://api.kontorion.eu/v1

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

Hard-deletes a rate-table version. Only allowed on draft versions; active or archived versions are immutable - archive them instead.

Delete a draft rate-table version › path Parameters

id

string · required

Rate table ID

vid

string · required

Rate-table version ID

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/{vid}/archive

Terminal transition - archived versions cannot be edited or re-activated. Use CopyVersion to spin a new draft from an archived one.

Archive a rate-table version › path Parameters

id

string · required

Rate table ID

vid

string · required

Rate-table version ID

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/{vid}/copy

Creates a new draft version cloned from the named source (any status). Entries are duplicated. Used to revive archived versions or to branch a new edit from an already-active version.

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

id

string · required

Rate table ID

vid

string · required

Source rate-table version ID

Copy a rate-table version into a new draft › Request Body

effective_from

string

effective_to

string

note

string

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

New draft version

archived_at

string

created_at

string

effective_from

string

effective_to

string

object[]

id

string

note

string

published_at

string

published_by

string

rate_table_id

string

status

string

draft | active | archived

version

integer

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

curl --request POST \
  --url https://api.kontorion.eu/v1/rate-tables/:id/versions/:vid/copy \
  --header 'Content-Type: application/json' \
  --data '
{
  "effective_from": "effective_from",
  "effective_to": "effective_to",
  "note": "note"
}
'

shell

Example Request Body

{
  "effective_from": "effective_from",
  "effective_to": "effective_to",
  "note": "note"
}

json

Example Responses

{
  "archived_at": "archived_at",
  "created_at": "created_at",
  "effective_from": "effective_from",
  "effective_to": "effective_to",
  "entries": [
    {
      "id": "id",
      "lookup_key": "lookup_key",
      "range_max": 0,
      "range_min": 0,
      "value": 0
    }
  ],
  "id": "id",
  "note": "note",
  "published_at": "published_at",
  "published_by": "published_by",
  "rate_table_id": "rate_table_id",
  "status": "status",
  "version": 0
}

json

application/json

Export rate-table version entries as CSV

GET

https://api.kontorion.eu/v1

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

Streams the version's entries as CSV with columns lookup_key, range_min, range_max, value. Suitable for round-tripping back through ImportEntries.

Export rate-table version entries as CSV › path Parameters

id

string · required

Rate table ID

vid

string · required

Rate-table version ID

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/{vid}/import

Replaces the draft version's entries with the supplied list (full replace, not merge). After importing, the version can be published or scheduled.

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

id

string · required

Rate table ID

vid

string · required

Rate-table version ID

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

object[]

Import entries into a draft rate-table version › Responses

Updated version with imported entries

archived_at

string

created_at

string

effective_from

string

effective_to

string

object[]

id

string

note

string

published_at

string

published_by

string

rate_table_id

string

status

string

draft | active | archived

version

integer

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

curl --request POST \
  --url https://api.kontorion.eu/v1/rate-tables/:id/versions/:vid/import \
  --header 'Content-Type: application/json' \
  --data '
{
  "entries": [
    {
      "id": "id",
      "lookup_key": "lookup_key",
      "range_max": 0,
      "range_min": 0,
      "value": 0
    }
  ]
}
'

shell

Example Request Body

{
  "entries": [
    {
      "id": "id",
      "lookup_key": "lookup_key",
      "range_max": 0,
      "range_min": 0,
      "value": 0
    }
  ]
}

json

Example Responses

{
  "archived_at": "archived_at",
  "created_at": "created_at",
  "effective_from": "effective_from",
  "effective_to": "effective_to",
  "entries": [
    {
      "id": "id",
      "lookup_key": "lookup_key",
      "range_max": 0,
      "range_min": 0,
      "value": 0
    }
  ],
  "id": "id",
  "note": "note",
  "published_at": "published_at",
  "published_by": "published_by",
  "rate_table_id": "rate_table_id",
  "status": "status",
  "version": 0
}

json

application/json

Scheduling/Promotions Roles