agency-time

POST /v1/agency/time/checkout-bills/{billId}/send

E-mail a checkout bill raised from tracked time.

所有 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}/send \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

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

详细信息

Mails the pay link to the client, then marks the bill sent — in that order, so a bill is never shown as sent that did not leave. Only a bill time tracking raised; requires agency.time.manage and the billing.entitlement.manage staff permission (docs/670 §3).

参数

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

请求正文

名称类型必填内容简介
org_idstring

响应

名称类型必填内容简介
idstring
referencestring
statusstring<draft, sent, paid, void>
currencystring
subtotal_minorinteger
tax_minorinteger
total_minorinteger
recipient_emailstring
recipient_countrystring
sent_atstring
paid_atstring
voided_atstring
pay_urlstringThe public page the recipient pays this bill on.

此端点可能返回的错误

401 · 403 · 404 · 422 · 503