← Volver al índice de esquemas

FinanceSummaryResponse

Respuesta de `GET /finance/summary?month=YYYY-MM`. Contiene todos los KPIs financieros del mes en un solo bloque bajo `data.attributes`.

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_summary`).
attributesobjectKPIs financieros del usuario para un mes calendario. Incluye conteos por veredicto Banxico, agregados monetarios, desglose diario, top contrapartes y bancos, distribución de veredicto, y comparativa con el mes anterior.
periodobjectRango temporal del resumen (mes calendario completo).
monthstringMes en formato YYYY-MM.
from_utcstring (date-time)Inicio del mes en UTC (ISO 8601).
to_utcstring (date-time)Fin del mes en UTC (ISO 8601, exclusivo).
countsobjectConteos de validaciones por veredicto Banxico más soft-deletes del periodo (informativo).
totalintegerTotal de validaciones completadas en el periodo (excluye `pending`).
validintegerValidaciones con veredicto Banxico `valid` en el periodo.
invalidintegerValidaciones con veredicto Banxico `invalid` en el periodo.
not_foundintegerValidaciones con veredicto Banxico `not_found` en el periodo.
cep_unavailableintegerValidaciones con veredicto Banxico `cep_unavailable` en el periodo.
errorintegerValidaciones que terminaron en error técnico (Banxico no respondió, timeout, etc.) en el periodo.
pendingintegerValidaciones aún en proceso (asíncronas que no han recibido respuesta de Banxico) al cierre del periodo.
deletedintegerValidaciones eliminadas (soft-delete) en el periodo.
amountsobjectAgregados monetarios del periodo. `verified_volume` suma únicamente validaciones con resultado `valid`.
total_volumenumberVolumen total en MXN.
verified_volumenumberVolumen en MXN de validaciones con resultado `valid`.
unverified_volumenumberDiferencia entre volumen total y verificado.
avg_ticketnumberMonto promedio por validación en MXN.
median_ticketnumberMonto mediano por validación en MXN.
max_ticketnumberMayor monto individual del mes en MXN.
min_ticketnumberMenor monto individual del mes en MXN.
verified_share_pctnumberPorcentaje del volumen total correspondiente a validaciones verificadas, expresado de 0 a 100.
success_ratenumberTasa de éxito: porcentaje de validaciones con resultado `valid` sobre el total completado, expresado de 0 a 100.
avg_processing_msintegerTiempo promedio de procesamiento en milisegundos del periodo.
daily_breakdownarrayDesglose diario con actividad. Los días sin validaciones se omiten.
top_counterpartiesarrayTop 5 cuentas beneficiarias del usuario por volumen verificado en el mes.
top_banks_receptorarrayTop 5 bancos receptores por volumen verificado.
top_banks_emisorarrayTop 5 bancos emisores por volumen verificado.
verdict_distributionobjectConteo de validaciones por valor de veredicto Banxico. Los valores ausentes implican cero.
comparison_prev_monthobjectComparativa contra el mes anterior. Los deltas son `null` cuando el mes anterior tuvo base cero (crecimiento no definido).
prev_monthstringMes anterior en formato YYYY-MM.
totalintegerTotal de validaciones del mes anterior.
verified_volumenumberVolumen verificado del mes anterior en MXN.
total_delta_pctnumber | nullCambio porcentual del conteo total respecto al mes anterior. `null` cuando el mes anterior tuvo cero validaciones.
volume_delta_pctnumber | nullCambio porcentual del volumen verificado respecto al mes anterior. `null` cuando el mes anterior tuvo cero volumen verificado.
foliostringFolio determinístico del estado de cuenta del mes, idéntico al devuelto en la cabecera `X-Finance-Folio` del endpoint de exportación.
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/summary