Liquidity page datasets

Key figures (net cash of the range, outstanding and overdue today, DSO over three and twelve months), the overview datasets (cash flow, ageing, receivables trend and table), payment behaviour per payment method, contract against billing, the data quality findings per code and whether each month is closed in accounting. Payment behaviour and DSO are organisation-wide and ignore a segment (meta.filtersNotApplied).

Required permission: analytics:read.

GET /api/analytics/finance/liquidity

Liquidity page datasets

cURL

curl --request GET \
  --url https://coreapi.io/api/analytics/finance/liquidity \
  --header 'Authorization: Bearer <token>'

200

{
  "tenantName": "<string>",
  "currency": "<string>",
  "asOf": "2023-11-07T05:31:56Z",
  "months": [
    "<string>"
  ],
  "overviewWire": {
    "months": [
      "<string>"
    ],
    "cashflow": {
      "collected": [
        {
          "amount": "1234.56",
          "currency": "EUR"
        }
      ],
      "refunded": [
        {
          "amount": "1234.56",
          "currency": "EUR"
        }
      ],
      "net": [
        {
          "amount": "1234.56",
          "currency": "EUR"
        }
      ],
      "totals": {},
      "forecastBilled": [
        {
          "amount": "1234.56",
          "currency": "EUR"
        }
      ],
      "collectedThisMonth": [
        {
          "amount": "1234.56",
          "currency": "EUR"
        }
      ],
      "collectedOtherMonths": [
        {
          "amount": "1234.56",
          "currency": "EUR"
        }
      ],
      "collectedUnassigned": [
        {
          "amount": "1234.56",
          "currency": "EUR"
        }
      ],
      "refundedRefund": [
        {
          "amount": "1234.56",
          "currency": "EUR"
        }
      ],
      "refundedChargeback": [
        {
          "amount": "1234.56",
          "currency": "EUR"
        }
      ],
      "refundedPayout": [
        {
          "amount": "1234.56",
          "currency": "EUR"
        }
      ],
      "collectedRefundReturned": [
        {
          "amount": "1234.56",
          "currency": "EUR"
        }
      ],
      "corrections": [
        {
          "amount": "1234.56",
          "currency": "EUR"
        }
      ],
      "correctionsReversed": [
        {
          "amount": "1234.56",
          "currency": "EUR"
        }
      ],
      "correctionsCounter": [
        {
          "amount": "1234.56",
          "currency": "EUR"
        }
      ],
      "correctionCount": [
        123
      ],
      "refundedReturnFee": [
        {
          "amount": "1234.56",
          "currency": "EUR"
        }
      ]
    },
    "mrrMovements": {
      "new": [
        {
          "amount": "1234.56",
          "currency": "EUR"
        }
      ],
      "expansion": [
        {
          "amount": "1234.56",
          "currency": "EUR"
        }
      ],
      "contraction": [
        {
          "amount": "1234.56",
          "currency": "EUR"
        }
      ],
      "lost": [
        {
          "amount": "1234.56",
          "currency": "EUR"
        }
      ],
      "resurrecting": [
        {
          "amount": "1234.56",
          "currency": "EUR"
        }
      ]
    },
    "revenueBreakdown": {
      "recurring": [
        {
          "amount": "1234.56",
          "currency": "EUR"
        }
      ],
      "oneOff": [
        {
          "amount": "1234.56",
          "currency": "EUR"
        }
      ],
      "variable": [
        {
          "amount": "1234.56",
          "currency": "EUR"
        }
      ],
      "total": [
        {
          "amount": "1234.56",
          "currency": "EUR"
        }
      ]
    },
    "receivablesTrend": [
      {
        "amount": "1234.56",
        "currency": "EUR"
      }
    ],
    "receivablesTrendOverdue": [
      {
        "amount": "1234.56",
        "currency": "EUR"
      }
    ],
    "ageing": {
      "asOf": "2023-11-07T05:31:56Z",
      "total": {
        "amount": "1234.56",
        "currency": "EUR"
      },
      "overdueTotal": {
        "amount": "1234.56",
        "currency": "EUR"
      },
      "buckets": [
        {
          "key": "not_due",
          "amount": {
            "amount": "1234.56",
            "currency": "EUR"
          },
          "invoiceCount": 123,
          "topCustomers": [
            {
              "customer": {
                "id": "<string>",
                "number": "<string>",
                "name": "<string>"
              },
              "amount": {
                "amount": "1234.56",
                "currency": "EUR"
              },
              "invoiceCount": 123
            }
          ]
        }
      ],
      "over365": {
        "amount": "1234.56",
        "currency": "EUR"
      }
    },
    "receivablesTable": {
      "rows": {},
      "totals": {},
      "forecastInvoiceCount": [
        123
      ]
    },
    "totals": {},
    "meta": {
      "asOf": "2023-11-07T05:31:56Z",
      "buildId": "<string>",
      "scope": "invoice_address",
      "currency": "EUR",
      "from": "2025-10",
      "to": "2026-09",
      "findings": {
        "error": 0,
        "warning": 3,
        "info": 12
      },
      "filtersNotApplied": [
        "<string>"
      ],
      "notSnapshotted": [
        "one_off",
        "accounted_mrr",
        "cash_collected"
      ],
      "projectedFrom": "2026-10",
      "forecast": {
        "incomplete": false,
        "failedSubscriptions": 0
      },
      "build": {
        "status": "failed",
        "builtAt": "2023-11-07T05:31:56Z",
        "buildId": "<string>",
        "failed": {
          "invariants": [
            "CASH_WITHIN_DOCUMENT"
          ],
          "rowCount": 5,
          "invoiceRowCount": 5
        }
      },
      "dataBuildId": "<string>"
    }
  },
  "liquidity": {
    "kpis": [
      {
        "id": "mrr",
        "title": "MRR",
        "valueKind": "money",
        "value": "12500.00",
        "delta": "250.00",
        "better": "up",
        "sparkline": [
          "<string>"
        ],
        "caption": "<string>",
        "asOfMonth": "2026-08",
        "monthComplete": true,
        "current": {
          "asOfMonth": "2026-09",
          "value": "5279.33",
          "delta": "1916.00",
          "monthComplete": false
        }
      }
    ],
    "paymentBehaviour": {
      "termDays": 123,
      "months": [
        {
          "month": "<string>",
          "averageDays": {},
          "openOverdueCount": 123
        }
      ],
      "summary": [
        {
          "method": "<string>",
          "averageDays": "<string>",
          "withinTerm": "<string>",
          "invoices": 123
        }
      ]
    },
    "reconciliation": {
      "totalDifference": "<string>",
      "rows": [
        {
          "id": "<string>",
          "customer": {
            "id": "<string>",
            "number": "<string>",
            "name": "<string>"
          },
          "subscription": {
            "id": "<string>",
            "number": "<string>"
          },
          "invoice": {
            "id": "<string>",
            "number": "<string>"
          },
          "product": "<string>",
          "month": "<string>",
          "contract": "<string>",
          "billed": "<string>",
          "difference": "<string>",
          "cause": "billed_after_end",
          "causeLabel": "Abgerechnet nach Vertragsende",
          "parts": [
            {
              "cause": "not_billed",
              "causeLabel": "Nicht abgerechnet",
              "amount": "149.00"
            }
          ],
          "invoices": [
            {
              "id": "<string>",
              "number": "<string>"
            }
          ],
          "findingId": "<string>",
          "belowTolerance": false,
          "monthComplete": true
        }
      ],
      "monthTotals": {}
    },
    "dso": "<string>"
  },
  "findings": [
    {
      "code": "<string>",
      "label": "<string>",
      "severity": "error",
      "count": 123
    }
  ],
  "accountingClosed": [
    true
  ],
  "meta": {
    "asOf": "2023-11-07T05:31:56Z",
    "buildId": "<string>",
    "scope": "invoice_address",
    "currency": "EUR",
    "from": "2025-10",
    "to": "2026-09",
    "findings": {
      "error": 0,
      "warning": 3,
      "info": 12
    },
    "filtersNotApplied": [
      "<string>"
    ],
    "notSnapshotted": [
      "one_off",
      "accounted_mrr",
      "cash_collected"
    ],
    "projectedFrom": "2026-10",
    "forecast": {
      "incomplete": false,
      "failedSubscriptions": 0
    },
    "build": {
      "status": "failed",
      "builtAt": "2023-11-07T05:31:56Z",
      "buildId": "<string>",
      "failed": {
        "invariants": [
          "CASH_WITHIN_DOCUMENT"
        ],
        "rowCount": 5,
        "invoiceRowCount": 5
      }
    },
    "dataBuildId": "<string>"
  }
}

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

200

application/json

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).

Show child attributes

liquidity · object

Key figures, payment behaviour, reconciliation, DSO.

Show child attributes

findings · object[]

Data quality findings per code.

Show child attributes

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.

Show child attributes