Liste des règlements

GET /firms/FIRM_ID/invoices/ID/settlements.json

Liste les différents règlements enregistrés pour la facture n° ID.

Requête

curl -i -S -u login:password -H 'User-Agent: MonApp (moi@exemple.com)' \
 "https://www.facturation.pro/firms/FIRM_ID/invoices/ID/settlements.json"

Réponse

[{
   "id": 14064,
   "invoice_id": ID,
   "total": "1000.0",
   "payment_mode": 2,
   "paid_on": "2015-09-07",
   "payment_ref": null
 }, {
   "id": 14065,
   "invoice_id": ID,
   "total": "2000.0",
   "payment_mode": 4,
   "paid_on": "2015-09-03"
   "payement_ref": "ma référence"
}]

Détail d'un règlement

GET /firms/FIRM_ID/invoices/INVOICE_ID/settlements/ID.json

Affiche le détail du règlement n° ID pour la facture n° INVOICE_ID

Requête

curl -i -S -u login:password -H 'User-Agent: MonApp (moi@exemple.com)' \
 "/firms/FIRM_ID/invoices/ID/settlements/14064.json"

Réponse

{
   "id": 14064,
   "invoice_id": ID,
   "total": "1000.0",
   "payment_mode": 2,
   "paid_on": "2015-09-07",
   "payment_ref": null
}

Créer un règlement

POST /firms/FIRM_ID/invoices/INVOICE_ID/settlements.json

Enregistre un nouveau règlement partiel pour la facture n° INVOICE_ID. On obtient en retour le code JSON du règlement créé, avec l'ID qui lui a été attribué

Remarque

Lorsque le règlement enregistré solde la facture, la facture est automatiquement marquée comme payée à la date et avec le mode de règlement du dernier règlement enregistré.

Requête

curl -i -S -u login:password -H 'User-Agent: MonApp (moi@exemple.com)' \
 -H 'Content-Type: application/json; charset=utf-8' \
 -X POST \
 -d '{
   "invoice_id": ID,
   "total": "100.0",
   "payment_mode": 1,
   "paid_on": "2020-02-29",
   "payment_ref": "XYZ"
  }' \
 "https://www.facturation.pro/firms/FIRM_ID/invoices/ID/settlements.json"

Réponse

Status: 201 Created
Location: /firms/FIRM_ID/invoices/ID/settlements/1.json

{
   "id": 1,
   "invoice_id": ID,
   "total": "100.0",
   "payment_mode": 1,
   "paid_on": "2020-02-29",
   "payment_ref": XYZ
}

Supprimer un règlement

DELETE /firms/FIRM_ID/invoices/INVOICE_ID/settlements/ID.json

Supprime le règlement identifié par son ID. A noter que la suppression de l'un des règlements d'une facture entièrement soldée remet automatiquement la facture dans l'état "non payée".

Requête

curl -i -S -u login:password -H 'User-Agent: MonApp (moi@exemple.com)' \
 -X DELETE \
 "https://www.facturation.pro/firms/FIRM_ID/invoices/ID/settlements/14064.json"

Réponse

Status: 200 OK

Liste des champs

Champs Libellé Type Accès
id Identifiant int(11) lecture seule
invoice_id Identifiant facture int(11) lecture/écriture
total Montant du règlement decimal(15,3) lecture/écriture
payment_mode Mode de règlement int(11) lecture/écriture
paid_on Payé le date lecture/écriture
payment_ref Référence du paiement string(255) lecture/écriture

Champs utilisant des valeurs spécifiques

payment_mode

0 : Non payé
2 : Carte bancaire
4 : Chèque
3 : Virement
5 : Espèces
1 : Paypal
8 : Prélèvement
9 : TIP (Titre interbancaire de paiement)
30 : Ticket restaurant
31 : Chèque cadeau
32 : Chèque vacances
50 : LCR (Lettre de change relevé)
51 : BOR (Billet à ordre relevé)
99 : Autre
999 : Créance irrécouvrable