Get credit note

GET

/v1/credit_notes/{credit_note_id}

Get a credit note by ID.

Parameters

Path Parameters

credit_note_id

required

Credit Note Id

string format: uuid

Responses

200

Successful Response

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

string

null

null

refund_status

Any of:

string

string

null

null

reason

required

Reason

string

description

Any of:

string

string

null

null

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

string format: date-time

null

null

voided_at

Any of:

string

string format: date-time

null

null

created_at

required

Created At

string format: date-time

updated_at

required

Updated At

string format: date-time

401

Unauthorized

404

Credit note not found

422

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