API Reference

Create a credit note

post
https://api.bizyness.fr/invoices//credit_notes

Creates a credit note from the specified invoice. The payload lets you choose which invoice lines should be refunded, add shipping and manual adjustments, and optionally store a comment on the generated credit note.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Invoice ID

Body Params

Payload used to create a credit note from an existing invoice. lines contains the refund amount to apply to each invoice line in invoice order, while shipping_amount and manual_amount control additional refunded amounts outside the invoice lines.

lines
array of strings
required

Refund amount to apply to each invoice line, expressed in the billed currency and ordered like the source invoice lines.

lines*
string
required

Shipping amount to refund in addition to the selected line amounts.

string
required

Manual adjustment amount to add to the credit note when the refund cannot be represented only with invoice lines and shipping.

string

Comment stored on the generated credit note.

Responses

Updated 27 days ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 27 days ago