# List balances

List balances is a read in the HeadHoncho API. Who owes who, per technician: their cuts and paid-back parts against the cash they hold and what was already paid out.

Page: https://headhoncho.app/docs/api/list_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 balances**, HeadHoncho API v1. It is a read, sent to the base address `https://api.headhoncho.app`.

`GET /api/v1/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

This call takes no parameters.

## 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

balances, one per technician with any money: worker_id, name, role, payable (cuts, parts and monthly pay owed to them), receivable (cash they collected and hold), paid_out and paid_in (balance closes and payouts each way), net (what the company owes them; below zero, what they owe the company) and says, in words. totals: the same figures for everyone.

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 |
| --- | --- | --- |
| `balances` | list of objects | The balances. |
| `balances[].worker_id` | id (text) | The id of the worker. |
| `balances[].name` | text | The name, as the app shows it. |
| `balances[].role` | text | The role: what this person does on a job. |
| `balances[].payable` | money (number) | What the business owes this person (cuts, parts and pay owed to them). In the company's currency. |
| `balances[].receivable` | money (number) | What this person owes the business (cash they collected and still hold). In the company's currency. |
| `balances[].paid_out` | money (number) | What was paid out by the business. In the company's currency. |
| `balances[].paid_in` | money (number) | What was paid in to the business. In the company's currency. |
| `balances[].monthly_pay` | money (number) | The monthly pay. In the company's currency. |
| `balances[].cash_held` | money (number) | The cash held. In the company's currency. |
| `balances[].net` | money (number) | The net amount, after what is owed either way. In the company's currency. |
| `balances[].says` | text | The text to show a person. |
| `totals` | object | The totals. |
| `totals.payable` | money (number) | What the business owes this person (cuts, parts and pay owed to them). In the company's currency. |
| `totals.receivable` | money (number) | What this person owes the business (cash they collected and still hold). In the company's currency. |
| `totals.paid_out` | money (number) | What was paid out by the business. In the company's currency. |
| `totals.paid_in` | money (number) | What was paid in to the business. In the company's currency. |
| `totals.net` | money (number) | The net amount, after what is owed either way. In the company's currency. |

## The same numbers as the app

These are the balances the Team and Finance panels show, from the same function. Trashed jobs count in none of them.

## Every company

A balance is a person's, across every company they work for, so a credential must reach every company to read it.

## 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. |
| [`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

- [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.
- [List closed balances](https://headhoncho.app/docs/api/list_closed_balances): Every balance close and payout, newest first, voided ones included, with the jobs each one covered.
- 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
{
  "balances": [
    {
      "worker_id": "wrk_7a12",
      "name": "Omar S.",
      "role": "subcontractor",
      "payable": 4210.5,
      "receivable": 1450.0,
      "paid_out": 1800.0,
      "paid_in": 0.0,
      "monthly_pay": 0.0,
      "cash_held": 1450.0,
      "net": 960.5,
      "says": "Pay out to Omar S."
    },
    {
      "worker_id": "wrk_3b90",
      "name": "Dana R.",
      "role": "technician",
      "payable": 610.0,
      "receivable": 900.0,
      "paid_out": 0.0,
      "paid_in": 0.0,
      "monthly_pay": 0.0,
      "cash_held": 900.0,
      "net": -290.0,
      "says": "Dana R. pays the company"
    }
  ],
  "totals": {
    "payable": 4820.5,
    "receivable": 2350.0,
    "paid_out": 1800.0,
    "paid_in": 0.0,
    "net": 670.5
  }
}
```

### cURL

```bash
curl "https://api.headhoncho.app/api/v1/balances" \
  -H "Authorization: Bearer hh_live_..."
```

### Python

```python
import requests

response = requests.get(
    "https://api.headhoncho.app/api/v1/balances",
    headers={"Authorization": "Bearer hh_live_..."},
)
response.raise_for_status()
print(response.json())
```

### JavaScript

```javascript
const response = await fetch("https://api.headhoncho.app/api/v1/balances", {
  headers: { Authorization: "Bearer hh_live_..." },
});
const data = await response.json();
console.log(data);
```

### Your AI

```text
Tool: list_balances
Arguments: none
Access: read on Money
Hints: readOnly=true, destructive=false, idempotent=true, openWorld=false
Try asking: "Using HeadHoncho, list balances."
```