Anul·lar un pagament d'una factura

Anul·la un pagament registrat contra una factura, indicant-ne el motiu.

El pagament conserva el seu import, data, mètode i referència, i queda marcat com a anul·lat (is_reversed: true) juntament amb el motiu, l'instant i l'autor — mai no s'esborra, perquè un pagament que va existir i va deixar de tenir efecte és informació comptable.
reason és obligatori i pertany a un catàleg tancat: direct_debit_return (devolució de rebut SEPA), card_dispute (disputa o retrocessió de targeta), misapplied_payment (imputat a la factura equivocada), bounced_effect (efecte impagat) i recording_error.
Un valor fora del catàleg retorna 422 payment_reversal_reason_invalid.
note és una nota lliure opcional de fins a 500 caràcters; superar-los retorna 422 payment_reversal_invalid.
Anul·lar un pagament que ja està anul·lat retorna 422 payment_already_reversed.
Un pagament anul·lat deixa de computar en paid_amount, pending_amount i en qualsevol agregat de tresoreria, així que la factura torna al circuit de cobrament: overdue si la seva data de venciment ja ha passat, sent altrament, i torna a admetre un pagament nou.
Aquesta transició es deriva del registre de pagaments i només pot originar-se aquí — l'endpoint genèric de canvi d'estat no pot treure una factura de paid.
Reemborsament o anul·lació? Anul·la quan el client va recuperar els seus diners sense que l'operació es minori (devolució de rebut, retrocessió, error d'imputació): el deute continua viu i el vols cobrar.
Emet una factura rectificativa (POST /v1/invoices/{id}/corrective) quan el que es minora és l'operació mateixa — aquí és on els ingressos baixen de debò.
Anul·lar mai no emet una rectificativa, i un rebut retornat no és un crèdit incobrable (l'art. 80.Cuatro LIVA té els seus propis requisits formals).
Irreversible: no hi ha des-anul·lació.
Per refer el cobrament, registra un pagament nou.

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 409 idempotency_key_reused. 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

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.

reason*string

Motiu pel qual s'anul·la el pagament. Un del catàleg tancat: direct_debit_return (devolució de rebut SEPA), card_dispute (disputa o retrocessió de targeta), misapplied_payment (imputat a la factura equivocada), bounced_effect (efecte impagat) o recording_error (error de registre). Qualsevol altre valor retorna 422 payment_reversal_reason_invalid.

note?|

Nota lliure opcional que es conserva amb el rastre de l'anul·lació, de fins a 500 caràcters. Una nota més llarga retorna 422 payment_reversal_invalid.

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/invoices/01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a01/payments/01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a01/reversal", {  method: "POST",  headers: { Authorization: `Bearer ${apiKey}`, ...{"Accept":"application/json","Content-Type":"application/json","Idempotency-Key":"erp-2026-public-api-v1-invoices-payments_revert"} },  body: JSON.stringify({  "reason": "direct_debit_return",  "note": "Recibo devuelto por el banco; el cliente domicilia de nuevo el día 5."}),});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-3c5d6e7f8a90",
    "object": "payment",
    "invoice_id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a42",
    "amount": 605,
    "payment_date": "2026-03-20",
    "payment_method": "bank_transfer",
    "payment_method_text": "Transferencia bancaria",
    "reference": "TRF-2026-0042",
    "notes": "Pago parcial primer plazo.",
    "is_reversed": false,
    "reversed_at": null,
    "reversal_reason": null,
    "reversal_reason_text": null,
    "reversal_note": null,
    "created_at": null,
    "updated_at": null
  }
}

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

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

{
  "error": {
    "type": "not_found_error",
    "code": "invoice_not_found",
    "message": "Factura no encontrada.",
    "param": "invoice_uuid",
    "subcode": "invoice_not_found",
    "doc_url": "https://docs.factuarea.com/guides/errors#invoice_not_found",
    "request_id": "req_44df733277d320ae89f156f812"
  }
}

{
  "error": {
    "type": "idempotency_error",
    "code": "idempotency_key_reused",
    "message": "Esa `Idempotency-Key` ya se usó con un payload distinto. La clave identifica una operación concreta, así que reutilizarla para otra vaciaría de sentido el replay.",
    "doc_url": "https://docs.factuarea.com/guides/errors#idempotency_key_reused",
    "request_id": "req_1622a599ce05bb17ee38e762f7"
  }
}

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

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

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

Anul·lar un pagament d'una factura

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`

Anul·lar un pagament d'una factura

Authorization

Paràmetres de ruta

Headers

Cos de la petició

Cos de la resposta

200application/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`