# GET /api/v1/vendor-credits

> List vendor credits

- **Tag:** vendor-credits
- **Operation ID:** `list_vendor_credits_api_v1_vendor_credits_get`

## Description

List all vendor credits for the business with optional filtering.

## Authentication

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

## Parameters

- `vendor_id` (query, string, optional) — Filter by vendor ID
- `status` (query, VendorCreditStatusEnum, optional) — Filter by status
- `has_remaining_balance` (query, boolean, optional) — Only show credits with remaining balance
- `search` (query, string, optional) — Search by vendor credit number (e.g. VC-0001)
- `cursor` (query, string, optional) — Pagination cursor
- `limit` (query, integer, optional) — Page size

## Responses

### 200 — Successful Response

Schema: `VendorCreditsListResponse`

- `items` (array · VendorCreditResponse · required) → `VendorCreditResponse` — List of items
  - `id` (string · required) — Vendor credit ID
  - `business_id` (string · required) — Business receiving the credit
  - `vendor_id` (string · required) — Vendor issuing the credit
  - `bill_id` (string) — Original bill being credited
  - `number` (string) — Auto-generated vendor credit number (e.g. VC-0001)
  - `vendor_credit_number` (string) — Vendor's own reference number (from the credit doc)
  - `status` (string · required) — Status: draft, issued, partially_applied, applied, void
  - `currency` (string · required) — ISO currency code (e.g. USD)
  - `amount` (integer · required) — Total credit amount in cents
  - `amount_in_dollars` (string · required) — Total credit amount in dollars
  - `amount_applied` (integer · required) — Amount applied in cents
  - `amount_applied_in_dollars` (string · required) — Amount applied in dollars
  - `amount_remaining` (integer · required) — Remaining amount in cents
  - `amount_remaining_in_dollars` (string · required) — Remaining amount in dollars
  - `issue_date` (string · date · required) — Date the credit was issued
  - `applied_date` (string · date-time) — When credits were fully applied
  - `created_at` (string · date-time · required) — Record creation timestamp
  - `updated_at` (string · date-time · required) — Last update timestamp
  - `reason` (string · required) — Reason code
  - `reason_display` (string · required) — Human-readable reason label
  - `description` (string) — Description of the credit
  - `internal_notes` (string) — Internal notes
  - `line_items` (object) — Detailed line items breakdown
  - `voided_at` (string · date-time) — When the credit was voided
  - `voided_reason` (string) — Reason for voiding
  - `vendor_name` (string) — Vendor display name
  - `bill_number` (string) — Original bill number
  - `bill_applications` (array · VendorCreditApplicationResponse) — Applications to bills
  - `can_be_applied` (boolean · required) — Whether credits can be applied to bills
  - `can_be_voided` (boolean · required) — Whether the credit can be voided
  - `can_be_deleted` (boolean · required) — Whether the credit can be deleted (drafts only)
  - `has_applications` (boolean · required) — Whether any credits have been applied
- `total` (integer) — Total number of items (null when not calculated for performance)
- `limit` (integer) — Pagination limit
- `next_cursor` (string) — Cursor for next page
- `prev_cursor` (string) — Cursor for previous page
- `has_next` (boolean · required) — Whether there are more items
- `has_prev` (boolean · required) — Whether there are previous items

### 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/vendor-credits' \
  -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/vendor-credits', {
  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/vendor-credits", headers=headers)
data = response.json()
```

## See also

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