Zum Hauptinhalt springen
GET
Frozen MRR figures of a snapshot

Autorisierungen

Authorization
string
header
erforderlich

API token of the organisation. Send it as Authorization: Bearer api_... The token is bound to exactly one organisation.

Pfadparameter

month
string
erforderlich

Month (YYYY-MM).

Pattern: (19|20)\d{2}-(0[1-9]|1[0-2])
Beispiel:

"2026-08"

version
integer
erforderlich

Snapshot version.

Erforderlicher Bereich: x >= 1

Abfrageparameter

currency
string

ISO-4217 code. Default: the default currency.

scope
enum<string>

Movement scope. Default: the organisation setting.

Verfügbare Optionen:
subscription,
invoice_address,
customer,
organisation

Antwort

The frozen figures.

The MRR figures of a month-end snapshot and of the snapshots of the eleven months before it, in the shapes of the live datasets. A month without any snapshot shows the current calculation and is marked in frozen; besides those months only restatements are read from the live calculation.

snapshot
object

The snapshot.

tenantName
string

Name of the organisation.

currency
string

Currency (ISO-4217).

scope
enum<string>

Movement scope.

Verfügbare Optionen:
subscription,
invoice_address,
customer,
organisation
months
string[]

The twelve months ending with the snapshot month (YYYY-MM).

versions
(integer | null)[]

Snapshot version used per month (the latest one taken until the snapshot); null when the month has none.

kpis
object[]

MRR, ARR, net new MRR, quick ratio, NRR, GRR, active accounts, ARPA.

movementMonths
object[]

Bridge per month (every month with figures; see frozen).

cohorts
object[]

Cohort triangle of the twelve months.

logos
object[]

Account movements per month (every month with figures; see frozen).

retention
object[]

NRR and GRR per month (every month with figures; see frozen).

concentration
object

Concentration at the snapshot month end.

churnReasons
object

Lost MRR of the snapshot month by cancellation reason.

backlog
object

Committed MRR at the snapshot month end. forward holds that month only and events is empty: forward events are not snapshotted.

restatements
object[]

Changes found since the snapshot (latest calculation against the latest version of the month).

mrrRows
object

MRR table rows of the snapshot, aligned with months (null: the month has no snapshot): mrr_bop, mrr_eop, new, expansion, contraction, lost, resurrecting as money, arr_eop (MRR × 12) as money, revenue_churn_rate and mom_growth as exact rates at scale 6, derived from the snapshot with the formulas of the live table.

notSnapshotted
string[]

MRR table rows a snapshot does not hold (invoice, cash and forecast figures); a snapshot view shows their current values.

frozen
boolean[]

Per month of months: true when the month's MRR figures come from a snapshot, false when the month has no snapshot at all and shows the current calculation ("nicht eingefroren").

moneyFrozen
boolean[]

Per month of months: true when the month's money figures (cash in and out, receivables, DSO) are frozen with its snapshot (snapshots taken since 28.09.2026); false: the month shows the current calculation for these figures.

money
(object | null)[]

Per month of months: the money figures frozen with the month's snapshot; null where moneyFrozen is false.

The money figures of one month as frozen with its snapshot: cash in and out, net cash, receivables at the month end (decimal amounts in the dataset currency) and DSO (days).

accountingClosed
(boolean | null)[]

Per month of months: whether the month was closed in accounting when its snapshot was taken; null where the month has no snapshot or its snapshot predates 28.09.2026.

findings
object[] | null

Finding counts of the calculation the snapshot was taken from; null for a snapshot taken before 28.09.2026.