Interactive Playground credentials

Enter your Console OAuth credentials to test API requests in the playground below. Select OmaxTelecom Client Credentials as the auth identity before sending.

Client IDClient Secret

Telkor API

Organization

Download schema

Organisation profile and account data — view your tenant info, latest balance snapshot, and monthly cost breakdown.

Get your organisation

GET

https://api.omaxtelecom.com/telkor

/org

Return your organisation's basic info.

Resolved from the JWT — no body, no parameters. Useful for confirming which tenant the current token is bound to and for referencing the org id in support tickets.

Get your organisation › Responses

Successful Response

Customer-visible view of the caller's own organisation. Returned by `GET /org`. Trimmed down from the superadmin `OrganizationResponse`: `keycloak_org_id` and the `settings` block (provider integration config) are hidden — neither is actionable from the customer side.

CallerOrganizationResponse

id

string · uuid · required

Internal identifier for your organisation. Useful when contacting support.

Example: 8a4b6df0-aaaa-bbbb-cccc-ddddeeeeffff

name

string · required

Human-readable display name.

Example: Speakeasy

created_at

string · date-time · required

UTC timestamp the organisation was created.

Example: 2026-01-15 08:30:00+00:00

updated_at

string · date-time · required

UTC timestamp the organisation was last updated.

Example: 2026-04-20 11:42:00+00:00

Get your latest balance snapshot

GET

https://api.omaxtelecom.com/telkor

/org/balance

Return the most recently collected main-account balance.

Balances are an append-only ledger refreshed by a background worker every ~3 hours, with a skip-unchanged rule — so two snapshots with different collected_at reflect a real movement. Until the first collection runs, this endpoint returns 404.

Get your latest balance snapshot › Responses

Successful Response

Latest balance snapshot for an organisation. Reads the most recently collected `BalanceSnapshot` from the ledger (populated periodically by the `collect_balances` worker, ~every 3h). `amount` is in whole EUR — BICS reports `maBalance` in centi-EUR and we normalise at the BICS boundary, so consumers see real currency units here.

OrganizationBalanceResponse

organization_id

string · uuid · required

Internal identifier of the organisation this balance belongs to.

Example: 8a4b6df0-aaaa-bbbb-cccc-ddddeeeeffff

amount

string · pattern: ^(?!^[-+.]*$)[+-]?0*… · required

Current main-account balance in whole currency units (EUR for all current deployments). May carry sub-cent precision.

Example: 1099.9548

currency

string · required

ISO 4217 currency code reported by the provider.

Example: EUR

collected_at

string · date-time · required

UTC timestamp the snapshot was observed. Snapshots are append-only and skip-unchanged — gaps between timestamps indicate stretches where the balance didn't move.

Example: 2026-05-25 08:00:00+00:00

Get your latest monthly cost snapshot

GET

https://api.omaxtelecom.com/telkor

/org/cost

Return the latest collected cost snapshot for the given month.

Snapshots are append-only — the collect_costs worker writes a new row on every run (every 3h) once costs have started accruing. This endpoint always returns the most recent snapshot for the requested (year, month); 404 until the worker has collected at least one row for that month.

Fees in the response are org-wide totals; per-operator attribution lives inside usage_lines.

Get your latest monthly cost snapshot › query Parameters

year

integer · min: 2000 · max: 9999 · required

Year (4-digit).

month

integer · min: 1 · max: 12 · required

Month (1-12).

Get your latest monthly cost snapshot › Responses

Successful Response

Latest monthly cost snapshot for an organisation. Snapshots are append-only — the collector runs every 3h and may write multiple snapshots per `(year, month)` as the month progresses. This response is always the most recent one collected for the given `(year, month)`. Flat fees are org-wide totals; per-operator attribution lives in `usage_lines`.

OrganizationCostResponse

organization_id

string · uuid · required

Identifier of the organisation this snapshot belongs to.

year

integer · required

Year the snapshot covers.

Example: 2026

month

