Skip to main content

​
GET /api/public-reports/:token

Endpoint público (sin autenticación) que retorna el branding del despacho, información del perfil y métricas financieras asociadas a un token de reporte público.

​
Autenticación

No requiere autenticación. Este es un endpoint público.

​
Path Parameters

​
token
string
required
UUID del token de reporte público.

​
Query Parameters

​
mes
integer
Mes específico para filtrar las métricas. Debe ser un número entre 1 y 12.
​
año
integer
Año específico para filtrar las métricas. Debe ser un año entre 2000 y 2100.

​
Response

​
branding
object
Información de branding del despacho/usuario.
​
profile
object
Información del perfil asociado al reporte.
​
metrics
object
Métricas financieras del período solicitado.
​
expires_at
string | null
Fecha de expiración del token. null si no expira.

​
Códigos de Estado

  • 200 - Reporte recuperado exitosamente
  • 404 - Token no válido, expirado o revocado
  • 500 - Error del servidor
curl --request GET \
  --url 'https://api.contafy.com/api/public-reports/789e0123-f45a-67b8-c901-234567890abc'

{
  "branding": {
    "nombre_comercial": "Despacho Contable XYZ",
    "logo_url": "https://cdn.contafy.com/logos/xyz.png"
  },
  "profile": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "nombre": "Empresa ABC S.A. de C.V.",
    "rfc": "ABC010203XYZ",
    "regimenes_fiscales": ["601", "626"]
  },
  "metrics": {
    "mes": 3,
    "año": 2026,
    "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
  },
  "expires_at": "2026-06-05T10:30:00.000Z"
}

​
DELETE /api/public-reports/:token

Revoca un token de reporte público, deshabilitando el acceso al reporte.

​
Autenticación

Requiere autenticación con Bearer token. Solo el propietario del reporte puede revocarlo.

​
Path Parameters

​
token
string
required
UUID del token de reporte público a revocar.

​
Response

​
message
string
Mensaje de confirmación.

​
Códigos de Estado

  • 200 - Token revocado exitosamente
  • 401 - No autenticado
  • 404 - Token no encontrado o sin permiso
  • 500 - Error del servidor
curl --request DELETE \
  --url 'https://api.contafy.com/api/public-reports/789e0123-f45a-67b8-c901-234567890abc' \
  --header 'Authorization: Bearer YOUR_TOKEN'

{
  "message": "Enlace revocado correctamente"
}

Build docs developers (and LLMs) love

Get started for freeTalk to us