Skip to main content
POST
Create Credit Note

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string

The idempotency key that will be used to ensure the request is only performed once

Path Parameters

company_id
string
required

The company ID with the prefix 'cmp_'.

Body

application/json
adjusted_invoice_amount
object
required

New adjusted invoice amount after applying current credit note

effective_date
string<date-time>
required
existing_invoice_amount
object
required

Invoice amount after applying existing credit notes

internal_reason
string
required

Internal reason for the credit note. This reason will not be visible to the customer

invoice_uuid
string
required

UUID of the invoice to attach the credit note

line_items
object[]
required
subtotal_credit_amount
object
required

The amount which has value in cents and a currency

total_amount
object
required

Total amount of credit note (including taxes)

total_amount_excluding_taxes
object
required

The amount which has value in cents and a currency

internal_note
null | string

Optional note attached to the credit note. This note will only be visible to admins

name
null | string
note
null | string

Optional note attached to the credit note. This note will be visible to the customer

refund_options
object[]

Response

201 - application/json

Created

customer
object
customer_id
string
effective_date
string<date-time>

The date the credit note is effective at

id
string
internal_note
null | string

Internal note attached to the credit note

internal_reason
string

The reason for the credit note, such as ORDER_CHANGE, DUPLICATE, FRAUDULENT, or PRODUCT_UNSATISFACTORY

invoice
object
invoice_uuid
string
line_items
object[] | null

The invoice line items for the credit note

name
string
note
null | string

Note attached to the credit note

refund_options
object
total
object

The total amount for the credit note