HeadHoncho

Dismiss field report

Dismiss field report is a command in the HeadHoncho API. Not this: book nothing from a technician's report. What they said is kept on the job.

Read as Markdown

The request

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

POST /api/v1/commands/dismiss-field-report

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 dismiss-field-report. 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
report_idid, in the JSON bodyYesFrom Money waiting to be booked.frp_77a1

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, report_id, job_id, number 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.

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.
report_idid (text)The id of the report.

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.
  • Record payment: Record money the customer paid on a job. A payment that covers the price closes the job, as it does in the app.
  • Void payment: Stop a payment entered wrong from counting. It stays on the job's money, marked voided, with why.
  • Record expense: Record a cost on a job: parts, a rental, fuel. Paid by a technician, it is paid back to them on top of their share.
  • Void expense: Stop an expense entered wrong from counting. It stays on the job's money, marked voided, with why.
  • Book field report: Book what a technician reported: the payment, the parts and the job's price, as sent or as you correct them. The job closes when nothing is missing.
  • Add expense type: Add a kind of cost the company records, such as Parts or Truck rental. A name already in use is refused, so sending it twice adds one.
  • Update expense type: Rename an expense type, or retire it so new expenses cannot pick it. Old expenses keep it either way.
  • The same records in the app: the Finance panel.
  • How the API fits together: the model, API keys, errors and the MCP server.