# GET /api/v1/credit-memos

> List credit memos

- **Tag:** credit-memos
- **Operation ID:** `list_credit_memos_api_v1_credit_memos_get`

## Description

List all credit memos for the business with optional filtering.

## Authentication

Bearer token in `Authorization` header.
Required header: `x-business-id: <business uuid>`.

## Parameters

- `customer_id` (query, string, optional) — Filter by customer ID
- `status` (query, CreditMemoStatusEnum, optional) — Filter by status
- `has_remaining_balance` (query, boolean, optional) — Only show memos with remaining balance
- `search` (query, string, optional) — Search by credit memo number (e.g. CM-0001)
- `cursor` (query, string, optional) — Pagination cursor
- `limit` (query, integer, optional) — Page size

## Responses

### 200 — Successful Response

Schema: `SuccessEnvelope_CreditMemosListResponse_`

- `success` (boolean)
- `message` (string)
- `code` (string)
- `data` (CreditMemosListResponse)

### 401 — Unauthorized - Authentication required

### 403 — Forbidden - Insufficient permissions

### 422 — Validation Error

Schema: `HTTPValidationError`

- `detail` (array · ValidationError) → `ValidationError`
  - `loc` (array · string | integer · required)
  - `msg` (string · required)
  - `type` (string · required)
  - `input` (object)
  - `ctx` (object)

## Code samples

### cURL

```bash
curl -X GET 'https://api.ondayzero.com/api/v1/credit-memos' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID'
```

### JavaScript

```javascript
const response = await fetch('https://api.ondayzero.com/api/v1/credit-memos', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer dz_your_token',
    'x-business-id': 'YOUR_BUSINESS_ID',
  },
});
const data = await response.json();
```

### Python

```python
import httpx

headers = {
    "Authorization": "Bearer dz_your_token",
    "x-business-id": "YOUR_BUSINESS_ID",
}

response = httpx.get("https://api.ondayzero.com/api/v1/credit-memos", headers=headers)
data = response.json()
```

## See also

- HTML version: https://www.ondayzero.com/docs/reference/credit-memos/list-credit-memos
- OpenAPI slice: https://www.ondayzero.com/docs/reference/credit-memos/list-credit-memos/openapi.json
- Other endpoints in **credit-memos**: https://www.ondayzero.com/docs/reference/credit-memos
