agency-time
POST /v1/agency/time/checkout-bills/{billId}/void
Withdraw an unpaid checkout bill; its hours return to the unbilled pool.
Authentication
Send an API key as a bearer token. The key must carry the agency.time.manage permission; 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/checkout-bills/{billId}/void \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "reason": <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
The pay link stops working at once and the time the bill carried is released immediately, so it can be billed again. A paid bill cannot be voided. Requires agency.time.manage and the billing.entitlement.manage staff permission (docs/670 §3).
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
billId (path) | string | Yes | — |
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
reason | string | Yes | — |
org_id | string | No | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
id | string | Yes | — |
reference | string | Yes | — |
status | string<draft, sent, paid, void> | Yes | — |
currency | string | Yes | — |
subtotal_minor | integer | Yes | — |
tax_minor | integer | Yes | — |
total_minor | integer | Yes | — |
recipient_email | string | No | — |
recipient_country | string | No | — |
sent_at | string | No | — |
paid_at | string | No | — |
voided_at | string | No | — |
pay_url | string | Yes | The public page the recipient pays this bill on. |
Errors this endpoint can return
401 · 403 · 404 · 422