HeadHoncho

Set job cut

Set job cut is a command in the HeadHoncho API. What one technician or subcontractor on a job is paid on this job: a percent of the total, a percent of the profit, or a flat amount.

    Read as Markdown

    The request

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

    POST /api/v1/commands/set-job-cut

    The key needs the Jobs area at do. An answered call costs 1 credit; a refusal costs nothing. See credits.

    It runs the app's own command set-job-cut. 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

    NameKindRequiredDescriptionExample
    job_idid, in the JSON bodyYesThe job id, or its number.job_1203
    worker_idid, in the JSON bodyYesSomeone on the job, from Who am I.wrk_7a12
    cut_basistext, in the JSON bodyNojob_total, job_profit or fixed_amount. Empty with no cut_value goes back to their usual rate. One of job_total, job_profit, fixed_amount, ``.job_profit
    cut_valuemoney, in the JSON bodyNoThe percent (50 is 50%), or the flat amount.50

    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, job_id, number, position, worker_id, cut_basis and cut_value as now set. A job's money report shows the share it makes.

    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.

    FieldTypeMeaning
    acceptedtrue or falseTrue when the command ran. A command that cannot run is an error instead.
    job_idid (text)The id of the job.
    numberwhole numberThe number people say out loud, such as the job number.
    positionwhole numberWhere the change landed in the event log. Pass it as after on a read to see your own write.
    worker_idid (text)The id of the worker.
    cut_basistextOne of job_total, job_profit, fixed_amount, ``.
    cut_valuemoney (decimal as text)The cut: a percent, or an amount when the basis is fixed_amount. In the company's currency.

    Errors that apply

    CodeStatusWhat it means
    `missing_key`401Send your key as Authorization: Bearer hh_live_...
    `unknown_key`401That key is not one we issued, or it was revoked.
    `no_access`403This credential does not reach that. Ask the person who made it for access.
    `read_only`403This credential may read this area but not change it.
    `not_found`404No such record in the companies this credential reaches.
    `invalid`422Some fields were refused. See fields.
    `missing_idempotency_key`400Send an Idempotency-Key header on every command.
    `idempotency_mismatch`409This Idempotency-Key was used with a different body.
    `idempotency_in_progress`409A command with this Idempotency-Key is still running. Wait a moment and send it again.
    `no_credits`402Out of credits. Top up on Settings › Credits, or turn on auto top-up.
    • Create job: Open a job or a lead in one company: the customer, the address, and optionally the job type, the time window and the technician.
    • Update job: Change a job's facts: the customer, the address, the schedule, the job type or the notes. Only the fields you send change.
    • Change job status: Move a job to another status by its name, slug or id. The move lands in the job's history with who asked for it.
    • Assign worker: Put a technician or subcontractor on a job. If Job follow-up is on, the automation acts on it at once, as it would from the app.
    • Unassign worker: Take a technician or subcontractor off a job. The ticket's cancellation reaches them the way it does from the app.
    • Add job note: Add a note to a job. It appends to the job's log and never overwrites.
    • Update job note: Fix what a note says. Only the person who wrote it may change it; the old text stays in the job's history.
    • Delete job note: Take a note off a job. Its author or an owner may. The removal is in the job's history.
    • Release job status: Hand a status set by hand back to the automation. The job moves at once to the status its facts hold, and History says why.
    • Resolve job detour: Close a job's detour, such as Waiting on parts. The job goes back to the status it left, then on to where its facts put it.
    • Archive job: File a finished job away, off the boards. It keeps its money and counts in every figure; Unarchive brings it back.
    • Unarchive job: Bring an archived job back onto the boards, as it was.
    • Trash job: Move a job to Trash, with why. It leaves every list and every figure, and can be restored for 30 days.
    • Restore job: Bring a job back from Trash, whole: its money, its history and its technicians.
    • Upload photo: Put one photo on a job. Send the picture as base64 text; it is stored and confirmed in one call.
    • Delete photo: Remove one photo from a job, for good: its record and its file.
    • The same records in the app: the Jobs panel.
    • How the API fits together: the model, API keys, errors and the MCP server.