agency-time
POST /v1/agency/time/billing-runs
Bill now — turn unbilled time into a draft invoice.
身份验证
请将 API 密钥作为 bearer 令牌发送。此端点在规范中未指明具体的权限，因此请为您的密钥赋予所需的最小权限，并通过检查响应来确认，而不是盲目假设。
您的组织 ID 应填在此处
此端点接受 org_id 作为 JSON 正文中的一个字段。
您的组织ID位于控制面板的API密钥屏幕上，就在密钥本身的旁边。这是您在每次调用时使用的相同ID。
免费试用
将尖括号中的内容替换为您自己的值，并将键占位符替换为您仪表板中的一个键。
curl -X POST https://api.zinndigital.com/v1/agency/time/billing-runs \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "client_id": <string>, "currency": <string> }'已登录？您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥，并针对实时 API 运行请求，以便您查看实际的响应。 在 API 控制台中打开此端点
详细信息
The owner's *"as well as sending on demand invoices"*. Claims the client's unbilled, priced work, hands it to the agency invoicing suite as a **draft**, and records what came back. ⛔ The entries are claimed in a committed transaction **before** the invoicing suite is called, so no other trigger can select them while the call is in flight. The idempotency key handed to the suite is derived from the sorted entry ids rather than minted, so a retry after a crash is given back the invoice that already exists instead of raising a second one for the same hours. `reconcile_state` is `ok` only when the invoice's total for these lines equals our own exact arithmetic. `mismatch` means do not send it.
请求正文
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
client_id | string | 是 | — |
currency | string | 是 | — |
until | string | 否 | Bill work up to and including this date — "everything to the end of last month". |
notes | string | 否 | — |
org_id | string | 否 | — |
响应
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
id | string | 是 | — |
client_id | string | 否 | — |
currency | string | 是 | — |
period_start | string | 否 | — |
period_end | string | 否 | — |
trigger | string<manual, on_log, day_of_month, threshold> | 是 | — |
status | string<claimed, invoiced, failed, released> | 是 | `claimed` is the state between claiming the time and the invoicing suite's reply — a process that dies there leaves one, and the recovery pass finishes it with the same derived… |
subtotal_minor | integer | 是 | Our own exact arithmetic, before tax. What the invoice is reconciled against. |
minutes_total | integer | 是 | — |
duration_label | string | 否 | — |
entry_count | integer | 否 | — |
fixed_line_count | integer | 否 | — |
invoice_id | string | 否 | — |
invoice_number | string | 否 | — |
invoice_created | boolean | 否 | FALSE means the invoicing suite's idempotency key fired and handed back an invoice an earlier attempt had already raised. Surfaced rather than hidden: it is the observable that… |
reconcile_state | string<pending, ok, mismatch, unavailable> | 否 | Whether the invoice's total for these lines equals our own arithmetic **exactly**. There is no "close enough": both sides compute from the same two integers, so any difference i… |
reconcile_detail | string | 否 | — |
invoiced_at | string | 否 | — |
released_at | string | 否 | — |
last_error | string | 否 | — |
created_at | string | 是 | — |
actual | object | 否 | What this run actually consumed, derived from the time entries rather than read off the run's stored columns — so a divergence is visible on the screen. |
此端点可能返回的错误
401 · 403 · 422