Credit Memos
Filter credit memos
Search for credit memos using filter criteria.
Common Filters
- By customer: { "filter": { "customerId": { "equalTo": "uuid" } } }
- With balance: { "filter": { "hasRemainingBalance": true } }
- Open credits: { "filter": { "status": { "in": ["OPEN", "PARTIALLY_APPLIED"] } } }
post/credit-memos/filter
Request body
Response
Credit memos matching filter criteria
Example response
{
"data": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"reference": "CM-00001",
"customer": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"key": "ERP-CUSTOMER-ACME",
"name": "Acme Manufacturing Corp",
"friendlyId": "A123456",
"status": "ACTIVE",
"phoneNumber": "+1-555-123-4567",
"website": "https://acme-manufacturing.com",
"createdAt": "2025-01-15T10:00:00Z",
"updatedAt": "2025-01-15T14:30:00Z"
},
"currency": "USD",
"createdBy": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"key": "ERP-USER-12345",
"email": "john.doe@example.com",
"name": "John Doe",
"phone": "+1-555-123-4567",
"phoneExt": "123",
"status": "ACTIVE",
"avatarId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"createdAt": "2025-01-15T10:00:00Z",
"updatedAt": "2025-01-15T14:30:00Z"
}
}
],
"pagination": {
"pageSize": 50,
"hasNextPage": true,
"endCursor": "eyJpZCI6IjU1MGU4NDAwLWUyOWItNDFkNC1hNzE2LTQ0NjY1NTQ0MDAwMCJ9"
}
}