Authorizations
Use the /v1/oauth2/token endpoint to obtain an access token and pass it as a Bearer token in the Authorization header.
Body
The invoice unique identifier.
"1a901a90-1a90-1a90-1a90-1a901a901a90"
The list of credit note's items.
1[
{
"fee_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"amount": { "value": 0.1 }
},
{
"fee_id": "1a901a90-1a90-1a90-1a90-1a901a901a91",
"amount": { "value": 0.05 }
}
]The reason for credit note creation
DUPLICATED_CHARGE, PRODUCT_UNSATISFACTORY, ORDER_CHANGE, ORDER_CANCELLATION, FRAUDULENT_CHARGE, OTHER "OTHER"
The description of the credit note.
"description"
The total amount to be credited on the customer balance.
The total amount to be refunded to the customer.
Response
Credit note created successfully.
Unique code used to identify the billing entity. Must contain only alphanumeric characters, underscores, and hyphens.
"acme_inc"
The sequential identifier of the credit note, specifically scoped on the associated invoice. It provides a unique numerical identifier for the credit note within the context of the invoice.
2
The credit note unique number.
"PP-1234-US"
Unique identifier assigned to the invoice that the credit note belongs to
"1a901a90-1a90-1a90-1a90-1a901a901a90"
The invoice unique number, related to the credit note.
"PP-1234"
The date of creation of the credit note. It follows the ISO 8601 date format and provides the specific date when the credit note was created.
"2023-10-01"
The reason for credit note creation
DUPLICATED_CHARGE, PRODUCT_UNSATISFACTORY, ORDER_CHANGE, ORDER_CANCELLATION, FRAUDULENT_CHARGE, OTHER "OTHER"
The total amount of the credit note.
The tax amount of the credit note.
The tax rate associated with this specific credit note.
0.2
The subtotal of the credit note excluding any applicable taxes.
The remaining credit note amount.
The credited amount of the credit note.
The refunded amount of the credit note.
The date when the credit note was created. It is expressed in Coordinated Universal Time (UTC).
"2023-10-01T12:00:00Z"
The date when the credit note was last updated. It is expressed in Coordinated Universal Time (UTC).
"2023-10-01T12:00:00Z"
The status of the credit portion of the credit note
AVAILABLE, CONSUMED, VOIDED "AVAILABLE"
The status of the refund portion of the credit note
PENDING, SUCCEEDED, FAILED "PENDING"
The description of the credit note.
"Free text"
Array of credit note's items.