Credit Notes
List credit notes
Retrieve a paginated list of credit notes.
get/api/credit-notes
Query parameters
customerIdstring
invoiceIdstring
status'DRAFT' | 'FINALIZED' | 'VOIDED'
pagenumber
limitnumber
Response
Paginated list of credit notes
Example response
{
"data": [
{
"id": "clx1234567890",
"invoiceId": "clxinv123",
"customerId": "clxcust123",
"amount": "50.0000",
"currency": "USD",
"reason": "ORDER_CHANGE",
"status": "DRAFT"
}
],
"meta": {
"total": 150,
"page": 1,
"limit": 20,
"totalPages": 8
}
}