Cercar una sèrie per codi

Cerca una sèrie pel seu code (cos JSON, sense distingir majúscules).

Un code no és únic entre tipus de document (multi-series), així que passa document_type per resoldre la sèrie (code, document_type) exacta.
Si l'omets, el codi es cerca a tots els tipus: es retorna una única coincidència, però un codi ambigu retorna 422 document_type_required_for_ambiguous_code en lloc de triar-ne un en silenci.
Retorna 404 si no n'existeix cap.

Fixa la versió de l'API (YYYY-MM-DD, versionat per data estil Stripe) per a aquesta petició; omet-lo per usar la versió fixada de la clau, o l'última si no n'hi ha cap. Versió no suportada → 400 unsupported_api_version; mal formada → 400 parameter_invalid_format. La versió efectiva es reflecteix a la capçalera de resposta Factuarea-Version. Consulta la guia de Versioning.

Formatdate

X-Active-Profile?string

Opera en nom d'una empresa filla (API key mestra de gestoria): passa el seu id públic (UUID v7) i la petició s'executa contra les dades d'aquella filla sense canviar l'scope, el tier ni l'environment de la clau (omet-lo per usar la pròpia empresa de la clau). UUID no vàlid → 400 parameter_invalid_uuid; id desconegut o no propi → 404 profile_not_found. Consulta la guia d'Acting on behalf.

Formatuuid

Cos de la petició

application/json

Definicions de TypeScript

Usa el tipus request body a TypeScript.

code*string

Longitudlength <= 10

document_type?string

Valor a"invoice" | "quote" | "delivery_note" | "proforma"

Cos de la resposta

`application/json`

Exemple de petició

const apiKey = process.env.FACTUAREA_API_KEY;if (!apiKey) throw new Error("Set FACTUAREA_API_KEY");const response = await fetch("https://api.factuarea.com/v1/series/find-by-code", {  method: "POST",  headers: { Authorization: `Bearer ${apiKey}`, ...{"Accept":"application/json","Content-Type":"application/json"} },  body: JSON.stringify({  "code": "HARV01",  "document_type": "invoice"}),});if (!response.ok) throw new Error(await response.text());if (response.status !== 204) console.log(await response.json());

Exemple de resposta

{
  "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,
    "counter_reset": "annual",
    "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": "Falta header Authorization o X-API-Key.",
    "doc_url": "https://docs.factuarea.com/guides/errors#missing_api_key",
    "request_id": "req_945df3e6118f8d8835a327b4eb"
  }
}

{
  "error": {
    "type": "authorization_error",
    "code": "insufficient_scope",
    "message": "Esta operación requiere el scope 'series:read'. Tu API key solo tiene los scopes: ninguno.",
    "doc_url": "https://docs.factuarea.com/guides/errors#insufficient_scope",
    "request_id": "req_35bf77acc0abe170a8a1b0d1ad"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_param_value",
    "message": "El campo code es obligatorio.",
    "param": "code",
    "errors": [
      {
        "param": "code",
        "code": "parameter_missing",
        "message": "El campo code es obligatorio."
      }
    ],
    "doc_url": "https://docs.factuarea.com/guides/errors#invalid_param_value",
    "request_id": "req_f692890712822a417a1cf86fde"
  }
}

{
  "error": {
    "type": "rate_limit_error",
    "code": "rate_limit_exceeded",
    "message": "Has excedido el límite de requests permitido. Reintenta más tarde.",
    "doc_url": "https://docs.factuarea.com/guides/errors#rate_limit_exceeded",
    "request_id": "req_f624b492f00e6c4f2cf958bab3"
  }
}

{
  "error": {
    "type": "api_error",
    "code": "internal_error",
    "message": "Algo se rompió en nuestro lado al procesar la petición. La condición no la provoca tu payload.",
    "doc_url": "https://docs.factuarea.com/guides/errors#internal_error",
    "request_id": "req_01fb6f467acc8d4b5a431ddac3"
  }
}

Cercar una sèrie per codi

Authorization

Headers

Cos de la petició

Cos de la resposta

200application/json

401application/json

403application/json

422application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`