Saltar al contenido principal

Reporte de Tolerancia

Análisis de tolerancia por factura — muestra la desviación respecto del monto del sistema y los resultados de aprobación/revisión/rechazo automáticos según las reglas de tolerancia configuradas.

GET/apidev/v1/reports/portal/tolerance
PermisoAPICLI_RPTPORTALPROVEEDOR_TOLERANCIA
Límite de solicitudes10 req/min (ventana deslizante)
Caché300s (5 min)
Rango máximo93 días

Resumen​

Analiza cada factura contra las reglas de tolerancia configuradas, mostrando la desviación respecto del monto del sistema y la acción resultante (aprobada automáticamente, enviada a revisión o rechazada). Incluye un resumen con cantidades de anomalías y desviación promedio.

  • Detalle de la regla de tolerancia — tipo configurado (PCT, ABS, AMB), valor y origen por factura
  • Clasificación del resultado — AUTO_APPROVED, REVIEW o REJECTED
  • Filtrado por anomalías — anomalies_only=true devuelve solo las facturas fuera de tolerancia
  • Filtrado por proveedor — restringí a proveedores específicos (hasta 100)
  • Resumen — cantidades de aprobadas automáticamente, en revisión, rechazadas y desviación promedio

Solicitud​

Encabezados de la solicitud​

Every request to a protected endpoint requires these headers:

HeaderRequiredDescription
AuthorizationYesBearer token obtained from the Login endpoint. Format: Bearer <token>
X-API-KeyYesCompany integration key provided during onboarding. Format: gtk_xxx...
tenantYesYour assigned tenant domain (default: geotareas.com) — always send your assigned tenant
Content-TypeConditionalapplication/json — required for POST and PUT requests

Parámetros de consulta​

ParámetroTipoObligatorioPor defectoDescripción
startdatestringSí—Fecha de inicio ISO 8601
enddatestringSí—Fecha de fin ISO 8601. Rango máximo 93 días
providersstringNoTodosIDs de proveedor separados por comas. Máximo 100
anomalies_onlybooleanNofalseDevolver solo las facturas fuera de tolerancia (en revisión + rechazadas)
limitintegerNo25Registros por página (1–100)
offsetintegerNo0Registros a omitir

Ejemplos de código​

curl -s "https://$TENANT/apidev/v1/reports/portal/tolerance?startdate=2026-01-01&enddate=2026-03-31&anomalies_only=true&limit=50" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-API-Key: $APIKEY" \
  -H "tenant: $TENANT"

Campos de la respuesta​

Filas​

CampoTipoDescripción
invoice_idstringIdentificador de la factura
provider_idstringIdentificador del proveedor
provider_namestringNombre visible del proveedor
service_idstringIdentificador del servicio asociado
service_numberstringNúmero de servicio (legible)
invoice_datestringFecha de la factura
system_amountnumberMonto calculado por el sistema
provider_amountnumberMonto reportado por el proveedor
differencenumberDiferencia absoluta (sistema − proveedor)
deviation_pctnumberDesviación como porcentaje del monto del sistema
state_idnumber | nullCódigo de estado de la factura
state_namestring | nullNombre legible del estado
tolerance_configuredstringDescripción legible de la regla de tolerancia
tolerance_typestringTipo de tolerancia: PCT (porcentaje), ABS (absoluta), AMB (ambas)
tolerance_valuenumberUmbral de tolerancia configurado
tolerance_originstringDónde se definió la regla de tolerancia (ej. "provider", "global", "product")
resultstringResultado de tolerancia: AUTO_APPROVED, REVIEW, REJECTED
within_tolerancebooleanSi la factura está dentro de la tolerancia configurada

Resumen​

CampoTipoDescripción
total_invoicesnumberCantidad total de facturas en el rango
auto_approvednumberCantidad de facturas aprobadas automáticamente
in_reviewnumberCantidad de facturas enviadas a revisión
rejectednumberCantidad de facturas rechazadas
avg_deviation_pctnumberPorcentaje de desviación promedio
providers_with_anomaliesnumberCantidad de proveedores con al menos una anomalía

Ejemplo de respuesta​

{
  "success": true,
  "data": {
    "rows": [
      {
        "invoice_id": "710450328800",
        "provider_id": "504210987600",
        "provider_name": "Transporte Rápido S.A.",
        "service_id": "820134567800",
        "service_number": "SRV-2026-00142",
        "invoice_date": "2026-02-15",
        "system_amount": 12500.00,
        "provider_amount": 13100.00,
        "difference": -600.00,
        "deviation_pct": 4.80,
        "state_id": 101,
        "state_name": "In Review",
        "tolerance_configured": "5% or $500",
        "tolerance_type": "AMB",
        "tolerance_value": 5.00,
        "tolerance_origin": "provider",
        "result": "REVIEW",
        "within_tolerance": false
      },
      {
        "invoice_id": "710450328802",
        "provider_id": "504210987602",
        "provider_name": "ServiFlota Express",
        "service_id": "820134567803",
        "service_number": "SRV-2026-00195",
        "invoice_date": "2026-03-02",
        "system_amount": 9200.00,
        "provider_amount": 11800.00,
        "difference": -2600.00,
        "deviation_pct": 28.26,
        "state_id": 103,
        "state_name": "Rejected",
        "tolerance_configured": "10%",
        "tolerance_type": "PCT",
        "tolerance_value": 10.00,
        "tolerance_origin": "global",
        "result": "REJECTED",
        "within_tolerance": false
      }
    ],
    "summary": {
      "total_invoices": 253,
      "auto_approved": 198,
      "in_review": 42,
      "rejected": 13,
      "avg_deviation_pct": 3.45,
      "providers_with_anomalies": 8
    }
  },
  "meta": {
    "total": 55,
    "limit": 50,
    "offset": 0
  }
}

Errores​

CódigoHTTPDescripción
VALIDATION_ERROR400El rango de fechas supera los 93 días, > 100 proveedores
UNAUTHORIZED401tenant / Authorization / X-API-Key ausente, inválido o expirado
FORBIDDEN403El usuario no tiene el permiso APICLI_RPTPORTALPROVEEDOR_TOLERANCIA
RATE_LIMITED429Se superaron 10 req/min
INTERNAL_ERROR500Error inesperado del servidor