Saltar al contenido principal

Reporte de Facturación

Facturación agregada por proveedor — total facturado, montos del proveedor, estado de pago y tasas de aprobación.

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

Resumen​

Agrega los datos de facturación por proveedor para el rango de fechas indicado. Cada fila representa un proveedor con los totales de montos facturados, montos reportados por el proveedor, estado de pago y cantidades de aprobaciones/rechazos.

  • Resumen por proveedor — cantidad de tareas, totales facturados, estado de pago, tasa de aprobación
  • Totales generales — agregados de todos los proveedores en la respuesta
  • Filtrado por proveedor — restringí a proveedores específicos (hasta 100)

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

Ejemplos de código​

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

Campos de la respuesta​

Filas​

CampoTipoDescripción
provider_idstringIdentificador del proveedor
provider_namestringNombre visible del proveedor
task_countnumberCantidad de tareas/servicios en el período
total_invoicednumberMonto total facturado calculado por el sistema
total_providernumberMonto total reportado por el proveedor
total_paidnumberMonto total ya pagado
pending_paymentnumberMonto pendiente de pago
approval_ratenumberTasa de aprobación como porcentaje (0–100)
approved_countnumberCantidad de facturas aprobadas
rejected_countnumberCantidad de facturas rechazadas
review_countnumberCantidad de facturas en revisión

Total general​

CampoTipoDescripción
total_invoicednumberSuma de los montos facturados de todos los proveedores
total_providernumberSuma de los montos reportados de todos los proveedores
total_paidnumberSuma de todos los montos pagados
pending_paymentnumberSuma de todos los pagos pendientes
task_countnumberCantidad total de tareas de todos los proveedores

Ejemplo de respuesta​

{
"success": true,
"data": {
"rows": [
{
"provider_id": "504210987600",
"provider_name": "Transporte Rápido S.A.",
"task_count": 42,
"total_invoiced": 245800.00,
"total_provider": 251200.00,
"total_paid": 198400.00,
"pending_payment": 47400.00,
"approval_rate": 88.10,
"approved_count": 37,
"rejected_count": 2,
"review_count": 3
},
{
"provider_id": "504210987601",
"provider_name": "Logística del Norte",
"task_count": 35,
"total_invoiced": 198300.00,
"total_provider": 199100.00,
"total_paid": 178500.00,
"pending_payment": 19800.00,
"approval_rate": 94.29,
"approved_count": 33,
"rejected_count": 1,
"review_count": 1
},
{
"provider_id": "504210987602",
"provider_name": "ServiFlota Express",
"task_count": 28,
"total_invoiced": 167500.00,
"total_provider": 169800.00,
"total_paid": 142000.00,
"pending_payment": 25500.00,
"approval_rate": 85.71,
"approved_count": 24,
"rejected_count": 2,
"review_count": 2
}
],
"grand_total": {
"total_invoiced": 611600.00,
"total_provider": 620100.00,
"total_paid": 518900.00,
"pending_payment": 92700.00,
"task_count": 105
}
},
"meta": {
"total": 3
}
}

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_FACTURACION
RATE_LIMITED429Se superaron 10 req/min
INTERNAL_ERROR500Error inesperado del servidor