Currencies

Endpointhttps://api.kontorion.eu/v1

Workspace currency allowlist: which currencies are enabled for billing and catalog use.

List workspace currencies

GET

https://api.kontorion.eu/v1

/currencies

Returns the currencies enabled for the active workspace, including reference counts to plans, prices and other entities.

List workspace currencies › 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 workspace currencies › Responses

array | null · required

object · required

GET/currencies

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

shell

Example Responses

{
  "data": [
    {
      "billing_enabled": true,
      "catalog_enabled": true,
      "created_at": "2024-08-25T15:00:00Z",
      "currency_code": "currency_code",
      "references": {
        "costs": 0,
        "credit_notes": 0,
        "customers": 0,
        "invoices": 0,
        "prices": 0,
        "subscriptions": 0,
        "total": 0,
        "wallets": 0
      },
      "updated_at": "2024-08-25T15:00:00Z",
      "workspace_id": "0f8fad5b-d9cb-469f-a165-70867728950e"
    }
  ],
  "pagination": {
    "counts": {
      "key": {
        "key": 0
      }
    },
    "cursor": "cursor",
    "has_more": true,
    "total_count": 0
  }
}

json

application/json

Enable a currency for the workspace

POST

https://api.kontorion.eu/v1

/currencies

Adds a currency (3-letter ISO 4217 code) to the workspace's allowlist.

Enable a currency for the workspace › 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.

Enable a currency for the workspace › Request Body

billing_enabled

boolean

Enable billing/invoicing in this currency; at least one of billing_enabled or catalog_enabled must be true.

catalog_enabled

boolean

Enable price/cost authoring in this currency; at least one of billing_enabled or catalog_enabled must be true.

currency_code

string

ISO 4217 currency code to enable (normalized to uppercase).

Enable a currency for the workspace › Responses

Created

object · required

POST/currencies

curl --request POST \
  --url https://api.kontorion.eu/v1/currencies \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <string>' \
  --data '
{
  "billing_enabled": true,
  "catalog_enabled": true,
  "currency_code": "currency_code"
}
'

shell

Example Request Body

{
  "billing_enabled": true,
  "catalog_enabled": true,
  "currency_code": "currency_code"
}

json

Example Responses

{
  "data": {
    "billing_enabled": true,
    "catalog_enabled": true,
    "created_at": "2024-08-25T15:00:00Z",
    "currency_code": "currency_code",
    "references": {
      "costs": 0,
      "credit_notes": 0,
      "customers": 0,
      "invoices": 0,
      "prices": 0,
      "subscriptions": 0,
      "total": 0,
      "wallets": 0
    },
    "updated_at": "2024-08-25T15:00:00Z",
    "workspace_id": "0f8fad5b-d9cb-469f-a165-70867728950e"
  }
}

json

application/json

Get a workspace currency

GET

https://api.kontorion.eu/v1

/currencies/{code}

Returns one allowlist entry by ISO 4217 code, reference counts included - the same shape the list returns. Codes not on the workspace allowlist respond 404.

Get a workspace currency › path Parameters

code

string · required

ISO 4217 currency code (uppercase)

Get a workspace currency › Headers

X-Workspace-Id

string

Workspace UUID or slug.

Get a workspace currency › Responses

object · required

Remove a currency from the workspace allowlist

DELETE

https://api.kontorion.eu/v1

/currencies/{code}

Permanently removes the currency from the workspace's allowlist (a hard remove, not a disable - use PATCH to disable a scope). Fails with 409 while the currency is still referenced by customers, wallets, invoices, credit notes, subscriptions, prices or costs; the guard and the delete run in one transaction.

Remove a currency from the workspace allowlist › path Parameters

code

string · required

ISO 4217 currency code (uppercase)

Remove a currency from the workspace allowlist › Headers

X-Workspace-Id

string

Workspace UUID or slug.

Remove a currency from the workspace allowlist › Responses

No Content

No data returned

Update a workspace currency's scopes

PATCH

https://api.kontorion.eu/v1

/currencies/{code}

Toggles which scopes the currency is enabled for: billing_enabled (invoices, wallets, subscriptions) and/or catalog_enabled (prices, costs). At least one scope must remain enabled; to remove the currency entirely use DELETE.

