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
-
SuccessEnvelope -
object
Used in operations
GET /v1/finance/monthlyGET /v1/finance/counterpartiesGET /v1/finance/by-bankGET /v1/finance/accounting