← Back to schema index

FinancePreviewResource

JSON:API wrapper for the preview.

Properties

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

Used in operations

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

Referenced by schemas