# GET /api/v1/bills/metrics

> Get bill metrics

- **Tag:** bills
- **Operation ID:** `get_bill_metrics_api_v1_bills_metrics_get`

## Description

Retrieve aggregated bill metrics for the business: total due and total balance due across all received and partially paid bills.

## Authentication

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

## Responses

### 200 — Successful Response

Schema: `BillMetricsResponse`

- `total_due` (integer · required) — Sum of the amount for all bills in 'received' or 'partially_paid' status (in cents).
- `total_balance_due` (integer · required) — Sum of (amount - total_paid) for all bills in 'received' or 'partially_paid' status (in cents).

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

## See also

- HTML version: https://www.ondayzero.com/docs/reference/bills/get-bill-metrics
- OpenAPI slice: https://www.ondayzero.com/docs/reference/bills/get-bill-metrics/openapi.json
- Other endpoints in **bills**: https://www.ondayzero.com/docs/reference/bills