Skip to main content

Get Credit Note By Id

GET 
/v1/invoicing/credit-notes/:id

Read one credit note's financial document detail by its document ID. This is separate from marketplace settlement history.

Requires creditNotes.read.

Request and response fields at a glance
  • Path parameters: id (string, required).
  • 200 response (application/json): notes (string), lineItems (array, required), subtotal (number, required), taxAmount (number, required), id (string, required), creditNoteNumber (string, required), reference (string, required), status (string, required), contactId (string, required), brand (object), organization (object), creditNoteDate (string, required), totalAmount (number, required), balance (number, required), createdAt (string, required).

Request​