Zum Hauptinhalt springen
GET
Liquidity 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. Default: the organisation setting.

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

Analytics segment: only its customers.

Antwort

The datasets.

Liquidity page: key figures, cash flow, ageing and receivables (overview datasets), payment behaviour, reconciliation, findings and the accounting close per month.

tenantName
string

Name of the organisation.

currency
string

Currency of every amount (ISO-4217).

asOf
string<date-time> | null

Calculation time; null before the first calculation.

months
string[]

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

overviewWire
object

Cash flow, ageing, receivables trend and table (same shape as GET /api/analytics/finance/overview).

liquidity
object

Key figures, payment behaviour, reconciliation, DSO.

findings
object[]

Data quality findings per code.

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.

meta
object

Calculation time, scope, currency, findings, filters not applied.