← Volver al índice de esquemas
FinancePreviewResponse
Respuesta de vista previa de un reporte financiero con las cabeceras y hasta 20 filas del CSV.
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 | Datos 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 para formato CSV (en el mismo orden que las filas en `rows`). |
rows | array | Primeras 20 filas (máximo) de datos del reporte. |
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/monthlyGET /v1/finance/counterpartiesGET /v1/finance/by-bankGET /v1/finance/accounting