Sign in

v2

latestOpenAPI 3.0.0raw.githubusercontent.com2026-02-16143114179.4 KB
Credit Notes

Create a credit note

Create a credit note against an invoice. Starts in DRAFT status.

post/api/credit-notes

Request body

invoiceIdstring required

Invoice ID to credit against

customerIdstring required

Customer ID

amountnumber required

Credit amount

currencystring required

Currency

reason'DUPLICATE' | 'PRODUCT_UNSATISFACTORY' | 'ORDER_CHANGE' | 'OTHER' required
metadataobject

Additional metadata

status'DRAFT' | 'FINALIZED' | 'VOIDED'

Override status for imports

createdAtstring

Backdate createdAt (ISO 8601). For data imports.

Example request

{
  "amount": 25000,
  "currency": "UGX"
}

Response

Credit note created

idstring required
invoiceIdstring required
customerIdstring required
amountstring required

Decimal amount as string

currencystring required
reason'DUPLICATE' | 'PRODUCT_UNSATISFACTORY' | 'ORDER_CHANGE' | 'OTHER' required
status'DRAFT' | 'FINALIZED' | 'VOIDED' required
metadataobject
createdAtstring required
updatedAtstring required

Example response

{
  "id": "clx1234567890",
  "invoiceId": "clxinv123",
  "customerId": "clxcust123",
  "amount": "50.0000",
  "currency": "USD",
  "reason": "ORDER_CHANGE",
  "status": "DRAFT"
}