Factuarea API
Clients

Obtenir un client

Obté un client pel seu `uuid`. Retorna 404 si el client no existeix o pertany a una altra empresa.

GET
/clients/{client}

Authorization

AuthorizationBearer <token>

A: header

Paràmetres de ruta

client*string

Cos de la resposta

application/json

application/json

application/json

application/json

application/json

{
  "data": {
    "id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a01",
    "object": "client",
    "name": "Acme Corporation",
    "commercial_name": "Acme SL",
    "tax_id": "B12345678",
    "vat_id": "ESB12345678",
    "email": "billing@acme.com",
    "phone": "+34 600 123 456",
    "fax": "+34 91 123 45 68",
    "mobile": "+34 600 000 000",
    "website": "https://acme.com",
    "contact_person": "Juan García",
    "billing_emails": [
      "facturacion@acme.com",
      "contabilidad@acme.com"
    ],
    "address": {
      "line1": "Calle Mayor 1",
      "line2": "Edificio Central",
      "number": "42",
      "floor": "3",
      "door": "B",
      "staircase": "A",
      "postal_code": "28001",
      "city": "Madrid",
      "province": "Madrid",
      "country": "ES"
    },
    "coordinates": {
      "latitude": 39.4699,
      "longitude": -0.3763
    },
    "default_discount": 5,
    "default_vat_rate": 21,
    "default_retention_rate": 15,
    "is_surcharge_subject": false,
    "preferred_operation_regime": "general",
    "accumulate_347": true,
    "dir3_accounting_office": "L01280796",
    "dir3_managing_body": "L01280796",
    "dir3_processing_unit": "L01280796",
    "external_id": "CRM-99",
    "notes": "Pago al contado.",
    "metadata": {
      "erp_code": "IVA-GEN",
      "ledger_account": "477000"
    },
    "is_active": true,
    "created_at": "2026-01-15T10:30:00Z",
    "updated_at": "2026-01-15T10:30:00Z"
  }
}

{
  "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"
  }
}

Cerca clients

Cerca clients per consulta de text lliure contra `name`, `tax_id`, `vat_id`, `email` i `phone`. Retorna un array pla (sense paginació) limitat a 50 resultats.

Obtenir estadístiques del client

KPIs agregats de l'empresa autenticada: nombre total de clients, nombre d'actius, nombre amb factures de venda, nombre amb pressupostos i totals per tipus de document. Retornat com a `{ "data": ClientStats }`.