Métricas

Endpoint de sesión que devuelve KPIs agregados del contribuyente para alimentar dashboards.

Esta API utiliza autenticación Keycloak. Ver Autenticación para obtener un token JWT.

Endpoint que devuelve un snapshot de KPIs del contribuyente. Pensado para alimentar el dashboard del panel web o tu propio reporte interno.

GET /api/v1/contribuyentes/:id/metricas

Retorna métricas agregadas del contribuyente.

Autenticación

Authorization: Bearer {keycloak-jwt} (requerido). El usuario debe ser propietario o miembro del contribuyente.

Path parameters

Parámetro	Tipo	Descripción
`id`	`long`	ID del contribuyente

DashboardMetricasDTO

Campo	Tipo	Descripción
`totalDocumentos`	`long`	Cantidad histórica total de DEs emitidos
`documentosEsteMes`	`long`	DEs emitidos en el mes calendario actual
`documentosPendientes`	`long`	DEs en estado `PENDIENTE` o `EN_LOTE`
`documentosAprobados`	`long`	DEs en estado `APROBADO`
`documentosPorTipo`	`Map<string, long>`	Conteo por tipo (key = `tipoDocumentoLabel`)

Ejemplo

curl https://api.sifende.com.py/api/v1/contribuyentes/12/metricas \
  -H "Authorization: Bearer $KEYCLOAK_JWT"

Respuesta exitosa

Status: 200 OK

{
  "status": "success",
  "payload": {
    "totalDocumentos": 4321,
    "documentosEsteMes": 287,
    "documentosPendientes": 12,
    "documentosAprobados": 4180,
    "documentosPorTipo": {
      "FACTURA_ELECTRONICA": 4012,
      "NOTA_DE_CREDITO_ELECTRONICA": 245,
      "NOTA_DE_DEBITO_ELECTRONICA": 64
    }
  }
}

Errores

Status	Tipo	Causa
`403`	`access-denied`	El usuario no es propietario ni miembro del contribuyente
`404`	`contribuyente-not-found`	El `:id` no existe

Caso de uso

Útil para construir un dashboard propio en tu sistema:

const res = await fetch(
  `https://api.sifende.com.py/api/v1/contribuyentes/${contribuyenteId}/metricas`,
  { headers: { Authorization: `Bearer ${jwt}` } }
);
const { payload } = await res.json();

console.log(`Emitidos este mes: ${payload.documentosEsteMes}`);
console.log(`Pendientes de procesamiento: ${payload.documentosPendientes}`);

Las métricas se calculan en tiempo real sobre la base de datos del contribuyente; no hay caché. En contribuyentes con cientos de miles de DEs el endpoint puede tardar unos cientos de milisegundos.

Este endpoint no acepta filtros de fecha personalizados. Si necesitás métricas con rango personalizado, podés construirlas a partir del listado de documentos electrónicos usando fechaDesde / fechaHasta.

On this page