Finance overview datasets

Cash flow (collected counts settled payments with status captured, booked, refunded or partial_refunded, by payment date), MRR movements (signed), billed net revenue by class (net = gross − tax after position discounts, credit notes negative), outstanding receivables at each month end, ageing of the invoices open today, and the receivables table. One currency, never converted. Cash and receivables have no product dimension: a product filter does not narrow them (meta.filtersNotApplied).

Required permission: analytics:read.

GET /api/analytics/finance/overview

Finance overview datasets

cURL

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

200

{
  "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>"
  }
}

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

200

application/json

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

Show child attributes

mrrMovements · object

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

Show child attributes

revenueBreakdown · object

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

Show child attributes

receivablesTrend · object[]

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

Show child attributes

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.

Show child attributes

ageing · object

Open invoices today by days past due.

Show child attributes

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.

Show child attributes

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

Show child attributes

meta · object

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

Show child attributes