Skip to main content

Get Credit Notes

GET 

/v1/invoicing/credit-notes

Page through credit notes with status, contact, brand, number, and date filters. Omitted brandIds use the caller's accessible brand scope.

Requires creditNotes.read.

Request and response fields at a glance
  • Query parameters: status (string), contactId (string), brandIds (array), creditNoteNumber (string), creditNoteDateAfter (string), creditNoteDateBefore (string), page (integer), limit (integer).
  • 200 response (application/json): creditNotes (array, required), pagination (object, required).

Request​