Skip to content

Paiements (centralisé) ​

Ces endpoints permettent à un logiciel externe utilisé par une organisation d'enregistrer, modifier ou supprimer les paiements reçus sur les factures de toutes ses structures d'accueil, sans passer par l'uuid de chaque structure.

Les URIs ci-dessous sont relatives à https://abcreche.com/api/v1.

  • {organizationUuid} : uuid de l'organisation.
  • {invoiceUuid} : uuid de la facture (voir Factures).
  • {paymentUuid} : uuid du paiement.

Le fonctionnement (montants en centimes, recalcul automatique de la facture, format de payment_date, absence de détection de doublon) est identique à l'API par structure : voir Paiements.

Headers ​

HeaderValeur
AuthorizationBearer {token}
Acceptapplication/json
Content-Typeapplication/json

Le token doit appartenir à un utilisateur lié à l'organisation, sinon l'API répond 403.

Enregistrer un paiement ​

  • HTTP Method: POST
  • URI: /organization/{organizationUuid}/invoices/{invoiceUuid}/payments

Body ​

PropertyTypeRequiredDescription
amountIntegertrueMontant du paiement, en centimes (4000 = 40,00 €). Un montant négatif enregistre un remboursement.
payment_dateDate YYYY-MM-DDtrueDate à laquelle le paiement a été reçu.
communicationStringfalseCommunication du virement.
noteStringfalseNote libre, visible par le gestionnaire dans ABCreche.

Exemple ​

http
POST /organization/5f963d99-0a8f-47e1-a04d-6c0d5b7b7d43/invoices/b1e4c9a2-6f1d-4c1b-9a77-3f0e2d5c8a10/payments
json
{
  "amount": 4000,
  "payment_date": "2026-10-01",
  "communication": "+++123/4567/89012+++"
}

Response ​

Code 201. Le paiement créé, au même format que pour l'API par structure. Conservez son uuid pour pouvoir le modifier ou le supprimer.

Lister les paiements ​

Les paiements sont inclus dans chaque facture (propriété payments) de la liste et du détail des factures centralisées. C'est la manière recommandée de les consulter.

Il existe aussi un endpoint dédié :

  • HTTP Method: GET
  • URI: /organization/{organizationUuid}/invoices/{invoiceUuid}/payments

Il retourne directement un tableau de paiements (sans enveloppe data), au même format que l'API par structure.

Modifier un paiement ​

  • HTTP Method: PUT
  • URI: /organization/{organizationUuid}/invoices/{invoiceUuid}/payments/{paymentUuid}

Mêmes champs que pour l'enregistrement. amount et payment_date sont obligatoires à chaque modification.

json
{
  "amount": 5000,
  "payment_date": "2026-10-02"
}

La réponse est le paiement mis à jour :

json
{
  "uuid": "212809b6-5f5f-4d53-b7df-c704acbbe993",
  "amount": 5000,
  "communication": "+++123/4567/89012+++",
  "note": null,
  "payment_date": "2026-10-01T22:00:00.000000Z",
  "...": "..."
}

INFO

Le déplacement d'un paiement vers une autre facture (invoice_uuid) n'est disponible que sur l'API par structure.

Supprimer un paiement ​

  • HTTP Method: DELETE
  • URI: /organization/{organizationUuid}/invoices/{invoiceUuid}/payments/{paymentUuid}
json
{
  "success": true
}

Gestion des erreurs ​

CodeSignificationAction recommandée
401Token absent, invalide ou expiré.Se ré-authentifier via /authenticate.
403L'utilisateur n'est pas lié à l'organisation, ou le paiement n'appartient pas à cette facture / organisation.Vérifier les UUIDs utilisés.
404Facture ou paiement introuvable.Vérifier les UUIDs utilisés.
422Données invalides (ex. : amount ou payment_date manquant).Corriger le payload selon les erreurs retournées.

Documentation ABCreche

Connectez-vous avec vos identifiants ABCreche pour accéder à la documentation.