The request
Reference for Void closed balance, HeadHoncho API v1. It is a command, sent to the base address https://api.headhoncho.app.
POST /api/v1/commands/void-closed-balance
The key needs the Money area at do. An answered call costs 1 credit; a refusal costs nothing. See credits.
It runs the app's own command void-closed-balance. Send an Idempotency-Key header with every call: the same key with the same body returns the first answer and runs nothing twice. See the model.
Parameters
| Name | Kind | Required | Description | Example |
|---|---|---|---|---|
closed_balance_id | id, in the JSON body | Yes | From Closed balances, or the close's answer. | set_51aa |
reason | text, in the JSON body | Yes | Why it was wrong. | Wrong technician |
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.
Your key stays in this page and is never sent anywhere. Copy the line below and run it yourself.
What comes back
accepted, worker_id, closed_balance_id, released (each line it covered, and how much of it other closes still cover) and position.
It never deletes anything. It changes only what the command names, and it writes the change to the job's history with who asked for it.
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 |
|---|---|---|
accepted | true or false | True when the command ran. A command that cannot run is an error instead. |
worker_id | id (text) | The id of the worker. |
position | whole number | Where the change landed in the event log. Pass it as after on a read to see your own write. |
closed_balance_id | id (text) | The id of the closed balance. |
released | list of objects | The released. |
released[].entry_id | id (text) | The id of the entry. |
released[].still_covered | money (number) | The still covered. In the company's currency. |
Errors that apply
| Code | Status | What it means |
|---|---|---|
| `missing_key` | 401 | Send your key as Authorization: Bearer hh_live_... |
| `unknown_key` | 401 | That key is not one we issued, or it was revoked. |
| `no_access` | 403 | This credential does not reach that. Ask the person who made it for access. |
| `read_only` | 403 | This credential may read this area but not change it. |
| `not_found` | 404 | No such record in the companies this credential reaches. |
| `invalid` | 422 | Some fields were refused. See fields. |
| `missing_idempotency_key` | 400 | Send an Idempotency-Key header on every command. |
| `idempotency_mismatch` | 409 | This Idempotency-Key was used with a different body. |
| `idempotency_in_progress` | 409 | A command with this Idempotency-Key is still running. Wait a moment and send it again. |
| `no_credits` | 402 | Out of credits. Top up on Settings › Credits, or turn on auto top-up. |
Related
- Close balance: Close what a technician is owed for the jobs you name, or for everything open through a day, as one payout netted against the cash they hold.
- Record payout: Record money paid to a technician, or paid in by one, that names no jobs. It moves their balance and closes no particular job.
- Hold back job: Keep one job out of a technician's balance closes until you put it back, with why. Its cut, parts and cash wait together.
- Put back job: Let a held-back job count in the technician's next balance close again.
- Post monthly pay: Add a month of pay to the balance of every active technician on a monthly rate. A month is posted once, however often this is sent.
- The same records in the app: the Finance panel.
- How the API fits together: the model, API keys, errors and the MCP server.