Zum Hauptinhalt springen
GET
Lines behind one cell of the finance tables

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

metric
enum<string>
erforderlich

The row of the cell.

Verfügbare Optionen:
new,
expansion,
contraction,
lost,
resurrecting,
mrr_bop,
mrr_eop,
one_off,
variable,
cash_collected,
cash_collected_this_month,
cash_collected_other_months,
cash_collected_unassigned,
cash_collected_refund_returned,
cash_refunded,
cash_refunded_refund,
cash_refunded_chargeback,
cash_refunded_payout,
cash_refunded_return_fee,
cash_correction,
cash_net,
receivables_eop,
billed_gross,
billed_net,
status_paid,
status_settled,
status_open,
status_overdue,
status_credited,
status_written_off,
status_overpaid,
cash_in,
cash_out,
cash_in_for_month,
outstanding_eop,
outstanding_not_due_eop,
outstanding_overdue_eop,
owed_to_customers,
forecast_invoice,
accounted_mrr,
billing_gap,
ageing_not_due,
ageing_1_30,
ageing_31_60,
ageing_61_90,
ageing_over_90,
revenue_product,
revenue_customer_product,
revenue_country,
cohort,
churn_reason,
backlog_event,
payment_behaviour,
logo_new,
logo_lost,
restatement,
build_failure
month
string

Month of the cell (YYYY-MM, time zone of the organisation). Required except for ageing_* (as of today), build_failure and the revenue-page metrics, which accept from / to instead.

Beispiel:

"2026-09"

from
string

Revenue-page metrics without month: first month of the range (YYYY-MM).

to
string

Revenue-page metrics without month: last month of the range (YYYY-MM).

currency
string

ISO-4217 code of one of the organisation's currencies. Default: the default currency.

scope
enum<string>

Movement scope. Default: the organisation setting.

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

Movement metrics: only the share of these reasons (comma-separated, e.g. discount_start,discount_end,discount_change).

productId
string<uuid>

Revenue-page cell: the product (revenue_product without it selects positions without product).

customerId
string<uuid>

Revenue-page cell: the customer (revenue_customer_product).

countryCode
string

Revenue-page cell: the country (revenue_country, ISO 3166-1 alpha-2; none or omitted selects positions without country).

segmentId
string<uuid>

Analytics segment filter of the page.

customerIds[]
string<uuid>[]

Customer filter of the page.

productIds[]
string<uuid>[]

Product filter of the page.

Free text over customer name and number, subscription, item, product and invoice number.

Maximum string length: 100
groupBy
enum<string>

Revenue metrics only (one_off, variable, revenue_*): document groups the lines by the invoice they belong to (the invoice with its cancellations and credit notes) and pages over groups.

Verfügbare Optionen:
document
cancellationReason
string

lost with reason=contract_end: only contract ends with this cancellation reason code (none: without one). churn_reason: the churn-by-reason entry (a code, none, pause or voided).

cohortMonth
string

cohort (required): first month of the cohort (YYYY-MM).

age
integer

cohort (required): months since the cohort month.

Erforderlicher Bereich: x >= 0
paymentMethod
string

payment_behaviour: payment method type (sepa_debit, bank_transfer, card, …). Default: every method.

eventKind
enum<string>

backlog_event: only this kind of known change.

Verfügbare Optionen:
end,
price,
discount_end,
ramp,
trial_end,
start,
other
part
enum<string>

cash_correction: one side of the correction pairs, reversed (the cancelled entries, positive) or counter (the counter-entries, negative). Default: both. Only with metric=cash_correction; with any other metric the answer is 422 at part with code analytics.mrr_financials.part_correction_only.

Verfügbare Optionen:
reversed,
counter
cell
string

restatement: only the findings of this restated figure (mrr_eop, lost_mrr, reasons.<movement>.<reason>, …).

page
integer
Standard:1

Page, starting at 1.

Erforderlicher Bereich: x >= 1
pageSize
integer
Standard:25

Lines per page.

Erforderlicher Bereich: 1 <= x <= 200

Antwort

One page of lines, with groupBy=document one page of document groups, for restatement one page of findings with explanations.

One page of the lines behind a cell.

data
object[]

Lines of this page.

meta
object

Pagination, the sum over all lines and the calculation time.