Règlements

Les règlements correspondent aux paiements enregistrés sur une facture (pièce commerciale).
Un règlement peut être effectué par un client ou par un tiers payeur.

Un règlement contient notamment :

• le montant du paiement
• la date de règlement
• le mode de règlement (chèque, carte bancaire, virement, etc.)
• le payeur (tiers)
• la banque / caisse utilisée pour l’encaissement
• une ou plusieurs ventilations, qui indiquent sur quelle(s) facture(s) le règlement est affecté

Structure d’un règlement

Champ	Description
montant	Montant total du règlement
dateReglement	Date du règlement
numeroReglement	Numéro du règlement
modeReglement	Mode de règlement (code, libellé)
isRemboursement	Indique si le règlement est un remboursement
ventilationDtos	Liste des ventilations sur facture(s)
ventilationDtos[].montant	Montant ventilé sur la facture
ventilationDtos[].facturePayeur.pieceCommerciale.entetePieceCommerciale.numeroPiece	Numéro de la facture (pièce commerciale)
site	Site rattaché au règlement
banqueCaisse	Journal / banque / caisse d’encaissement
payeur	Tiers qui effectue le règlement (client ou tiers payeur)
statut	Statut du règlement

Extrait d’exemple :

{
  "montant": 169.0,
  "dateReglement": "2026-02-07T23:00:00.000+00:00",
  "numeroReglement": "RE210005",
  "modeReglement": { "code": "CTB", "libelle": "Carte bancaire" },
  "isRemboursement": false,
  "ventilationDtos": [
    {
      "montant": 169.0,
      "facturePayeur": {
        "pieceCommerciale": {
          "entetePieceCommerciale": {
            "numeroPiece": "F212600026",
            "typeFacture": "Facture"
          }
        }
      }
    }
  ],
  "payeur": { "codeTiers": "CLI00773" },
  "statut": { "code": "REGECR", "libelle": "En cours" }
}

Pagination

Les endpoints de lecture retournent une liste paginée.

Structure :

Champ	Description
content	Liste des règlements
totalPages	Nombre total de pages
totalElements	Nombre total de règlements
pageable.pageNumber	Numéro de la page courante
pageable.pageSize	Nombre d’éléments par page

Exemple de réponse :

{
  "content": [
    {
      "montant": 169.0,
      "dateReglement": "2026-02-07T23:00:00.000+00:00",
      "numeroReglement": "RE210005",
      "modeReglement": { "code": "CTB", "libelle": "Carte bancaire" },
      "ventilationDtos": [
        {
          "montant": 169.0,
          "facturePayeur": {
            "pieceCommerciale": {
              "entetePieceCommerciale": { "numeroPiece": "F212600026" }
            }
          }
        }
      ]
    }
  ],
  "totalPages": 4,
  "totalElements": 36,
  "pageable": { "pageNumber": 0, "pageSize": 10 }
}

Liste des endpoints disponibles

GET /v1/reglement/all

Retourne la liste paginée de tous les règlements.

Paramètres :

Paramètre	Type	Obligatoire	Description
codeBu	string	oui	Code de la BU (société)
page	integer	oui	Numéro de page (commence à 0)

Exemple :

GET /v1/reglement/all?codeBu={{codeBu}}&page=0

---

GET /v1/reglement/latest

Retourne la liste paginée des règlements créés ou modifiés depuis une date.

Paramètres :

Paramètre	Type	Obligatoire	Description
codeBu	string	oui	Code de la BU (société)
depuis	string	oui	Date de début de synchronisation
page	integer	oui	Numéro de page (commence à 0)

Format de la date :

dd/MM/yyyy HH:mm:ss

Exemple :

GET /v1/reglement/latest?codeBu={{codeBu}}&depuis=01/01/2026 00:00:00&page=0

---

POST /v1/reglement/client/create

Crée un règlement client et le ventile sur une ou plusieurs factures.

Paramètres :

Query :

Paramètre	Type	Obligatoire	Description
codeBu	string	oui	Code de la BU (société)

Body (JSON) :

Champ	Type	Obligatoire	Description
codeTiers	string	oui	Code du payeur (client ou tiers payeur)
montant	number	oui	Montant total du règlement
libelleBanque	string	non	Libellé banque (information)
modeReglement	string	oui	Code mode de règlement (ex: CHQ, CTB, VRM)
dateReglement	string	oui	Date du règlement (format ISO)
infoReglement	string	non	Information libre
ventilations	array	oui	Liste des ventilations sur factures
ventilations[].montant	number	oui	Montant ventilé
ventilations[].numeroPieceCommerciale	string	oui	Numéro de facture (pièce commerciale)

Exemple :

POST /v1/reglement/client/create?codeBu={{codeBu}}
Authorization: Bearer {{access_token}}
Content-Type: application/json

{
  "codeTiers": "CLI00001",
  "montant": 500,
  "libelleBanque": "BNP Paribas",
  "modeReglement": "VRM",
  "dateReglement": "2026-02-10T00:00:00",
  "infoReglement": "Règlement facture",
  "ventilations": [
    { "montant": 250, "numeroPieceCommerciale": "F212600026" },
    { "montant": 250, "numeroPieceCommerciale": "F212600027" }
  ]
}

---

PUT /v1/reglement/client/update/{id}

Met à jour un règlement existant.

Paramètres :

Path :

Paramètre	Type	Obligatoire	Description
id	integer	oui	Identifiant technique du règlement

Query :

Paramètre	Type	Obligatoire	Description
codeBu	string	oui	Code de la BU (société)

Body : même structure que la création.

Exemple :

PUT /v1/reglement/client/update/199613?codeBu={{codeBu}}
Authorization: Bearer {{access_token}}
Content-Type: application/json

---

DELETE /v1/reglement/client/delete/{id}

Supprime un règlement.

Paramètres :

Path :

Paramètre	Type	Obligatoire	Description
id	integer	oui	Identifiant technique du règlement

Query :

Paramètre	Type	Obligatoire	Description
codeBu	string	oui	Code de la BU (société)

Exemple :

DELETE /v1/reglement/client/delete/199613?codeBu={{codeBu}}
Authorization: Bearer {{access_token}}