v1

latestOpenAPI 3.1.02026-07-261444991.2 MB

Credit note

Fetch credit note

This endpoint is used to fetch a single Credit Note given an identifier.

get/credit_notes/{credit_note_id}

credit_note_idstring required

idstring required

The Orb id of this credit note.

created_atstring date-time required

The creation time of the resource in Orb.

voided_atstring date-time nullable required

The time at which the credit note was voided in Orb, if applicable.

credit_note_numberstring required

The unique identifier for credit notes.

invoice_idstring required

The id of the invoice resource that this credit note is applied to.

memostring nullable required

An optional memo supplied on the credit note.

reason'Duplicate' | 'Fraudulent' | 'Order change' | 'Product unsatisfactory' nullable required

type'refund' | 'adjustment' required

subtotalstring required

The total prior to any creditable invoice-level discounts or minimums.

totalstring required

The total including creditable invoice-level discounts or minimums, and tax.

credit_note_pdfstring nullable required

A URL to a PDF of the credit note.

minimum_amount_refundedstring nullable required

Any credited amount from the applied minimum on the invoice.