Renderitzar un artefacte PDF preparat

Genera un artefacte preparat.

mode és obligatori: sync espera el resultat i async el posa a la cua.
L'artefacte es retorna en estat ready (200) o encara pendent (202); consulta periòdicament l'operació de detall mentre estigui en queued o processing.
Generar un artefacte que ja està llest no canvia res.
Consumeix del pressupost de generació de PDF.
Requereix pdfs:read i Idempotency-Key.

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

Clau opaca generada pel client (fins a 255 caràcters; es recomana UUID v7) que permet reintents segurs: la primera resposta s'emmagatzema i es reprodueix en les repeticions sense tornar a executar la mutació. Reutilitzar una clau amb un cos diferent retorna 422 idempotency_key_reused; els valors dels camps secrets (password, secret…) compten com a part del cos, així que reintentar amb un secret corregit sota la mateixa clau és una petició diferent, mai la repetició de la resposta anterior. Consulta la guia d'idempotència. Obligatòria en aquesta operació: repetir-la produeix un efecte irreversible (un correu enviat, un fitxer generat, una crida a un tercer o un càrrec), per la qual cosa una petició sense aquesta capçalera es rebutja amb 422 idempotency_key_required abans d'executar lògica de negoci.

Longitud1 <= length <= 255

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 petició

application/json

La preparació o generació interna reversible utilitza la política d'idempotència existent; la mateixa clau amb el mateix cos cru es reprodueix, i un altre cos amb aquesta clau es rebutja amb 422 idempotency_key_reused abans de l'admissió.

Definicions de TypeScript

Usa el tipus request body a TypeScript.

mode*string

Valor a"sync" | "async"

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/companies/01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a01/pdf-artifacts/01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a01/render", {  method: "POST",  headers: { Authorization: `Bearer ${apiKey}`, ...{"Accept":"application/json","Content-Type":"application/json","Idempotency-Key":"erp-2026-public-api-v1-pdf_artifacts-render"} },  body: JSON.stringify({  "mode": "sync"}),});if (!response.ok) throw new Error(await response.text());if (response.status !== 204) console.log(await response.json());

Exemple de resposta

{
  "data": {
    "id": "019e8a31-4c5d-7b2e-9a10-5f3c7d2e8b64",
    "purpose": "document",
    "state": "ready",
    "document_id": "019e8a2f-17de-7a63-b5c2-8e4d0f6a3b19",
    "source_kind": "captured",
    "context_authority": "captured",
    "context_fingerprint": "23b74a6b524e0570a9927a7156f49ad01e0dd86137d026cd71e0973045397cbf",
    "expected_preview_context_fingerprint": null,
    "source_token": "15dcaa3fb565dfd9b01e24ad81ffd47f4bfb1c280658083da79cb64eb1d5eacf",
    "selection_version": 3,
    "template_revision_id": "019e8a1c-0b3a-7e95-9c64-d27a8f1b5e30",
    "commercial_identity_revision_id": "019e8a1d-5e72-7f01-8b3a-4c9d6e2a1f58",
    "artifact_fingerprint": "919fed874f0141c9b0ce5a2d7fdf6b58dbbb4bafafbcfcf80b09ac7e2d129b47",
    "sha256": "1a05e1535a4c69d0985fc7b13aa00539ff60bac13dba9b20046d609ead5f2274",
    "size_bytes": 48213,
    "expires_at": null,
    "effective_font": {
      "requested_family": "inter",
      "effective_family": "Inter",
      "files": [
        {
          "name": "pdf/layouts/v1/fonts/Inter-variable.ttf",
          "sha256": "88e44d564deda3edaae388f942ac9a8432c7eeb6ad9e15fff58b8e4a9d7c33d6"
        },
        {
          "name": "pdf/layouts/v1/fonts/Inter-italic-variable.ttf",
          "sha256": "a30cf214781a103ef47f815863a8204127da09c08435c9254fe8a79ab0ca9086"
        },
        {
          "name": "pdf/layouts/v1/fonts/LiberationSans-Regular.ttf",
          "sha256": "4de25902c05149a8ac7d01103cb22b04512ca32c42c5e22ab6c8e25929fab717"
        },
        {
          "name": "pdf/layouts/v1/fonts/LiberationSans-Bold.ttf",
          "sha256": "56839678d77eb0608b7a91f69a59c6d7ef55a7ffe88740b1a56df0b2a4e0b51b"
        },
        {
          "name": "pdf/layouts/v1/fonts/LiberationSans-Italic.ttf",
          "sha256": "453e66623b5e5b2999759ef2192862e7a4326b3f9e527b40c1ad3bb1ee177829"
        },
        {
          "name": "pdf/layouts/v1/fonts/LiberationSans-BoldItalic.ttf",
          "sha256": "b8f4dc5fc85a11593d60696ac4d5fed9430bc419d6d2f209ab5e39d34dfd22e2"
        },
        {
          "name": "pdf/layouts/v1/fonts/JetBrainsMono-Regular.ttf",
          "sha256": "0c06ec9f2129b2bffee4bddaab40ae45c3026c8dfb050825edb2ee0179fda35e"
        },
        {
          "name": "pdf/layouts/v1/fonts/JetBrainsMono-Bold.ttf",
          "sha256": "3d8eafe83d407ba97e695900c148fce20c1da4e6f0e7c05ebc2f4acc0ac3ca63"
        },
        {
          "name": "pdf/layouts/v1/fonts/JetBrainsMono-Italic.ttf",
          "sha256": "c55d5c8aa80a1736ec78058bfd85fdd6e2fc7ce0248b527aa30a3f8d2d6bcf04"
        },
        {
          "name": "pdf/layouts/v1/fonts/JetBrainsMono-BoldItalic.ttf",
          "sha256": "249c6e7602c3b8aecec9850cb20b5c5bb059960d6dfef0edfefeabe395fa4890"
        }
      ],
      "reasons": []
    },
    "warnings": [],
    "geometry": {
      "format": "a4",
      "orientation": "portrait",
      "width_mm": 210,
      "height_mm": 297
    },
    "metadata_url": "https://api.factuarea.com/v1/companies/0193f1a0-5c2e-7b41-8d06-9a1e2f3c4d5e/pdf-artifacts/019e8a31-4c5d-7b2e-9a10-5f3c7d2e8b64",
    "download_url": "https://api.factuarea.com/v1/companies/0193f1a0-5c2e-7b41-8d06-9a1e2f3c4d5e/pdf-artifacts/019e8a31-4c5d-7b2e-9a10-5f3c7d2e8b64/download",
    "retry_after": null,
    "error": null,
    "unavailable_reason": null
  }
}

