← Volver al índice de esquemas

`FinancePreviewResponse`

Respuesta de vista previa de un reporte financiero (`format=preview`). Devuelve las cabeceras del CSV y las primeras 20 filas de datos para que la UI pueda mostrar una vista previa antes de la descarga completa.

Propiedades

Campo	Tipo	Descripción
`data`	`object`	Payload principal de la respuesta. La forma varía según el endpoint (objeto, array, o envelope JSON:API con `type`, `id`, `attributes`).
`type`	`string`	Tipo del recurso JSON:API (siempre `finance_preview`).
`attributes`	`object`	Campos de la vista previa del reporte.
`report`	`string`	Tipo de reporte: `monthly` — estado de cuenta mensual; `counterparties` — top contrapartes; `by-bank` — desglose por banco; `accounting` — libro diario contable.
`month`	`string`	Mes del reporte en formato YYYY-MM.
`headers`	`array`	Nombres de las columnas del CSV, en el mismo orden que las filas en `rows`.
`rows`	`array`	Primeras 20 filas de datos del reporte (máximo).
`meta`	`object`	Metadatos de la respuesta, incluyendo versión de la API, prefijo de ruta, identificador único de la petición y marca temporal del servidor en UTC.
`version`	`string`	Versión de la API que procesó la petición.
`api_version`	`string`	Versión del prefijo de ruta de la API (ej. `v1`).
`request_id`	`string`	Identificador único de la petición (hex).
`datetime`	`object`	Descriptor compañero presente en el bloque `meta` de cada respuesta (y en el `meta` del cuerpo de los webhooks salientes). Permite a los clientes afirmar el contrato de zona horaria sin releer el spec.
`timezone`*	`string`	Siempre `UTC` — la zona canónica para cada campo datetime del cuerpo.
`format`*	`string`	Siempre `ISO 8601` — sufijo `Z` explícito en cada datetime.
`links`	`object`	Enlaces de paginación o relacionados, presentes solo cuando el endpoint devuelve una colección paginada.

Usado en operaciones

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