← Back to schema index

FinancePreviewResponse

Financial report preview response with the CSV headers and up to 20 rows.

Properties

FieldTypeDescription
dataobjectMain response payload. Shape varies by endpoint (object, array, or JSON:API envelope with `type`, `id`, `attributes`).
typestringJSON:API resource type. Always `finance_preview`.
attributesobjectReport preview fields.
reportstringReport type — `monthly`: Monthly statement; `counterparties`: Top counterparties; `by-bank`: Bank breakdown; `accounting`: Accounting ledger.
monthstringReport month in `YYYY-MM` format.
headersarrayCSV column names, in the same order as the values in `rows`.
rowsarrayFirst 20 data rows of the report (maximum).
metaobjectResponse metadata including API version, route prefix, unique request identifier, and the server timestamp in UTC.
versionstringAPI version that processed the request.
api_versionstringAPI route prefix version (e.g. `v1`).
request_idstringUnique request identifier (hex).
datetimeobjectCompanion descriptor present in the `meta` block of every response (and in the `meta` of outgoing webhook bodies). Lets clients assert the timezone contract without re-reading the spec.
timezone*stringAlways `UTC`: The canonical timezone for every datetime field in the body.
format*stringAlways `ISO 8601`: Explicit `Z` suffix on every datetime.
linksobjectPagination or related links, present only when the endpoint returns a paginated collection.

Used in operations

  • GET /v1/finance/monthly
  • GET /v1/finance/counterparties
  • GET /v1/finance/by-bank
  • GET /v1/finance/accounting