Paiements

Un montant qu’un retour verse ou retient : la part payée d’une facture, une régularisation, un paiement ponctuel.

Le cycle de vie et les pièges : Retours des caisses.

Routes

Route	Effet
`GET /v1/payments/{payment}`	Lire un paiement
`GET /v1/payments`	Lister les paiements
`POST /v1/payments/{payment}/match`	Rapprocher un paiement à la main

L’objet

idtexte
L'identifiant de l'objet, préfixé par son type.
objecttexte
Le nom du type d'objet.
typeénumération
liquidationregularizationone_off_paymentone_off_deduction
parténumérationou null
amoamc
amount_centsentier
Le montant, en centimes, signé : négatif pour une retenue ou un indu.
requested_centsentierou null
Ce que la facture demandait pour cette part, en centimes.
claimtexteou null
La facture qu'il règle. Null s'il n'en suit aucune, ou s'il attend un rapprochement à la main.
matchedbooléen
Rapproché d'une facture, ou ponctuel. false : à rapprocher à la main.
remittancetexte
payouttexteou null
Le virement qui le verse ou le retient, po_….
return_codetexteou null
Le type de retour NOEMIE : 01 liquidation, 02, 03 paiement ponctuel, 04 et 05 régularisation.
invoiceobjet
La facture telle que le retour la cite.
Champs de invoice
- numbertexteobligatoireou null
- datetexteobligatoireou null
- typetexteobligatoireou null
practitioner_numbertexteou null
Le numéro de facturation du professionnel payé.
transferobjet
Le virement : son libellé, qui le retrouve sur le relevé, sa date comptable et l'organisme payeur.
Champs de transfer
- labeltexteobligatoireou null
- accounting_datetexteobligatoireou null
- payertexteobligatoireou null
debt_referencetexteou null
La référence de la dette d'une retenue.
operation_naturetexteou null
CIN constat initial, RPR repaiement.
codetexteou null
Le code d'un paiement ponctuel.
labeltexteou null
Le libellé d'un paiement ponctuel, tel que la caisse le donne.
beneficiaryobjetou null
L'assuré et le bénéficiaire lus dans un retour non rapproché, pour retrouver la facture à la main. Null une fois rapproché.
matched_atentierou null
livemodebooléen
true en production, false en mode test.
createdentierou null
La création de l'objet, en secondes Unix.

L'objet


{
  "id": "obj_…",
  "object": "payment",
  "type": "liquidation",
  "part": "amo",
  "amount_cents": 0,
  "requested_cents": 0,
  "claim": null,
  "matched": true,
  "remittance": "…",
  "payout": null,
  "return_code": null,
  "invoice": {
    "number": null,
    "date": null,
    "type": null
  },
  "practitioner_number": null,
  "transfer": {
    "label": null,
    "accounting_date": null,
    "payer": null
  },
  "debt_reference": null,
  "operation_nature": null,
  "code": null,
  "label": null,
  "beneficiary": null,
  "matched_at": null,
  "livemode": false,
  "created": 1793970000
}