agency-time

POST `/v1/agency/time/checkout-bills/{billId}/void`

Withdraw an unpaid checkout bill; its hours return to the unbilled pool.

所有 agency-time 端点

所有开发者文档 →

身份验证

请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 agency.time.manage 权限；缺少该权限的密钥将被拒绝并返回 403 状态码，而非 404。

您的组织 ID 应填在此处

此端点接受 org_id 作为 JSON 正文中的一个字段。

您的组织ID位于控制面板的API密钥屏幕上，就在密钥本身的旁边。这是您在每次调用时使用的相同ID。

免费试用

将尖括号中的内容替换为您自己的值，并将键占位符替换为您仪表板中的一个键。

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> }'

已登录？您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥，并针对实时 API 运行请求，以便您查看实际的响应。在 API 控制台中打开此端点

详细信息

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).

参数

名称	类型	必填	内容简介
`billId (path)`	`string`	是	—

请求正文

名称	类型	必填	内容简介
`reason`	`string`	是	—
`org_id`	`string`	否	—

响应

名称	类型	必填	内容简介
`id`	`string`	是	—
`reference`	`string`	是	—
`status`	`string<draft, sent, paid, void>`	是	—
`currency`	`string`	是	—
`subtotal_minor`	`integer`	是	—
`tax_minor`	`integer`	是	—
`total_minor`	`integer`	是	—
`recipient_email`	`string`	否	—
`recipient_country`	`string`	否	—
`sent_at`	`string`	否	—
`paid_at`	`string`	否	—
`voided_at`	`string`	否	—
`pay_url`	`string`	是	The public page the recipient pays this bill on.

此端点可能返回的错误

401 · 403 · 404 · 422