Docs
EN

Objetivo

Genera un paquete completo de conciliación financiera para un período de facturación: resumen de KPIs, estado de cuenta formateado (PDF/XLSX/CSV), reportes de drill-down por mes, contraparte y banco, exportación contable en formato ledger y un ZIP bulk con todos los certificados CEP.

Requisitos previos

  • Una API key activa (mxcep_…) con el permiso finance:generate_self.
  • Un month específico en formato YYYY-MM para cada petición.
  • Para el archivo CEP, asegúrate de tener validaciones valid con has_cep=true en el período solicitado.

Pasos

1. Revisar el resumen de KPIs

Antes de generar exportaciones, verifica que el período tiene datos y revisa las métricas clave:

curl 'https://api.example.com/v1/finance/summary?month=2025-03' \
  -H 'Authorization: Bearer mxcep_••••'

La respuesta incluye: conteos por veredicto, agregados monetarios (volumen total, volumen verificado, ticket promedio), tasa de éxito, tiempo de procesamiento promedio, desglose diario y top contrapartes y bancos. Se incluyen deltas mes a mes para comparación de períodos.

2. Descargar el estado de cuenta mensual

GET /v1/finance/statement genera el estado de cuenta mensual completo. Elige el formato que se adapte a tu flujo de trabajo:

formatContenido
pdfPDF estilo extracto bancario con encabezado/pie en cada página, resumen de portafolio, distribución de veredicto, detalle diario y hasta 1000 transacciones en el anexo.
xlsxLibro de 6 hojas: Resumen, Detalle diario, Top contrapartes, Top bancos, Distribución de veredicto, Verificaciones (ledger completo, sin límite de filas).
csvUTF-8 con BOM, particionado en secciones [HEADER], [KPIS], [TRANSACTIONS], [TOTALS].
htmlMismo contenido que el PDF, servido inline para impresión desde el navegador.
# Libro XLSX
curl 'https://api.example.com/v1/finance/statement?month=2025-03&format=xlsx' \
  -H 'Authorization: Bearer mxcep_••••' \
  --output estado-cuenta-2025-03.xlsx

# Estado de cuenta PDF
curl 'https://api.example.com/v1/finance/statement?month=2025-03&format=pdf' \
  -H 'Authorization: Bearer mxcep_••••' \
  --output estado-cuenta-2025-03.pdf

La respuesta incluye X-Finance-Folio — un código de folio determinístico para el período (SHA1(user_id|YYYY-MM|brand_slug)[:12]) útil para referencias de auditoría.

3. Profundizar en tendencias mensuales

GET /v1/finance/monthly devuelve las métricas financieras agregadas mes a mes para un período rolling — útil para análisis de tendencias multi-mes fuera del estado de cuenta de un solo mes.

curl 'https://api.example.com/v1/finance/monthly' \
  -H 'Authorization: Bearer mxcep_••••'

4. Analizar por contraparte

GET /v1/finance/counterparties desglosa volúmenes y distribuciones de veredicto por banco receptor o cuenta beneficiaria:

curl 'https://api.example.com/v1/finance/counterparties?month=2025-03' \
  -H 'Authorization: Bearer mxcep_••••'

5. Analizar por banco

GET /v1/finance/by-bank proporciona el mismo desglose segmentado por pares de banco emisor y receptor:

curl 'https://api.example.com/v1/finance/by-bank?month=2025-03' \
  -H 'Authorization: Bearer mxcep_••••'

6. Exportar el ledger contable

GET /v1/finance/accounting genera el ledger completo de transacciones en un formato amigable para contabilidad (CSV o XLSX) — sin límite de 1000 filas, incluye cada validación valid del período:

curl 'https://api.example.com/v1/finance/accounting?month=2025-03&format=xlsx' \
  -H 'Authorization: Bearer mxcep_••••' \
  --output ledger-2025-03.xlsx

7. Descargar el archivo bulk de CEPs

GET /v1/finance/ceps produce un ZIP que contiene todos los certificados CEP (PDF y/o XML) del período, más un manifest.csv y manifest.xlsx que lista cada certificado incluido:

curl 'https://api.example.com/v1/finance/ceps?month=2025-03' \
  -H 'Authorization: Bearer mxcep_••••' \
  --output ceps-2025-03.zip

Siguientes pasos