FinancePreviewResponse
Financial report preview response with the CSV headers and up to 20 rows.
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 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* | 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/monthlyGET /v1/finance/counterpartiesGET /v1/finance/by-bankGET /v1/finance/accounting