Chargement de vos clés API…

Créer un avoir

POSThttps://api.mobupay.nc/api/v1/billing/invoices/{id}/creditNote

Ce que fait cet appel

Crée un avoir, procédure applicable après règlement.

Sans lines, l'avoir porte sur la totalité de la facture. Avec lines, il est partiel et les taxes sont recalculées sur les seules lignes remboursées : reprendre le taux global fausserait le montant sur une facture multi-taux.

netOfTax: true produit un avoir sans taxe, cas où la taxe n'est pas récupérable.

En-tête d'authentification

Authorization: Bearer sk_test_XXXX

Le pool est déduit du préfixe de la clé

Il n'y a pas d'interrupteur test et production sur cette page. sk_test_* ne traite aucun paiement réel, sk_live_* encaisse.

Paramètres

1 en-tête

idstringRequispath

Identifiant de la facture (`ivc_*`).

Corps de la requête

application/json

linesarray[object]Optionnel

Lignes concernées. Absent = avoir total.

lines[0]

productstringRequis

Dénomination PRÉCISE du bien ou du service. Mention obligatoire : « prestation » ou « divers » ne suffit pas.

descriptionstringOptionnel

Précision libre affichée sous la désignation.

quantitynumberRequis

Quantité. Strictement positive, mention obligatoire.

unitPriceCentsintegerRequis

Prix unitaire HT, dans la plus petite unité de la devise. Le franc pacifique n'a pas de décimale.

discountCentsintegerOptionnel

Remise sur cette ligne. La taxe porte sur la base NETTE, après remise.

unitstringOptionnel

Unité de mesure.

taxDetailarray[object]Optionnel

Taxes de CETTE ligne. Dès qu'une seule ligne en porte, le `taxDetail` du document est ignoré pour toutes les lignes.

catalogItemIdstringOptionnel

Élément de catalogue d'origine (`cti_*`). Les valeurs sont COPIÉES à l'ajout : modifier le catalogue ensuite ne change pas la ligne.

typestringOptionnel

Nature. Détermine l'exigibilité de la taxe : biens à la livraison, services à l'encaissement.

netOfTaxbooleanOptionnel

Avoir net de taxe.

Codes de retour

201

Brouillon d'avoir créé.

Langage

Requête cURLpostExemple

1curl --request POST \

2 --url https://api.mobupay.nc/api/v1/billing/invoices/{id}/creditNote \

3 --header 'authorization: Bearer sk_test_XXXX' \

4 --header 'content-type: application/json' \

5 --data '{ "lines": [ { "product": "Frais de déplacement", "quantity": 1, "unitPriceCents": 8000 } ] }'

Réponse

Cliquez sur Essayer pour lancer la requête et voir la réponse ici. Ou choisissez un exemple :

application/json