List credit notes

Authorizations

Authorization

string

header

required

API Keys can be issued in the Orb's web application.

Query Parameters

limit

integer

default:

The number of items to fetch. Defaults to 20.

Required range: 1 < x < 1000

cursor

string | null

Cursor for pagination. This can be populated by the next_cursor value returned from the initial request.

Response

200 - application/json

data

object[]

required

data.created_at

string

required

The creation time of the resource in Orb.

data.credit_note_number

string

required

The unique identifier for credit notes.

data.credit_note_pdf

string | null

required

A URL to a PDF of the credit note.

data.customer

object

required

data.id

string

required

The Orb id of this credit note.

data.invoice_id

string

required

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

data.line_items

object[]

required

All of the line items associated with this credit note.

data.maximum_amount_adjustment

object | null

required

The maximum amount applied on the original invoice

data.memo

string | null

required

An optional memo supplied on the credit note.

data.minimum_amount_refunded

string | null

required

Any credited amount from the applied minimum on the invoice.

data.reason

enum<string> | null

required

Available options:

Duplicate,

Fraudulent,

Order change,

Product unsatisfactory

data.subtotal

string

required

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

data.total

string

required

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

data.type

enum<string>

required

Available options:

refund,

adjustment

data.voided_at

string | null

required

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

data.discounts

object[]

Any discounts applied on the original invoice.

pagination_metadata

object

required