POST
/
credit_notes

Authorizations

Authorization
string
header
required

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

Body

application/json
line_items
object[]
required
memo
string | null

An optional memo to attach to the credit note.

reason
enum<string> | null

An optional reason for the credit note.

Available options:
duplicate,
fraudulent,
order_change,
product_unsatisfactory

Response

200 - application/json

The Credit Note resource represents a credit that has been applied to a particular invoice.

created_at
string
required

The creation time of the resource in Orb.

credit_note_number
string
required

The unique identifier for credit notes.

credit_note_pdf
string | null
required

A URL to a PDF of the credit note.

customer
object
required
id
string
required

The Orb id of this credit note.

invoice_id
string
required

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

line_items
object[]
required

All of the line items associated with this credit note.

maximum_amount_adjustment
object | null
required

The maximum amount applied on the original invoice

memo
string | null
required

An optional memo supplied on the credit note.

minimum_amount_refunded
string | null
required

Any credited amount from the applied minimum on the invoice.

reason
enum<string> | null
required
Available options:
Duplicate,
Fraudulent,
Order change,
Product unsatisfactory
subtotal
string
required

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

total
string
required

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

type
enum<string>
required
Available options:
refund,
adjustment
voided_at
string | null
required

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

discounts
object[]

Any discounts applied on the original invoice.