Update a workspace currency's scopes › path Parameters

code

string · required

ISO 4217 currency code (uppercase)

Update a workspace currency's scopes › Headers

X-Workspace-Id

string

Workspace UUID or slug.

Update a workspace currency's scopes › Request Body

billing_enabled

boolean

New billing-enabled setting; omitted leaves it unchanged. At least one of the two fields must be supplied.

catalog_enabled

boolean

New catalog-enabled setting; omitted leaves it unchanged. At least one of the two fields must be supplied.

Update a workspace currency's scopes › Responses

object · required

PATCH/currencies/{code}

curl --request PATCH \
  --url https://api.kontorion.eu/v1/currencies/:code \
  --header 'Content-Type: application/json' \
  --data '
{
  "billing_enabled": true,
  "catalog_enabled": true
}
'

shell

Example Request Body

{
  "billing_enabled": true,
  "catalog_enabled": true
}

json

Example Responses

{
  "data": {
    "billing_enabled": true,
    "catalog_enabled": true,
    "created_at": "2024-08-25T15:00:00Z",
    "currency_code": "currency_code",
    "references": {
      "costs": 0,
      "credit_notes": 0,
      "customers": 0,
      "invoices": 0,
      "prices": 0,
      "subscriptions": 0,
      "total": 0,
      "wallets": 0
    },
    "updated_at": "2024-08-25T15:00:00Z",
    "workspace_id": "0f8fad5b-d9cb-469f-a165-70867728950e"
  }
}

json

application/json

Invoice Templates FX

List workspace currencies

GET

https://api.kontorion.eu/v1

/currencies

Returns the currencies enabled for the active workspace, including reference counts to plans, prices and other entities.

List workspace currencies › Headers

X-Workspace-Id

string

Workspace UUID or slug.

List workspace currencies › Responses

array | null · required

object · required

Enable a currency for the workspace

POST

https://api.kontorion.eu/v1

/currencies

Adds a currency (3-letter ISO 4217 code) to the workspace's allowlist.

Enable a currency for the workspace › Headers

Idempotency-Key

string · required

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

X-Workspace-Id

string

Workspace UUID or slug.

Enable a currency for the workspace › Request Body

billing_enabled

boolean

Enable billing/invoicing in this currency; at least one of billing_enabled or catalog_enabled must be true.

catalog_enabled

boolean

Enable price/cost authoring in this currency; at least one of billing_enabled or catalog_enabled must be true.

currency_code

string

ISO 4217 currency code to enable (normalized to uppercase).

Enable a currency for the workspace › Responses

Created

object · required

Get a workspace currency

GET

https://api.kontorion.eu/v1

/currencies/{code}

Returns one allowlist entry by ISO 4217 code, reference counts included - the same shape the list returns. Codes not on the workspace allowlist respond 404.

Get a workspace currency › path Parameters

code

string · required

ISO 4217 currency code (uppercase)

Get a workspace currency › Headers

X-Workspace-Id

string

Workspace UUID or slug.

Get a workspace currency › Responses

object · required

Remove a currency from the workspace allowlist

DELETE

https://api.kontorion.eu/v1

/currencies/{code}

Remove a currency from the workspace allowlist › path Parameters

code

string · required

ISO 4217 currency code (uppercase)

Remove a currency from the workspace allowlist › Headers

X-Workspace-Id

string

Workspace UUID or slug.

Remove a currency from the workspace allowlist › Responses

No Content

No data returned

Update a workspace currency's scopes

PATCH

https://api.kontorion.eu/v1

/currencies/{code}

Update a workspace currency's scopes › path Parameters

code

string · required

ISO 4217 currency code (uppercase)

Update a workspace currency's scopes › Headers

X-Workspace-Id

string

Workspace UUID or slug.

Update a workspace currency's scopes › Request Body

billing_enabled

boolean

New billing-enabled setting; omitted leaves it unchanged. At least one of the two fields must be supplied.

catalog_enabled

boolean

New catalog-enabled setting; omitted leaves it unchanged. At least one of the two fields must be supplied.

Update a workspace currency's scopes › Responses

object · required