POST /v1/companies/{company}/pdf-artifacts/{artifact}/render · 202 queued artifact

{
  "data": {
    "id": "019e8a31-4c5d-7b2e-9a10-5f3c7d2e8b64",
    "purpose": "document",
    "state": "queued",
    "document_id": "019e8a2f-17de-7a63-b5c2-8e4d0f6a3b19",
    "source_kind": "captured",
    "context_authority": "captured",
    "context_fingerprint": "23b74a6b524e0570a9927a7156f49ad01e0dd86137d026cd71e0973045397cbf",
    "expected_preview_context_fingerprint": null,
    "source_token": "15dcaa3fb565dfd9b01e24ad81ffd47f4bfb1c280658083da79cb64eb1d5eacf",
    "selection_version": 3,
    "template_revision_id": "019e8a1c-0b3a-7e95-9c64-d27a8f1b5e30",
    "commercial_identity_revision_id": "019e8a1d-5e72-7f01-8b3a-4c9d6e2a1f58",
    "artifact_fingerprint": "919fed874f0141c9b0ce5a2d7fdf6b58dbbb4bafafbcfcf80b09ac7e2d129b47",
    "sha256": null,
    "size_bytes": null,
    "expires_at": null,
    "effective_font": {
      "requested_family": "inter",
      "effective_family": "Inter",
      "files": [
        {
          "name": "pdf/layouts/v1/fonts/Inter-variable.ttf",
          "sha256": "88e44d564deda3edaae388f942ac9a8432c7eeb6ad9e15fff58b8e4a9d7c33d6"
        },
        {
          "name": "pdf/layouts/v1/fonts/Inter-italic-variable.ttf",
          "sha256": "a30cf214781a103ef47f815863a8204127da09c08435c9254fe8a79ab0ca9086"
        },
        {
          "name": "pdf/layouts/v1/fonts/LiberationSans-Regular.ttf",
          "sha256": "4de25902c05149a8ac7d01103cb22b04512ca32c42c5e22ab6c8e25929fab717"
        },
        {
          "name": "pdf/layouts/v1/fonts/LiberationSans-Bold.ttf",
          "sha256": "56839678d77eb0608b7a91f69a59c6d7ef55a7ffe88740b1a56df0b2a4e0b51b"
        },
        {
          "name": "pdf/layouts/v1/fonts/LiberationSans-Italic.ttf",
          "sha256": "453e66623b5e5b2999759ef2192862e7a4326b3f9e527b40c1ad3bb1ee177829"
        },
        {
          "name": "pdf/layouts/v1/fonts/LiberationSans-BoldItalic.ttf",
          "sha256": "b8f4dc5fc85a11593d60696ac4d5fed9430bc419d6d2f209ab5e39d34dfd22e2"
        },
        {
          "name": "pdf/layouts/v1/fonts/JetBrainsMono-Regular.ttf",
          "sha256": "0c06ec9f2129b2bffee4bddaab40ae45c3026c8dfb050825edb2ee0179fda35e"
        },
        {
          "name": "pdf/layouts/v1/fonts/JetBrainsMono-Bold.ttf",
          "sha256": "3d8eafe83d407ba97e695900c148fce20c1da4e6f0e7c05ebc2f4acc0ac3ca63"
        },
        {
          "name": "pdf/layouts/v1/fonts/JetBrainsMono-Italic.ttf",
          "sha256": "c55d5c8aa80a1736ec78058bfd85fdd6e2fc7ce0248b527aa30a3f8d2d6bcf04"
        },
        {
          "name": "pdf/layouts/v1/fonts/JetBrainsMono-BoldItalic.ttf",
          "sha256": "249c6e7602c3b8aecec9850cb20b5c5bb059960d6dfef0edfefeabe395fa4890"
        }
      ],
      "reasons": []
    },
    "warnings": [],
    "geometry": {
      "format": "a4",
      "orientation": "portrait",
      "width_mm": 210,
      "height_mm": 297
    },
    "metadata_url": "https://api.factuarea.com/v1/companies/0193f1a0-5c2e-7b41-8d06-9a1e2f3c4d5e/pdf-artifacts/019e8a31-4c5d-7b2e-9a10-5f3c7d2e8b64",
    "download_url": null,
    "retry_after": 1,
    "error": null,
    "unavailable_reason": null
  }
}

