Descarregar el PDF del justificant d'un pagament d'una despesa

Retorna en streaming el PDF del justificant d'un pagament d'una despesa, inclosos els pagaments parcials. - Sense payment_id, retorna el justificant del pagament actiu més recent. - Retorna 422 si no hi ha pagaments actius o si està revertit; 404 si la despesa o el payment_id no existeixen.

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

purchase_invoice*string

Identificador públic (UUID v7) de la factura de compra.

Formatuuid

Paràmetres de consulta

payment_id?|

ID (UUID v7) del pagament de la despesa del qual vols el justificant. Sense ell, el pagament vigent més recent.

Formatuuid

Headers

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/purchase-invoices/01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a01/payment-receipt", {  method: "GET",  headers: { Authorization: `Bearer ${apiKey}`, ...{"Accept":"application/pdf"} },});if (!response.ok) throw new Error(await response.text());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-Disposition: attachment; filename="COMPRA-2026-00007.pdf"

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

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

GET /v1/companies/{company}/purchase-invoices/{purchase_invoice}/payment-receipt · 403 insufficient_scope

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

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}/purchase-invoices/{purchase_invoice}/payment-receipt · 404 purchase_invoice_not_found

{
  "error": {
    "type": "not_found_error",
    "code": "purchase_invoice_not_found",
    "message": "Gasto no encontrado.",
    "param": "purchase_invoice_uuid",
    "doc_url": "https://docs.factuarea.com/guides/errors#purchase_invoice_not_found",
    "request_id": "req_03c565fc8091b2ae4b2b1cf186"
  }
}

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

El paràmetre no ha superat la validació

{
  "error": {
    "type": "invalid_request_error",
    "code": "parameter_invalid",
    "message": "El campo `name` es obligatorio y no puede estar vacío.",
    "param": "name",
    "doc_url": "https://docs.factuarea.com/guides/errors#parameter_invalid",
    "request_id": "req_01HKQS5NGS8Z3T6Q1D2E7FYVSI"
  }
}

Transició d'estat de document no vàlida

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_status_transition",
    "message": "No se puede marcar como recibido un gasto ya recibido.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#invalid_status_transition",
    "request_id": "req_01HKQS5NJV0B5V8S3F4G9HAYUK"
  }
}

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

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

Descarregar el PDF del justificant d'un pagament d'una despesa

Authorization

Paràmetres de ruta

Paràmetres de consulta

Headers

Cos de la resposta

200application/pdf

400application/json

401application/json

403application/json

404application/json

422application/json

429application/json

500application/json

`application/pdf`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`