Zum Hauptinhalt springen
GET
Finance overview datasets

Autorisierungen

Authorization
string
header
erforderlich

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

Abfrageparameter

from
string

First month (YYYY-MM, time zone of the organisation). Default: to minus 11 months.

to
string

Last month (YYYY-MM). Default: the current month. At most 36 months.

currency
string

ISO-4217 code. Default: the default currency.

scope
enum<string>

Movement scope of mrrMovements. Default: the organisation setting.

Verfügbare Optionen:
subscription,
invoice_address,
customer,
organisation
segmentId
string<uuid>

Analytics segment filter.

customerIds[]
string<uuid>[]

Customer filter.

productIds[]
string<uuid>[]

Product filter (MRR movements and revenue).

Antwort

The datasets.

Datasets of the finance overview: cash flow, MRR movements, revenue by class, receivables at each month end, ageing of open invoices today, and the receivables table. Every series is aligned with months.

months
string[]

Months of the range (YYYY-MM, time zone of the organisation), ascending.

cashflow
object

Collected, refunded and net cash per month (by payment date; null after the current month) and the invoice forecast ("Rechnungsprognose", gross by invoice month; null before the current month). Collected counts settled payments (status captured, booked, refunded, partial_refunded).

mrrMovements
object

MRR movements per month, signed: contraction and lost are negative.

revenueBreakdown
object

Billed net revenue per month by class (net = gross − tax, after position discounts; credit notes negative).

receivablesTrend
object[]

Outstanding receivables at each month end. Months after the current one carry the invoices open today forward (no payment assumed).

receivablesTrendOverdue
object[]

Part of receivablesTrend overdue at each month end (due date before the last day of the month); the rest is not yet due.

ageing
object

Open invoices today by days past due.

receivablesTable
object

Receivables table: per invoice month the billed amounts, the status of those invoices today, cash in and out, and the outstanding amount at the month end.

totals
object

Totals over the range: cash_collected, cash_refunded, cash_net (elapsed and current months), cash_forecast (invoice forecast, gross, current and later months), recurring, one_off, variable, revenue_total, new, expansion, contraction, lost, resurrecting (contraction and lost negative).

meta
object

Calculation time, effective scope and currency, finding counts, datasets that ignore the filter.