Factuarea API
Clientes

Obtener estadísticas del cliente

KPIs agregados de la empresa autenticada: número total de clientes, número de activos, número con facturas de venta, número con presupuestos y totales por tipo de documento. Devuelto como `{ "data": ClientStats }`.

GET
/clients/stats
AuthorizationBearer <token>

En: header

Cuerpo de la respuesta

application/json

application/json

application/json

application/json

application/json

{
  "data": {
    "object": "client_stats",
    "total": 145,
    "active": 132,
    "with_email": 128,
    "with_phone": 119,
    "with_invoices": 97,
    "total_invoiced": 85432.1,
    "total_pending": 12450.75,
    "with_pending_invoices": 14,
    "pending_invoices_amount": 12450.75,
    "new_this_month": 6,
    "inactive_clients": 13,
    "average_per_client": 589.19
  }
}

{
  "error": {
    "type": "authentication_error",
    "code": "missing_api_key",
    "message": "No se ha proporcionado una API key válida en el header Authorization.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#missing_api_key",
    "request_id": "req_01HKQS5N8VR7QXJ9K3T6BWPMZA"
  }
}

{
  "error": {
    "type": "authorization_error",
    "code": "insufficient_scope",
    "message": "Esta API key no tiene el scope requerido para esta operación.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#insufficient_scope",
    "request_id": "req_01HKQS5NBC3P8M1KX4V7SLNHQD"
  }
}

{
  "error": {
    "type": "rate_limit_error",
    "code": "rate_limit_exceeded",
    "message": "Has excedido el rate limit de 60 peticiones por minuto. Reintenta tras 30 segundos.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#rate_limit_exceeded",
    "request_id": "req_01HKQS5NKW1C6W9T4G5H0JBZVL"
  }
}

{
  "error": {
    "type": "api_error",
    "code": "internal_error",
    "message": "Ha ocurrido un error inesperado. Si persiste, contacta con soporte adjuntando el request_id.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#internal_error",
    "request_id": "req_01HKQS5NLX2D7X0U5H6J1KCAWM"
  }
}