Factuarea API
Sèries de documents

Obtenir estadístiques de sèries

KPIs agregats de les teves sèries de numeració de documents: nombre total de sèries, nombre d'actives i arxivades, i desglossament per tipus de document. Retornat com a `{ "data": SeriesStats }`.

GET
/series/stats

Authorization

AuthorizationBearer <token>

A: header

Cos de la resposta

application/json

application/json

application/json

application/json

application/json

{
  "data": {
    "total": 17,
    "invoice": 5,
    "quote": 2,
    "delivery_note": 3,
    "proforma": 4
  }
}

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

Obtenir una sèrie

Obté una sèrie pel seu `uuid`. Les sèries són **immutables** per compliment fiscal (AEAT VeriFactu — continuïtat legal de la numeració): `PUT`, `PATCH` i `DELETE` sobre `/v1/series/{uuid}` retornen `405 Method Not Allowed` amb `error.code = "series_immutable"` i la capçalera `Allow: GET, POST`. Per "eliminar" una sèrie fes servir `POST /v1/series/{uuid}/archive`; per canviar la numeració, crea una nova sèrie i marca-la com a predeterminada.

Desarxivar una sèrie

Retorna una sèrie arxivada al conjunt actiu. No canvia el predeterminat actual del seu tipus. Retorna 204 si té èxit.