POST /v1/companies/{company}/pdf-artifacts/{artifact}/render · 202 processing artifact

{
  "data": {
    "id": "019e8a31-4c5d-7b2e-9a10-5f3c7d2e8b64",
    "purpose": "document",
    "state": "processing",
    "document_id": "019e8a2f-17de-7a63-b5c2-8e4d0f6a3b19",
    "source_kind": "captured",
    "context_authority": "captured",
    "context_fingerprint": "23b74a6b524e0570a9927a7156f49ad01e0dd86137d026cd71e0973045397cbf",
    "expected_preview_context_fingerprint": null,
    "source_token": "15dcaa3fb565dfd9b01e24ad81ffd47f4bfb1c280658083da79cb64eb1d5eacf",
    "selection_version": 3,
    "template_revision_id": "019e8a1c-0b3a-7e95-9c64-d27a8f1b5e30",
    "commercial_identity_revision_id": "019e8a1d-5e72-7f01-8b3a-4c9d6e2a1f58",
    "artifact_fingerprint": "919fed874f0141c9b0ce5a2d7fdf6b58dbbb4bafafbcfcf80b09ac7e2d129b47",
    "sha256": null,
    "size_bytes": null,
    "expires_at": null,
    "effective_font": {
      "requested_family": "inter",
      "effective_family": "Inter",
      "files": [
        {
          "name": "pdf/layouts/v1/fonts/Inter-variable.ttf",
          "sha256": "88e44d564deda3edaae388f942ac9a8432c7eeb6ad9e15fff58b8e4a9d7c33d6"
        },
        {
          "name": "pdf/layouts/v1/fonts/Inter-italic-variable.ttf",
          "sha256": "a30cf214781a103ef47f815863a8204127da09c08435c9254fe8a79ab0ca9086"
        },
        {
          "name": "pdf/layouts/v1/fonts/LiberationSans-Regular.ttf",
          "sha256": "4de25902c05149a8ac7d01103cb22b04512ca32c42c5e22ab6c8e25929fab717"
        },
        {
          "name": "pdf/layouts/v1/fonts/LiberationSans-Bold.ttf",
          "sha256": "56839678d77eb0608b7a91f69a59c6d7ef55a7ffe88740b1a56df0b2a4e0b51b"
        },
        {
          "name": "pdf/layouts/v1/fonts/LiberationSans-Italic.ttf",
          "sha256": "453e66623b5e5b2999759ef2192862e7a4326b3f9e527b40c1ad3bb1ee177829"
        },
        {
          "name": "pdf/layouts/v1/fonts/LiberationSans-BoldItalic.ttf",
          "sha256": "b8f4dc5fc85a11593d60696ac4d5fed9430bc419d6d2f209ab5e39d34dfd22e2"
        },
        {
          "name": "pdf/layouts/v1/fonts/JetBrainsMono-Regular.ttf",
          "sha256": "0c06ec9f2129b2bffee4bddaab40ae45c3026c8dfb050825edb2ee0179fda35e"
        },
        {
          "name": "pdf/layouts/v1/fonts/JetBrainsMono-Bold.ttf",
          "sha256": "3d8eafe83d407ba97e695900c148fce20c1da4e6f0e7c05ebc2f4acc0ac3ca63"
        },
        {
          "name": "pdf/layouts/v1/fonts/JetBrainsMono-Italic.ttf",
          "sha256": "c55d5c8aa80a1736ec78058bfd85fdd6e2fc7ce0248b527aa30a3f8d2d6bcf04"
        },
        {
          "name": "pdf/layouts/v1/fonts/JetBrainsMono-BoldItalic.ttf",
          "sha256": "249c6e7602c3b8aecec9850cb20b5c5bb059960d6dfef0edfefeabe395fa4890"
        }
      ],
      "reasons": []
    },
    "warnings": [],
    "geometry": {
      "format": "a4",
      "orientation": "portrait",
      "width_mm": 210,
      "height_mm": 297
    },
    "metadata_url": "https://api.factuarea.com/v1/companies/0193f1a0-5c2e-7b41-8d06-9a1e2f3c4d5e/pdf-artifacts/019e8a31-4c5d-7b2e-9a10-5f3c7d2e8b64",
    "download_url": null,
    "retry_after": 1,
    "error": null,
    "unavailable_reason": null
  }
}

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

