v1
latestOpenAPI 3.1.02026-07-24111224223.3 KBCredit Memos
Lists all credit memos
Returns customer credit memos with pagination and filters for application state, customer, and subsidiaries. Use credit memo ids with retrieve-a-credit-memo before updates or when applying credits to invoices.
get/credit-memos
Query parameters
limitinteger
Maximum number of rows to return in the page.
cursorstring
If defined, a cursor to retrieve the next page.
Example:iLQvkEj3sh3UiweC
Pagination cursor to navigate through the full response.
subsidiary_idstring uuid
Subsidiary to be used when filtering data
updated.gtstring date-time
Example:2023-01-01T00:00:00Z
Filter credit memos updated after this timestamp
Response
OK
Example response
{
"credit_memos": [
{
"credit_memo_number": "CM01",
"items": [
{
"description": "Description",
"revenue": {
"account_code": "11112"
},
"total_amount": {
"amount": "1.01",
"currency": "USD"
},
"taxed_amount": {
"amount": "1.01",
"currency": "USD"
},
"net_amount": {
"amount": "1.01",
"currency": "USD"
},
"quantity": 1
}
],
"address": {
"line1": "123 Main St",
"line2": "Apt 4B",
"city": "Nashville",
"state": "TN",
"zip_code": "37201",
"country": "US"
},
"net_amount": {
"amount": "1.01",
"currency": "USD"
},
"total": {
"amount": "1.01",
"currency": "USD"
},
"applied_amount": {
"amount": "1.01",
"currency": "USD"
},
"remaining_amount": {
"amount": "1.01",
"currency": "USD"
},
"applications": [
{
"amount": {
"amount": "1.01",
"currency": "USD"
}
}
],
"exchange_rate": {
"base": "USD",
"target": "USD"
},
"taxed_amount": {
"amount": "1.01",
"currency": "USD"
},
"external_references": [
{
"type": "xyzSystemId",
"id": "234",
"url": "https://xyzsystempage.com/ids/234"
}
]
}
],
"pagination": {
"next_cursor": "iLQvkEj3sh3UiweC"
}
}