agency-time
POST /v1/agency/time/billing-runs
Bill now — turn unbilled time into a draft invoice.
認証
ベアラー トークンとして API キーを送信します。このエンドポイントでは仕様に特定の権限が記載されていないため、キーに必要な最小限の権限を付与し、推測するのではなくレスポンスを確認してください。
組織 ID を入力する場所
このエンドポイントは、JSONボディのフィールドとして org_id を受け取ります。
組織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