integer · min: 1 · max: 12 · required

Month the snapshot covers (1-12).

Example: 5

collected_at

string · date-time · required

UTC timestamp the snapshot was observed at the provider.

ISO 4217 currency code for all amounts. Typically EUR.

Example: EUR

CostUsageLineResponse-Output[]

Per-service usage breakdown with operator attribution.

GET/org/cost

curl 'https://api.omaxtelecom.com/telkor/org/cost?year=<number>&month=<number>' \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "collected_at": "2026-05-25 09:00:00+00:00",
  "currency": "EUR",
  "month": 5,
  "organization_id": "8a4b6df0-aaaa-bbbb-cccc-ddddeeeeffff",
  "sim_activation_fee": "10.00",
  "sim_monthly_active_fee": "120.00",
  "usage_lines": [
    {
      "amount": "12.34",
      "operators": [
        {
          "compatibility_zone": "magenta",
          "country": "DEU",
          "id": "0a1b2c3d-1111-2222-3333-444455556666",
          "name": "Vodafone DE",
          "tadig": "DEUD2"
        }
      ],
      "service_name": "DATA",
      "usage": "1024.50"
    }
  ],
  "year": 2026
}

json

application/json

Tasks

Get your organisation

GET

https://api.omaxtelecom.com/telkor

/org

Return your organisation's basic info.

Resolved from the JWT — no body, no parameters. Useful for confirming which tenant the current token is bound to and for referencing the org id in support tickets.

Get your organisation › Responses

Successful Response

CallerOrganizationResponse

id

string · uuid · required

Internal identifier for your organisation. Useful when contacting support.

Example: 8a4b6df0-aaaa-bbbb-cccc-ddddeeeeffff

name

string · required

Human-readable display name.

Example: Speakeasy

created_at

string · date-time · required

UTC timestamp the organisation was created.

Example: 2026-01-15 08:30:00+00:00

updated_at

string · date-time · required

UTC timestamp the organisation was last updated.

Example: 2026-04-20 11:42:00+00:00

Get your latest balance snapshot

GET

https://api.omaxtelecom.com/telkor

/org/balance

Return the most recently collected main-account balance.

Get your latest balance snapshot › Responses

Successful Response

OrganizationBalanceResponse

organization_id

string · uuid · required

Internal identifier of the organisation this balance belongs to.

Example: 8a4b6df0-aaaa-bbbb-cccc-ddddeeeeffff

amount

string · pattern: ^(?!^[-+.]*$)[+-]?0*… · required

Current main-account balance in whole currency units (EUR for all current deployments). May carry sub-cent precision.

Example: 1099.9548

currency

string · required

ISO 4217 currency code reported by the provider.

Example: EUR

collected_at

string · date-time · required

UTC timestamp the snapshot was observed. Snapshots are append-only and skip-unchanged — gaps between timestamps indicate stretches where the balance didn't move.

Example: 2026-05-25 08:00:00+00:00

Get your latest monthly cost snapshot

GET

https://api.omaxtelecom.com/telkor

/org/cost

Return the latest collected cost snapshot for the given month.

Fees in the response are org-wide totals; per-operator attribution lives inside usage_lines.

Get your latest monthly cost snapshot › query Parameters

year

integer · min: 2000 · max: 9999 · required

Year (4-digit).

month

integer · min: 1 · max: 12 · required

Month (1-12).

Get your latest monthly cost snapshot › Responses

Successful Response

OrganizationCostResponse

organization_id

string · uuid · required

Identifier of the organisation this snapshot belongs to.

year

integer · required

Year the snapshot covers.

Example: 2026

month

integer · min: 1 · max: 12 · required

Month the snapshot covers (1-12).

Example: 5

collected_at

string · date-time · required

UTC timestamp the snapshot was observed at the provider.

ISO 4217 currency code for all amounts. Typically EUR.

Example: EUR

CostUsageLineResponse-Output[]

Per-service usage breakdown with operator attribution.