Mettre à jour un paiement de facture

PATCH 
/api/v1/invoices/:invoice_id/payments/:id

Met à jour un paiement existant. Sur un paiement encaissé via GoCardless, amount, payment_date et payment_means_code sont immuables - ce sont des faits de l'encaissement du mandat - et soumettre l'un d'eux est refusé avec un 422. Seuls reference et note peuvent être modifiés sur un tel paiement. Sur un paiement créé en confirmant un rapprochement bancaire, seul note peut être modifié ; une requête portant tout autre attribut, même avec sa valeur actuelle, est refusée en entier avec un 422 dependent_records. Une modification de la seule note ne touche à rien d'autre - aucun évènement de cycle de vie, aucune mise à jour de l'e-reporting ni de la comptabilité.

Request

Responses

200

Le paiement a été mis à jour avec les attributs soumis

401

La requête ne comportait pas de jeton d'accès OAuth 2.0 valide

403

Le jeton d'accès ne porte pas le scope write requis pour mettre à jour le paiement

404

Aucun paiement n'existe avec l'ID donné sur cette facture

422

Le paiement n'a pas pu être mis à jour ; details signale le motif (par exemple, il appartient à une période e-reporting déjà transmise, ou il a été encaissé via GoCardless et la requête tentait de modifier son montant, sa date ou son moyen de paiement). Un paiement créé en confirmant un rapprochement bancaire répond dependent_records dès qu'un attribut autre que note est soumis, même inchangé, et details.bank_operation_id nomme l'opération dont il faut annuler la confirmation