Factuarea API
Sèries de documents

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.

GET
/series/{series}

Authorization

AuthorizationBearer <token>

A: header

Paràmetres de ruta

series*string

Cos de la resposta

application/json

application/json

application/json

application/json

application/json

{
  "data": {
    "id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a0e",
    "object": "series",
    "code": "F-2026",
    "name": "Facturas 2026",
    "document_type": "invoice",
    "prefix": "F-2026-",
    "number_format": "{code}-{YYYY}-{000}",
    "next_number": 46,
    "current_number": 45,
    "initial_number": 1,
    "year_reset": true,
    "is_default": true,
    "is_active": true,
    "created_at": "2026-01-01T00:00:00Z",
    "updated_at": "2026-01-20T11: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"
  }
}

Marca una sèrie com a predeterminada per al seu tipus

Promou una sèrie a predeterminada per al seu tipus de document. Si una altra sèrie era la predeterminada per al mateix tipus, es degrada de manera atòmica. Retorna 204 en cas d'èxit.

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 }`.