Record payout

The request

Reference for Record payout, HeadHoncho API v1. It is a command, sent to the base address https://api.headhoncho.app.

POST /api/v1/commands/record-payout

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 record-payout. 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
`worker_id`	id, in the JSON body	Yes	The technician, from Who am I's technicians.	`wrk_7a12`
`direction`	text, in the JSON body	Yes	to_worker (the company paid them) or from_worker (they paid the company). One of `to_worker`, `from_worker`.	`to_worker`
`amount`	money, in the JSON body	Yes	How much, a number.	`500`
`method`	text, in the JSON body	Yes	ach, cash, check, card or other. One of `ach`, `cash`, `check`, `card`, `other`.	`cash`
`paid_at`	datetime, in the JSON body	No	When. Default: now.	`2026-10-20T17:00:00-05:00`
`reference`	text, in the JSON body	No	A check number or transfer id.	`Check 1042`
`memo`	text, in the JSON body	No	Anything to remember.	`Advance`

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 API key worker_id (required, id) direction (required, text) amount (required, money) method (required, text) paid_at (optional, datetime) reference (optional, text) memo (optional, text)

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

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.

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.
Void closed balance: Undo a balance close or a payout entered wrong. Its jobs open again, and it stays on the list, marked voided, with why.
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.

Answer cURL Python JavaScript Your AI

{
  "accepted": true,
  "worker_id": "wrk_7a12",
  "position": 88520,
  "closed_balance_id": "set_52bb"
}

curl -X POST "https://api.headhoncho.app/api/v1/commands/record-payout" \
  -H "Authorization: Bearer hh_live_..." \
  -H "Idempotency-Key: 6f1d2c9e-1b7a-4c1e-9a52-0d3f8e4b7a10" \
  -H "Content-Type: application/json" \
  -d '{
  "worker_id": "wrk_7a12",
  "direction": "to_worker",
  "amount": 500,
  "method": "cash",
  "paid_at": "2026-10-20T17:00:00-05:00",
  "reference": "Check 1042",
  "memo": "Advance"
}'

import requests
import uuid

response = requests.post(
    "https://api.headhoncho.app/api/v1/commands/record-payout",
    headers={
        "Authorization": "Bearer hh_live_...",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={
        "worker_id": "wrk_7a12",
        "direction": "to_worker",
        "amount": 500,
        "method": "cash",
        "paid_at": "2026-10-20T17:00:00-05:00",
        "reference": "Check 1042",
        "memo": "Advance",
    },
)
response.raise_for_status()
print(response.json())

const response = await fetch("https://api.headhoncho.app/api/v1/commands/record-payout", {
  method: "POST",
  headers: {
    Authorization: "Bearer hh_live_...",
    "Idempotency-Key": crypto.randomUUID(),
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "worker_id": "wrk_7a12",
    "direction": "to_worker",
    "amount": 500,
    "method": "cash",
    "paid_at": "2026-10-20T17:00:00-05:00",
    "reference": "Check 1042",
    "memo": "Advance"
  }),
});
const data = await response.json();
console.log(data);

Tool: record_payout
Arguments: worker_id (id, required), direction (text, required), amount (money, required), method (text, required), paid_at (datetime, optional), reference (text, optional), memo (text, optional)
Access: do on Money
Hints: readOnly=false, destructive=false, idempotent=false, openWorld=false
Try asking: "Using HeadHoncho, record payout with worker_id wrk_7a12 and direction to_worker and amount 500 and method cash and paid_at 2026-10-20T17:00:00-05:00."