Skip to main content

​
GET /api/metrics/:period_id

Retorna métricas financieras consolidadas para un período fiscal específico identificado por su UUID.

​
Autenticación

Requiere autenticación con Bearer token.

​
Path Parameters

​
period_id
string
required
UUID del período fiscal para el cual se calculan las métricas.

​
Query Parameters

​
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 del período.

​
Response

​
period_id
string
UUID del período.
​
profile_id
string
UUID del perfil al que pertenece el período.
​
start_date
string
Fecha de inicio del período (formato ISO 8601).
​
end_date
string
Fecha de fin del período (formato ISO 8601).
​
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 - Período no encontrado o no pertenece al usuario
  • 500 - Error del servidor
curl --request GET \
  --url 'https://api.contafy.com/api/metrics/456e7890-e12b-34d5-a678-426614174111' \
  --header 'Authorization: Bearer YOUR_TOKEN'

{
  "period_id": "456e7890-e12b-34d5-a678-426614174111",
  "profile_id": "123e4567-e89b-12d3-a456-426614174000",
  "start_date": "2026-01-01T00:00:00.000Z",
  "end_date": "2026-03-31T23:59:59.999Z",
  "regimen_fiscal": "626",
  "ingresos": 265000.00,
  "egresos": 98000.50,
  "utilidad": 166999.50,
  "iva_trasladado": 42400.00,
  "iva_retenido": 2400.00,
  "isr_retenido": 7500.00,
  "facturas_emitidas": 52,
  "facturas_recibidas": 78
}

Build docs developers (and LLMs) love

Get started for freeTalk to us