Zum Hauptinhalt springen
GET
Revenue page 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 (committed ARR is scope-independent; accepted for a uniform query).

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

Analytics segment filter.

customerIds[]
string<uuid>[]

Customer filter.

productIds[]
string<uuid>[]

Product filter.

page
integer
Standard:1

byCustomerAndProduct only: page, starting at 1.

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

byCustomerAndProduct only: customers per page.

Erforderlicher Bereich: 1 <= x <= 100

byCustomerAndProduct only: customer name, customer number or the name of one of the customer's products contains this text (case-insensitive, % and _ are literal).

Maximum string length: 100

Antwort

The datasets.

Datasets of the revenue page: revenue by country, ARR at each month end (MRR × 12, the one ARR of every page) with the trailing twelve-month variable revenue as its own row, per-currency ARR details, invoiced revenue per month by class ("Umsatzdetails", reconciling to the revenue by country and by product), revenue by product, top products, and revenue per customer with product sub-rows. Revenue is invoiced net revenue of all classes (net = gross − tax after position discounts) by finalization month; credit notes and cancellations are negative in the month they were issued. Dunning fees are not revenue.

months
string[]

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

byCountry
object[]

Net revenue per country of the invoice address in the range, largest first. countryCode is null when no country is known.

arrAtPeriodEnd
object

ARR at each month end in the selected currency (MRR × 12) and the trailing twelve-month variable revenue.

details
object[]

ARR and the trailing twelve-month variable revenue per currency the organisation has data in.

byProduct
object[]

Net revenue per product and month; the product is null for positions without product.

topProducts
object[]

The ten products with the most net revenue in the range.

byCustomerAndProduct
object

Page 1 (or the requested page) of the customer rows with product sub-rows and sparklines, as {data, meta}. Page turns should use GET /api/analytics/finance/revenue/customers, which returns the same shape without recomputing the other datasets.

totals
object

Totals over the range: net (all revenue).

meta
object

Calculation time, effective scope and currency, finding counts.

accountingClosed
boolean[]

Per month of months: the month's postings are closed in accounting (the ledger of the month is final). The analytics figures follow the source dates (finalization, payment and settlement date, service period) and can still change after the close; a record made after the close is a POST_CLOSE_CHANGE finding.

revenueDetails
object[]

Invoiced net revenue per month by class ("Umsatzdetails") per currency the organisation has data in: recurring + one-off + variable = total. Over the range the total equals totals.net, the sum of byCountry and the sum of byProduct (same revenue lines, same filter).