POST /v1/companies/{company}/pdf-artifacts/{artifact}/render · 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_11d04eb895bf530805ee1df0bb"
  }
}

POST /v1/companies/{company}/pdf-artifacts/{artifact}/render · 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_56b784ea672021aff2312afb00"
  }
}

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

POST /v1/companies/{company}/pdf-artifacts/{artifact}/render · 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_a50ae389c3271c52561b808aab"
  }
}

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

POST /v1/companies/{company}/pdf-artifacts/{artifact}/render · 422 pdf_presentation_invalid

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

POST /v1/companies/{company}/pdf-artifacts/{artifact}/render · 422 idempotency_key_required

{
  "error": {
    "type": "invalid_request_error",
    "code": "idempotency_key_required",
    "message": "La operación «public-api.v1.pdf_artifacts.render» exige la cabecera Idempotency-Key desde el 2026-12-01. Envía una clave única por operación (un UUID sirve) y, si reintenta, repite exactamente la misma clave para que la operación no se ejecute dos veces.",
    "param": "Idempotency-Key",
    "doc_url": "https://docs.factuarea.com/guides/errors#idempotency_key_required",
    "request_id": "req_3f7fe9728f741cb852415b0d84"
  }
}

Idempotency key reutilitzada amb un payload diferent

{
  "error": {
    "type": "idempotency_error",
    "code": "idempotency_key_reused",
    "message": "La Idempotency-Key 'order-2026-0001' ya se usó con un payload distinto.",
    "param": "Idempotency-Key",
    "doc_url": "https://docs.factuarea.com/guides/errors#idempotency_key_reused",
    "request_id": "req_01J8Y3M2Q40000000000000007"
  }
}

Format d'Idempotency-Key no vàlid

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_param_format",
    "message": "La Idempotency-Key debe tener entre 1 y 255 caracteres ASCII printable.",
    "param": "Idempotency-Key",
    "doc_url": "https://docs.factuarea.com/guides/errors#invalid_param_format",
    "request_id": "req_01J8Y3M2Q40000000000000008"
  }
}

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

POST /v1/companies/{company}/pdf-artifacts/{artifact}/render · 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_225e36d7f3c0fc5e5f4552591f"
  }
}

POST /v1/companies/{company}/pdf-artifacts/{artifact}/render · 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_953c0d9f3e4624097d790e3008"
  }
}

POST /v1/companies/{company}/pdf-artifacts/{artifact}/render · 500 pdf_original_layout_unavailable

{
  "error": {
    "type": "api_error",
    "code": "pdf_original_layout_unavailable",
    "message": "El diseño con el que se generó el PDF original ya no está disponible en esta versión de Factuarea.",
    "doc_url": "https://docs.factuarea.com/guides/errors#pdf_original_layout_unavailable",
    "request_id": "req_8842803727c1db783c4056ff4f"
  }
}

POST /v1/companies/{company}/pdf-artifacts/{artifact}/render · 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_ed4a3dc2f94e9054e1eafced36"
  }
}

POST /v1/companies/{company}/pdf-artifacts/{artifact}/render · 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_cd823e89adbd511211813141fc"
  }
}

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

Renderitzar un artefacte PDF preparat

Authorization

Paràmetres de ruta

Headers

Cos de la petició

Cos de la resposta

200application/json

202application/json

400application/json

401application/json

403application/json

404application/json

410application/json

422application/json

429application/json

500application/json

503application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`