Skip to main content
POST
Create credit note against invoice

Authorizations

x-api-key
string
header
default:<your-api-key>
required
organisation
string
header
default:<your-organisation-id>
required

Path Parameters

invoice_id
string<uuid>
required

Body

application/json
credit_note_amount
number
required

Adjustment amount to be applied to the invoice.

reason
string
required

Reason for the credit note

refund_destination
enum<string> | null

Where to send the refund money. This field is required if a payment needs to be refunded when issuing a credit note.

Available options:
credits,
original_payment_method,
external
refund_amount_split
RefundSplit · object[] | null

Split the refund across multiple payments. If not provided, the system will use payments in order from oldest to newest.

Response

Successful Response

id
string<uuid>
required

ID

amount
integer
required

Amount in lowest denomination of the currency

currency
string
required

Currency

customer_id
string<uuid>
required

Customer ID

status
enum<string>
required

Status

Available options:
in_progress,
issued,
void,
paid
repayment_method
enum<string>
required

Repayment Method

Available options:
credits,
invoice_adjusted,
external_payment,
credits_against_payment,
original_payment_method
line_items_url
string
required

Line Items URL

created_at
string<date-time>
required

Created At

credits_returned
integer | null

Credits amount in lowest denomination of the currency

customer
DetailsObject · object | null

Customer Object

invoice
DetailsObject · object | null

Invoice Object

invoice_id
string<uuid> | null

Invoice ID

custom_data
Custom Data · object | null

Custom Data Dictionary

credit_note_number
string | null

Credit Note Number