← Back to schema index

`FinancePreviewResponse`

Preview response for a financial report (`format=preview`). Returns the CSV headers and first 20 data rows so the UI can display a preview before the full download.

Properties

Field	Type	Description
`data`	`object`	Main response payload. Shape varies by endpoint (object, array, or JSON:API envelope with `type`, `id`, `attributes`).
`type`	`string`	JSON:API resource type (always `finance_preview`).
`attributes`	`object`	Report preview fields.
`report`	`string`	Report type: `monthly` — monthly statement; `counterparties` — top counterparties; `by-bank` — bank breakdown; `accounting` — accounting ledger.
`month`	`string`	Report month in YYYY-MM format.
`headers`	`array`	CSV column names, in the same order as the values in `rows`.
`rows`	`array`	First 20 data rows of the report (maximum).
`meta`	`object`	Response metadata including API version, route prefix, unique request identifier, and the server timestamp in UTC.
`version`	`string`	API version that processed the request.
`api_version`	`string`	API route prefix version (e.g. `v1`).
`request_id`	`string`	Unique request identifier (hex).
`datetime`	`object`	Companion descriptor present in every response's meta block (and in outgoing webhook payloads). Lets clients assert the timezone contract without re-reading the spec.
`timezone`*	`string`	Always `UTC` — the canonical timezone for every datetime field in the body.
`format`*	`string`	Always `ISO 8601` — explicit `Z` suffix on every datetime.
`links`	`object`	Pagination 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