Authentication
Send an API key as a bearer token. The endpoint checks agency.time.manage, agency.time.view; a key without it is refused with 403, not 404.
Where your organisation id goes
This endpoint takes org_id as a field in the JSON body.
Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X POST https://api.zinndigital.com/v1/agency/time/rates \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "scope": <string<task, project, client, org>>, "amount_minor": <integer>, "currency": <string>, "effective_from": <string> }'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
amount_minor is the price of ONE HOUR for kind: hourly, and the price of the whole job for kind: fixed. ⛔ A fixed price is billed once for the task it is set on, however many hours are logged against it — the minutes are still recorded and reported, they simply do not each carry money. It is not "an hourly rate of zero".
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
scope | string<task, project, client, org> | Yes | — |
scope_id | string | No | — |
kind | string<hourly, fixed> | No | — |
amount_minor | integer | Yes | — |
currency | string | Yes | — |
effective_from | string | Yes | — |
org_id | string | No | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
id | string | Yes | — |
scope | string<task, project, client, org> | Yes | — |
scope_id | string | No | The task/project/client this applies to. null exactly when scope is org. |
kind | string<hourly, fixed> | Yes | — |
amount_minor | integer | Yes | Minor units. For hourly, the price of ONE HOUR — ⛔ never a price per minute, and never divided by 60 anywhere on this API. |
currency | string | Yes | — |
effective_from | string | Yes | Applies to work done on or after this date. Resolution is against the work's date, never today, so a rate rise does not re-price last month. |
archived | boolean | Yes | — |
Errors this endpoint can return
401 · 403 · 422