Aller au contenu principal

Annuler une facture

Aperçu​

Vous pouvez annuler une facture pour que le client ne puisse plus la payer. C'est utile quand la facture contient une erreur. L'annulation demande deux conditions :

  • Statut de la facture : Impayée (Unpaid)
  • Vues de la page de paiement : 0

Si la facture appartient à un autre projet et que la clé est restreinte à un projet, la méthode répond Restricted project. Si vous n'avez pas de facture avec cet identifiant — Invoice not found. Si la facture est trouvée mais que les conditions d'annulation ne sont pas remplies — Invoice cannot be canceled.

Requête​

curl -X POST https://api.bitsby.app/invoices/cancel \
-H "Authorization: Token MSvL2ltaDZdWVjmZURURMVWhqSJLT2NURjhL2Fla1Z1T1IxQTltKs1T3Ay" \
-F "invoiceId=ade9550d-3dc7-4fd3-b94e-3b4c12aaaa0c"

Paramètres de la requête​

ParamètreType de donnéesDescriptionExempleObligatoire ?
invoiceIdUUIDID de la facture au format UUIDade9550d-3dc7-4fd3-b94e-3b4c12aaaa0coui

Exemple de réponse​

{
"result":"success",
"data":"Invoice canceled"
}