Create credit note

POST

/v1/credit_notes/

Create a new credit note with optional items.

Request Body ^required

CreditNoteCreate

object

number

required

Number

string

<= 50 characters

invoice_id

required

Invoice Id

string format: uuid

customer_id

required

Customer Id

string format: uuid

credit_note_type

required

CreditNoteType

string

Allowed values: credit refund offset

reason

required

CreditNoteReason

string

Allowed values: duplicated_charge product_unsatisfactory order_change order_cancellation fraudulent_charge other

description

Any of:

string

string

null

null

credit_amount_cents

Any of:

number

number

string

string

/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/

refund_amount_cents

Any of:

number

number

string

string

/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/

total_amount_cents

Any of:

number

number

string

string

/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/

taxes_amount_cents

Any of:

number

number

string

string

/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/

currency

required

Currency

string

>= 3 characters <= 3 characters

items

Items

Array<object>

CreditNoteItemCreate

object

fee_id

required

Fee Id

string format: uuid

amount_cents

required

Any of:

number

number

string

string

/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/

Responses

201

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

409

Credit note with this number already exists

422

Validation error