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

Variants

allOf

Used in operations

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