Skip to main content

​
GET /api/metrics

Retorna métricas financieras consolidadas para un mes y año específicos. Puede obtener métricas agregadas de todos los perfiles del usuario o métricas de un perfil específico.

​
Autenticación

Requiere autenticación con Bearer token.

​
Query Parameters

​
mes
integer
required
Mes para el cual se calculan las métricas. Debe ser un número entre 1 y 12.
​
año
integer
required
Año para el cual se calculan las métricas. Debe ser un año válido entre 2000 y 2100.
​
profile_id
string
UUID del perfil. Si se proporciona, retorna métricas solo para ese perfil. Si se omite, retorna métricas agregadas de todos los perfiles del usuario.
​
regimen_fiscal
string
Clave SAT del régimen fiscal (3 dígitos, ej: "601", "606", "626"). Filtra facturas y gastos por régimen fiscal. Debe ser uno de los regímenes asociados al perfil.

​
Response

​
mes
integer
Mes de las métricas.
​
año
integer
Año de las métricas.
​
profile_id
string | null
UUID del perfil. null si las métricas son agregadas de todos los perfiles.
​
regimen_fiscal
string | null
Régimen fiscal filtrado, si se aplicó.
​
ingresos
number
Total de ingresos para el período.
​
egresos
number
Total de egresos (gastos) para el período.
​
utilidad
number
Utilidad bruta (ingresos - egresos).
​
iva_trasladado
number
Total de IVA trasladado (cobrado en facturas).
​
iva_retenido
number
Total de IVA retenido.
​
isr_retenido
number
Total de ISR retenido.
​
facturas_emitidas
integer
Número de facturas emitidas en el período.
​
facturas_recibidas
integer
Número de facturas recibidas (gastos) en el período.

​
Códigos de Estado

  • 200 - Métricas calculadas exitosamente
  • 400 - Parámetros inválidos o régimen fiscal no válido para el perfil
  • 401 - No autenticado
  • 404 - Perfil no encontrado o sin métricas
  • 500 - Error del servidor
curl --request GET \
  --url 'https://api.contafy.com/api/metrics?mes=3&año=2026' \
  --header 'Authorization: Bearer YOUR_TOKEN'

{
  "mes": 3,
  "año": 2026,
  "profile_id": null,
  "regimen_fiscal": null,
  "ingresos": 125000.50,
  "egresos": 45000.75,
  "utilidad": 79999.75,
  "iva_trasladado": 20000.08,
  "iva_retenido": 1200.00,
  "isr_retenido": 3500.00,
  "facturas_emitidas": 28,
  "facturas_recibidas": 42
}

Build docs developers (and LLMs) love

Get started for freeTalk to us