← Back to schema index

FinancePreviewResource

JSON:API resource for a financial report 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