Descarregar el PDF retingut exacte

Descarrega els bytes conservats d'un artefacte llest com a application/pdf (Content-Disposition: attachment).

L'ETag és el SHA-256 del fitxer; envia'l a If-None-Match per rebre 304 Not Modified.
L'autorització i la integritat es verifiquen abans de qualsevol 304. Requereix pdfs:read.

Authorization

AuthorizationBearer <token>

La teva API key com a token Bearer: fact_live_… en producció, fact_test_… en sandbox. Consulta la guia d'autenticació.

A: header

Paràmetres de ruta

company*string

Identificador públic (UUID v7) de l'empresa. Obtén-lo de GET /v1/me (data.scope[].id).

Formatuuid

artifact*string

Identificador públic (UUID v7) de l'artefacte PDF.

Formatuuid

Petició condicional: envia l'ETag que has desat d'una resposta anterior d'aquesta operació (entre cometes, tal com es va rebre) per obtenir 304 Not Modified sense body quan el contingut no ha canviat. Omet-lo per rebre sempre la resposta completa.

Factuarea-Version?string

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

Cos de la resposta

`application/pdf`

`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/companies/01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a01/pdf-artifacts/01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a01/download", {  method: "GET",  headers: { Authorization: `Bearer ${apiKey}`, ...{"Accept":"application/pdf","If-None-Match":"\"5d41402abc4b2a76b9719d911017c592\""} },});if (!response.ok && response.status !== 304) throw new Error(await response.text());if (response.status === 304) console.log("Not modified: keep your cached copy.");else await (await import("node:fs/promises")).writeFile("response.bin", new Uint8Array(await response.arrayBuffer()));

Exemple de resposta

Descarrega el fitxer amb les capçaleres de resposta indicades a continuació.

HTTP/1.1 200
Content-Type: application/pdf
Content-Length: 48213
Content-Disposition: attachment; filename=factura-FAC-2026-00042.pdf
ETag: "1a05e1535a4c69d0985fc7b13aa00539ff60bac13dba9b20046d609ead5f2274"
Cache-Control: no-store, private
X-Content-Type-Options: nosniff
X-Robots-Tag: noindex

Aquesta resposta no té cos.

S'ha enviat la capçalera X-Active-Profile retirada

{
  "error": {
    "type": "invalid_request_error",
    "code": "parameter_unknown",
    "subcode": "retired_active_profile_header",
    "message": "La cabecera 'X-Active-Profile' fue retirada de la API v1: la empresa efectiva se indica en el segmento de empresa de la ruta.",
    "param": "X-Active-Profile",
    "doc_url": "https://docs.factuarea.com/guides/errors#parameter_unknown",
    "request_id": "req_01J8Y3M2Q40000000000000001"
  }
}

Capçalera Factuarea-Version malformada

{
  "error": {
    "type": "invalid_request_error",
    "code": "parameter_invalid_format",
    "message": "El header 'Factuarea-Version' debe tener formato YYYY-MM-DD.",
    "param": "Factuarea-Version",
    "doc_url": "https://docs.factuarea.com/guides/errors#parameter_invalid_format",
    "request_id": "req_01J8Y3M2Q40000000000000002"
  }
}

Factuarea-Version no admesa

{
  "error": {
    "type": "invalid_request_error",
    "code": "unsupported_api_version",
    "message": "La versión de API '2020-01-01' no está soportada.",
    "param": "Factuarea-Version",
    "doc_url": "https://docs.factuarea.com/guides/errors#unsupported_api_version",
    "request_id": "req_01J8Y3M2Q40000000000000003"
  }
}

Falta l'API key

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

Format d'API key no vàlid

{
  "error": {
    "type": "authentication_error",
    "code": "invalid_api_key",
    "message": "La API key no tiene el formato esperado (debe empezar por fact_live_ o fact_test_).",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#invalid_api_key",
    "request_id": "req_01HKQS5N9JTQM7HVTQP3FBN5XB"
  }
}

API key revocada

{
  "error": {
    "type": "authentication_error",
    "code": "api_key_revoked",
    "message": "Esta API key ha sido revocada y ya no es válida.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#api_key_revoked",
    "request_id": "req_01HKQS5NA8K7E2V9YDZWMT6RJC"
  }
}

API key caducada

{
  "error": {
    "type": "authentication_error",
    "code": "api_key_expired",
    "message": "Esta API key ha caducado.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#api_key_expired",
    "request_id": "req_01HKQS5NAPIKEYEXPIRED00008"
  }
}

IP de la petició fora de la llista d'accés de l'API key

{
  "error": {
    "type": "authentication_error",
    "code": "ip_not_allowed",
    "message": "La IP 203.0.113.10 no está autorizada para esta API key.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#ip_not_allowed",
    "request_id": "req_01HKQS5NIPNOTALLOWED000009"
  }
}

GET /v1/companies/{company}/pdf-artifacts/{artifact}/download · 403 insufficient_scope

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

GET /v1/companies/{company}/pdf-artifacts/{artifact}/download · 403 pdf_template_access_denied

{
  "error": {
    "type": "authorization_error",
    "code": "pdf_template_access_denied",
    "message": "No tienes permisos para realizar esta operación en la biblioteca PDF.",
    "doc_url": "https://docs.factuarea.com/guides/errors#pdf_template_access_denied",
    "request_id": "req_bac80dc4a5f262d7fb0b4b0a77"
  }
}

Empresa desactivada

{
  "error": {
    "type": "authorization_error",
    "code": "company_inactive",
    "message": "Esta empresa está desactivada. Actívala para operar.",
    "param": "company",
    "doc_url": "https://docs.factuarea.com/guides/errors#company_inactive",
    "request_id": "req_01J8Y3M2Q40000000000000005"
  }
}

GET /v1/companies/{company}/pdf-artifacts/{artifact}/download · 404 pdf_artifact_not_found

{
  "error": {
    "type": "not_found_error",
    "code": "pdf_artifact_not_found",
    "message": "Artefacto PDF no encontrado.",
    "param": "artifact_id",
    "doc_url": "https://docs.factuarea.com/guides/errors#pdf_artifact_not_found",
    "request_id": "req_078128a1a36b0d3a8684076bf4"
  }
}

Empresa no trobada o fora de l'abast de l'API key

{
  "error": {
    "type": "not_found_error",
    "code": "profile_not_found",
    "message": "La empresa indicada no existe o no está en el ámbito de tu credencial.",
    "param": "company",
    "doc_url": "https://docs.factuarea.com/guides/errors#profile_not_found",
    "request_id": "req_01J8Y3M2Q40000000000000004"
  }
}

{
  "error": {
    "type": "not_found_error",
    "code": "pdf_signature_personal_data_forgotten",
    "message": "Los datos personales de la firma de esta presentación se han eliminado.",
    "param": "presentation_id",
    "doc_url": "https://docs.factuarea.com/guides/errors#pdf_signature_personal_data_forgotten",
    "request_id": "req_46c76dae20ebb9d5048e4c0117"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "pdf_presentation_invalid",
    "message": "La presentación documental no es válida.",
    "param": "query",
    "details": {
      "field_errors": {
        "query": [
          "La presentación documental no es válida."
        ]
      }
    },
    "doc_url": "https://docs.factuarea.com/guides/errors#pdf_presentation_invalid",
    "request_id": "req_9e9242b90a69e3bea93bcbb59c"
  }
}

Límit de peticions superat

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

Massa errors d'autenticació (bloqueig temporal)

{
  "error": {
    "type": "authentication_error",
    "code": "too_many_auth_failures",
    "message": "Has alcanzado el número máximo de intentos de autenticación fallidos. La API key queda bloqueada temporalmente. Reintenta tras el tiempo indicado en `Retry-After`.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#too_many_auth_failures",
    "request_id": "req_01HKQS5NKW1C6W9T4G5H0JBZVM"
  }
}

Massa pujades simultànies en curs

{
  "error": {
    "type": "rate_limit_error",
    "code": "upload_in_flight_budget_exceeded",
    "message": "Tu empresa tiene demasiadas subidas en curso a la vez: este archivo ocupa 10 MB y el margen simultáneo es de 120 MB. Espera a que terminen las subidas en marcha y vuelve a intentarlo dentro de 45 segundos.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#upload_in_flight_budget_exceeded",
    "request_id": "req_01HKQS5NUPLOADINFLIGHT005"
  }
}

Límit de peticions de tota l'empresa superat (totes les claus combinades)

{
  "error": {
    "type": "rate_limit_error",
    "code": "company_rate_limit_exceeded",
    "message": "Tu empresa ha superado su límite conjunto de 900 peticiones por minuto, contando a la vez todas sus credenciales. Es un techo de la empresa, así que repartir el tráfico no lo eleva. Reintenta en 12 segundos, o solicita una ampliación de plan si necesitas más capacidad.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#company_rate_limit_exceeded",
    "request_id": "req_01HKQS5NCOMPANYRATELIMIT06"
  }
}

Quota mensual de tota l'empresa exhaurida (totes les claus combinades)

{
  "error": {
    "type": "rate_limit_error",
    "code": "company_monthly_quota_exceeded",
    "message": "Tu empresa ha agotado su cuota conjunta de 150000 peticiones de este mes, contando a la vez todas sus credenciales. Es un techo de la empresa, así que repartir el tráfico no lo eleva. El contador se reinicia el día 1 del mes siguiente; solicita una ampliación de plan si necesitas más volumen antes.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#company_monthly_quota_exceeded",
    "request_id": "req_01HKQS5NCOMPANYMONTHLY0007"
  }
}

Quota mensual de l'API key esgotada

{
  "error": {
    "type": "rate_limit_error",
    "code": "monthly_quota_exceeded",
    "message": "Has agotado tu cuota mensual de 100000 requests. Mejora tu plan para obtener una cuota superior.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#monthly_quota_exceeded",
    "request_id": "req_01HKQS5NMONTHLYQUOTA000011"
  }
}

Límit de peticions de la cartera superat (tots els NIF del compte junts)

{
  "error": {
    "type": "rate_limit_error",
    "code": "portfolio_rate_limit_exceeded",
    "message": "La cartera de tu cuenta ha superado su límite conjunto de 1800 peticiones por minuto, contando a la vez todos sus NIF. Es un techo de la cartera, así que repartir el tráfico entre NIF no lo eleva. Reintenta en 12 segundos, o solicita una ampliación de plan si necesitas más capacidad.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#portfolio_rate_limit_exceeded",
    "request_id": "req_01HKQS5NPORTFOLIORATE00012"
  }
}

Quota mensual de la cartera esgotada (tots els NIF del compte junts)

{
  "error": {
    "type": "rate_limit_error",
    "code": "portfolio_monthly_quota_exceeded",
    "message": "La cartera de tu cuenta ha agotado su cuota conjunta de 300000 peticiones de este mes, contando a la vez todos sus NIF. Es un techo de la cartera, así que repartir el tráfico entre NIF no lo eleva. El contador se reinicia el día 1 del mes siguiente; solicita una ampliación de plan si necesitas más volumen antes.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#portfolio_monthly_quota_exceeded",
    "request_id": "req_01HKQS5NPORTFOLIOMONTH0013"
  }
}

GET /v1/companies/{company}/pdf-artifacts/{artifact}/download · 500 pdf_original_unavailable

{
  "error": {
    "type": "api_error",
    "code": "pdf_original_unavailable",
    "message": "El PDF original no está disponible.",
    "doc_url": "https://docs.factuarea.com/guides/errors#pdf_original_unavailable",
    "request_id": "req_3f4d9c3633cc00e3dcf5c08f23"
  }
}

GET /v1/companies/{company}/pdf-artifacts/{artifact}/download · 500 pdf_original_corrupt

{
  "error": {
    "type": "api_error",
    "code": "pdf_original_corrupt",
    "message": "No se puede verificar la integridad del PDF original.",
    "doc_url": "https://docs.factuarea.com/guides/errors#pdf_original_corrupt",
    "request_id": "req_1ff91c45904ef3d8bf6020f7df"
  }
}

GET /v1/companies/{company}/pdf-artifacts/{artifact}/download · 500 pdf_engine_profile_unavailable

{
  "error": {
    "type": "api_error",
    "code": "pdf_engine_profile_unavailable",
    "message": "El perfil de generación PDF no está disponible.",
    "doc_url": "https://docs.factuarea.com/guides/errors#pdf_engine_profile_unavailable",
    "request_id": "req_31b4896fd192cee29415cacfc3"
  }
}

GET /v1/companies/{company}/pdf-artifacts/{artifact}/download · 500 pdf_image_resource_unavailable

{
  "error": {
    "type": "api_error",
    "code": "pdf_image_resource_unavailable",
    "message": "El recurso de imagen del PDF no está disponible.",
    "doc_url": "https://docs.factuarea.com/guides/errors#pdf_image_resource_unavailable",
    "request_id": "req_c3bd1abf4bc94396da5cbb3252"
  }
}

GET /v1/companies/{company}/pdf-artifacts/{artifact}/download · 500 pdf_payload_resource_unavailable

{
  "error": {
    "type": "api_error",
    "code": "pdf_payload_resource_unavailable",
    "message": "Los recursos necesarios para preparar el PDF no están disponibles.",
    "doc_url": "https://docs.factuarea.com/guides/errors#pdf_payload_resource_unavailable",
    "request_id": "req_7608a0c5bdb5787709b7bd61dd"
  }
}

{
  "error": {
    "type": "service_unavailable_error",
    "code": "pdf_artifact_not_ready",
    "message": "El artefacto PDF todavía no está preparado.",
    "doc_url": "https://docs.factuarea.com/guides/errors#pdf_artifact_not_ready",
    "request_id": "req_9aeda4fed969100f15f28b561e"
  }
}

Descarregar el PDF retingut exacte

Authorization

Paràmetres de ruta

Headers

Cos de la resposta

200application/pdf

304

400application/json

401application/json

403application/json

404application/json

410application/json

422application/json

429application/json

500application/json

503application/json

`application/pdf`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`