agency-time

PATCH /v1/agency/time/entries/{entryId}

Correct a time entry.

All agency-time endpoints

Authentication

Send an API key as a bearer token. This endpoint does not state a specific permission in the specification, so give your key the least it needs and check the response rather than assuming.

This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

curl -X PATCH https://api.zinndigital.com/v1/agency/time/entries/{entryId} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

⛔ An entry that has been invoiced cannot be changed — 422. Changing the minutes on an invoiced line would make the timesheet disagree with a document the client is holding; the remedy is to void the draft invoice, which releases the time back into the pool.

Parameters

NameTypeRequiredWhat it is
entryId (path)stringYes

Request body

NameTypeRequiredWhat it is
task_idstringNo
work_datestringNo
minutesintegerNo
descriptionstringNo
billablebooleanNo

Response

NameTypeRequiredWhat it is
idstringYes
user_idstringNo
project_idstringYes
project_namestringNo
task_idstringNo
task_namestringNo
client_idstringNo
work_datestringYes
minutesintegerYes⛔ An INTEGER of minutes. There is no `hours` field on this API: an hours-as-float duration re-enters the money through the rate and no rounding point can recover it.
duration_labelstringYesPresentational only — never multiplied by anything.
descriptionstringNo
billablebooleanYes
billing_run_idstringNoThe run that invoiced this entry. `null` means it is still outstanding.
billed_rate_minor_per_hourintegerNo
billed_amount_minorintegerNoWhat was actually charged, frozen at billing time so the document can be re-derived years later even if every rate card has since changed.
billed_currencystringNo
billed_under_fixed_pricebooleanNoTRUE when these minutes were rolled into a task's FIXED price rather than charged by the hour. `billed_amount_minor` is then 0 and that zero is correct — read this flag, not the…
rate_minor_per_hourintegerNoThe rate that WOULD apply, resolved against this entry's own `work_date`, for an entry not yet billed. ⛔ `null` means **unpriced**, not free: work with no rate card is never inv…
rate_scopestring<task, project, client, org>NoWhich rate card won, so a surprising invoice can be explained.
rate_kindstring<hourly, fixed>No
created_atstringYes

Errors this endpoint can return

401 · 403 · 404 · 422