← Volver al índice de esquemas

FinancePreviewResponse

Respuesta de vista previa de un reporte financiero con las cabeceras y hasta 20 filas del CSV.

Propiedades

CampoTipoDescripción
dataobjectPayload principal de la respuesta. La forma varía según el endpoint (objeto, array, o envelope JSON:API con `type`, `id`, `attributes`).
typestringTipo del recurso JSON:API. Siempre `finance_preview`.
attributesobjectDatos de la vista previa del reporte.
reportstringTipo de reporte — `monthly`: estado de cuenta mensual; `counterparties`: top contrapartes; `by-bank`: desglose por banco; `accounting`: libro diario contable.
monthstringMes del reporte en formato `YYYY-MM`.
headersarrayNombres de las columnas para formato CSV (en el mismo orden que las filas en `rows`).
rowsarrayPrimeras 20 filas (máximo) de datos del reporte.
metaobjectMetadatos 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.
versionstringVersión de la API que procesó la petición.
api_versionstringVersión del prefijo de ruta de la API (ej. `v1`).
request_idstringIdentificador único de la petición (hex).
datetimeobjectDescriptor 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*stringSiempre `UTC`: La zona canónica para cada campo datetime del cuerpo.
format*stringSiempre `ISO 8601`: Sufijo `Z` explícito en cada datetime.
linksobjectEnlaces 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