v2

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

Credit Notes

Get credit note by ID

get/api/credit-notes/{id}

Path parameters

idstring required

Credit note ID

Response

Credit note details

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"
}