agency-time

DELETE /v1/agency/time/rates/{rateId}

Archive a rate card.

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 DELETE https://api.zinndigital.com/v1/agency/time/rates/{rateId} \
  -H "Authorization: Bearer zdk_live_…"

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

⛔ Archives; never deletes. A rate card that priced an invoice is part of how that money was arrived at, and a deleted row makes an issued document unexplainable.

Parameters

NameTypeRequiredWhat it is
rateId (path)stringYes

Response

NameTypeRequiredWhat it is
idstringYes
scopestring<task, project, client, org>Yes
scope_idstringNoThe task/project/client this applies to. `null` exactly when scope is `org`.
kindstring<hourly, fixed>Yes
amount_minorintegerYesMinor units. For `hourly`, the price of ONE HOUR — ⛔ never a price per minute, and never divided by 60 anywhere on this API.
currencystringYes
effective_fromstringYesApplies 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.
archivedbooleanYes

Errors this endpoint can return

401 · 403 · 404