# List closed balances

List closed balances is a read in the HeadHoncho API. Every balance close and payout, newest first, voided ones included, with the jobs each one covered.

Page: https://headhoncho.app/docs/api/list_closed_balances | Part of the HeadHoncho API docs: https://headhoncho.app/docs/api | Machine-readable: https://headhoncho.app/docs/api/openapi.json | Everything in one file: https://headhoncho.app/docs/api/llms-full.txt

## The request

Reference for **List closed balances**, HeadHoncho API v1. It is a read, sent to the base address `https://api.headhoncho.app`.

`GET /api/v1/closed-balances`

The key needs the **Money** area at **read**. An answered call costs 1 credit; a refusal costs nothing. See [credits](https://headhoncho.app/docs/api/errors#credits).

Send your key as `Authorization: Bearer hh_live_...`. See [API keys](https://headhoncho.app/docs/api/keys).

## Parameters

| Name | Kind | Required | Description | Example |
| --- | --- | --- | --- | --- |
| `worker_id` | id, in the query | No | Only this technician. | `wrk_7a12` |
| `direction` | text, in the query | No | to_worker (the company paid) or from_worker (they paid in). One of `to_worker`, `from_worker`. | `to_worker` |
| `method` | text, in the query | No | ach, cash, check, card or other. | `zelle` |
| `voided` | text, in the query | No | include (default), hide or only. One of `include`, `hide`, `only`. | `hide` |
| `from` | date, in the query | No | Paid on or after this day. | `2026-10-01` |
| `to` | date, in the query | No | Paid on or before this day. | `2026-10-31` |
| `page` | number, in the query | No | Default 1, twenty a page. | `1` |

## Try it with your key

Paste your key and change the values. The box builds the call as a cURL line and a fetch line, ready to copy. It never sends anything itself.

Paste your key on the web page and it fills a cURL line and a fetch line with your key and the example values. The page never sends the key anywhere. The same lines with a placeholder key are under Examples below.

## What comes back

closed_balances (id, worker_id, name, paid_on, direction, method, reference, amount, jobs, voided, has_statement), total, page and pages.

It never changes a record. It only reads the companies the key reaches.

## Every field in the answer

Types are read from the example answer. Money is a plain number in the company's currency. A time carries its offset from UTC (`Z` is UTC). Ids are opaque text. A field with no line of its own here has its name spelled out; the common fields mean the same on every page.

| Field | Type | Meaning |
| --- | --- | --- |
| `closed_balances` | list of objects | The closed balances. |
| `closed_balances[].id` | id (text) | The id of this record. Ids are opaque text: keep them exactly as given. |
| `closed_balances[].worker_id` | id (text) | The id of the worker. |
| `closed_balances[].name` | text | The name, as the app shows it. |
| `closed_balances[].paid_on` | date (YYYY-MM-DD) | The date it was paid. |
| `closed_balances[].direction` | text | One of `to_worker`, `from_worker`. |
| `closed_balances[].method` | text | How it was paid, such as card or cash. |
| `closed_balances[].reference` | text | The reference the payer or the bank gave. |
| `closed_balances[].amount` | money (number) | The amount. In the company's currency. |
| `closed_balances[].jobs` | whole number | The jobs. |
| `closed_balances[].voided` | true or false | One of `include`, `hide`, `only`. |
| `closed_balances[].has_statement` | true or false | True when there is a statement. |
| `total` | whole number | The total, in the company's currency. |
| `page` | whole number | The page number, starting at 1. |
| `pages` | whole number | How many pages there are. |

## The statement file

The statement PDF of a balance close stays in the app, on Finance › History: it is a drawn report, which the API does not hand out.

## Errors that apply

| Code | Status | What it means |
| --- | --- | --- |
| [`missing_key`](https://headhoncho.app/docs/api/errors#missing_key) | 401 | Send your key as Authorization: Bearer hh_live_... |
| [`unknown_key`](https://headhoncho.app/docs/api/errors#unknown_key) | 401 | That key is not one we issued, or it was revoked. |
| [`no_access`](https://headhoncho.app/docs/api/errors#no_access) | 403 | This credential does not reach that. Ask the person who made it for access. |
| [`not_found`](https://headhoncho.app/docs/api/errors#not_found) | 404 | No such record in the companies this credential reaches. |
| [`invalid`](https://headhoncho.app/docs/api/errors#invalid) | 422 | Some fields were refused. See fields. |
| [`no_credits`](https://headhoncho.app/docs/api/errors#no_credits) | 402 | Out of credits. Top up on Settings › Credits, or turn on auto top-up. |

## Related

- [List balances](https://headhoncho.app/docs/api/list_balances): Who owes who, per technician: their cuts and paid-back parts against the cash they hold and what was already paid out.
- [Get balance statement](https://headhoncho.app/docs/api/get_balance_statement): Every line on a technician's balance for a period, with the running balance: cuts, parts, cash held and each payout, voided ones marked.
- The same records in the app: [the Finance panel](https://headhoncho.app/docs/finance).
- How the API fits together: [the model](https://headhoncho.app/docs/api/model), [API keys](https://headhoncho.app/docs/api/keys), [errors](https://headhoncho.app/docs/api/errors) and [the MCP server](https://headhoncho.app/docs/api/mcp).

## Examples

### Answer

```json
{
  "closed_balances": [
    {
      "id": "set_51aa",
      "worker_id": "wrk_7a12",
      "name": "Omar S.",
      "paid_on": "2026-10-20",
      "direction": "to_worker",
      "method": "other",
      "reference": "Zelle 8812",
      "amount": 1800.0,
      "jobs": 6,
      "voided": false,
      "has_statement": true
    }
  ],
  "total": 1,
  "page": 1,
  "pages": 1
}
```

### cURL

```bash
curl "https://api.headhoncho.app/api/v1/closed-balances?worker_id=wrk_7a12&direction=to_worker" \
  -H "Authorization: Bearer hh_live_..."
```

### Python

```python
import requests

response = requests.get(
    "https://api.headhoncho.app/api/v1/closed-balances",
    headers={"Authorization": "Bearer hh_live_..."},
    params={
        "worker_id": "wrk_7a12",
        "direction": "to_worker",
    },
)
response.raise_for_status()
print(response.json())
```

### JavaScript

```javascript
const response = await fetch("https://api.headhoncho.app/api/v1/closed-balances?worker_id=wrk_7a12&direction=to_worker", {
  headers: { Authorization: "Bearer hh_live_..." },
});
const data = await response.json();
console.log(data);
```

### Your AI

```text
Tool: list_closed_balances
Arguments: worker_id (id, optional), direction (text, optional), method (text, optional), voided (text, optional), from (date, optional), to (date, optional), page (number, optional)
Access: read on Money
Hints: readOnly=true, destructive=false, idempotent=true, openWorld=false
Try asking: "Using HeadHoncho, list closed balances with worker_id wrk_7a12."
```