Skip to content

List credit notes

GET
/v1/credit_notes/

List credit notes with optional filters.

skip
Skip
integer
0
limit
Limit
integer
default: 100 >= 1 <= 1000
order_by
Any of:
string
customer_id
Any of:
string format: uuid
invoice_id
Any of:
string format: uuid
status
Any of:
CreditNoteStatus
string
Allowed values: draft finalized

Successful Response

Response List Credit Notes V1 Credit Notes Get
Array<object>
CreditNoteResponse
object
id
required
Id
string format: uuid
number
required
Number
string
invoice_id
required
Invoice Id
string format: uuid
customer_id
required
Customer Id
string format: uuid
credit_note_type
required
Credit Note Type
string
status
required
Status
string
credit_status
Any of:
string
refund_status
Any of:
string
reason
required
Reason
string
description
Any of:
string
credit_amount_cents
required
Credit Amount Cents
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
refund_amount_cents
required
Refund Amount Cents
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
balance_amount_cents
required
Balance Amount Cents
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
total_amount_cents
required
Total Amount Cents
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
taxes_amount_cents
required
Taxes Amount Cents
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
currency
required
Currency
string
issued_at
Any of:
string format: date-time
voided_at
Any of:
string format: date-time
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time

Unauthorized

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object