Registrar un pagament de factura de compra

Registra un pagament parcial (o total) contra una factura de compra i l'afegeix al seu llibre de pagaments.

Cos: amount, paid_on, payment_method, més els opcionals bank_account_id, reference i notes.
Es comproven tres invariants que retornen 422: l'import ha de ser més gran que zero i no superior al saldo pendent, paid_on ha de caure entre la data d'emissió de la factura i avui, i una factura cancel·lada no admet pagaments.
Tan bon punt els pagaments acumulats cobreixen el total, la factura se salda sola — no cal que cridis també mark_paid.
Retorna 201 amb el pagament acabat de crear i un header Location que apunta al llibre de pagaments.

Clau opaca generada pel client (fins a 255 caràcters; es recomana UUID v7) que fa segurs els reintents: la primera resposta es cacheja i es reprodueix a les repeticions sense tornar a executar la mutació. Reutilitzar una clau amb un cos diferent retorna 409 idempotency_key_reused. Consulta la guia d'Idempotency.

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

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.

amount*number

Rangvalue <= 99999999.99

paid_on*string

Formatdate

payment_method*string

Longitudlength <= 30

bank_account_id?integer|null

reference?|

Longitudlength <= 255

notes?|

Longitudlength <= 1000

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/purchase_invoices/01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a01/payments", {  method: "POST",  headers: { Authorization: `Bearer ${apiKey}`, ...{"Accept":"application/json","Content-Type":"application/json","Idempotency-Key":"erp-2026-public-api-v1-purchase_invoices-register_payment"} },  body: JSON.stringify({  "amount": 100,  "paid_on": "2026-03-15",  "payment_method": "bank_transfer"}),});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-3c5d6e7f8e02",
    "object": "purchase_invoice_payment",
    "amount": 200,
    "paid_on": "2026-03-16",
    "payment_method": "bank_transfer",
    "bank_account_id": null,
    "reference": "TRF-PROV-2026-0007",
    "notes": "Primer pago parcial.",
    "is_reversed": false,
    "reversed_at": null,
    "reversal_reason": null,
    "reversal_reason_text": null,
    "reversal_note": null,
    "created_at": "2026-03-16T10:00: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_0393996680952332830f493897"
  }
}

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

{
  "error": {
    "type": "not_found_error",
    "code": "purchase_invoice_not_found",
    "message": "Factura de compra no encontrada.",
    "param": "purchase_invoice_uuid",
    "doc_url": "https://docs.factuarea.com/guides/errors#purchase_invoice_not_found",
    "request_id": "req_1e6496ca0cb931ecffc659e4e1"
  }
}

{
  "error": {
    "type": "conflict_error",
    "code": "resource_conflict",
    "message": "La operación chocó con el estado actual del recurso y no aplica ningún código de conflicto más específico.",
    "doc_url": "https://docs.factuarea.com/guides/errors#resource_conflict",
    "request_id": "req_0d5c4d1135d883e28313d33d35"
  }
}

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

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

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

Registrar un pagament de factura de compra

Authorization

Paràmetres de ruta

Headers

Cos de la petició

Cos de la resposta

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Registrar un pagament de factura de compra

Authorization

Paràmetres de ruta

Headers

Cos de la petició

Cos de la resposta

201application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`