agency-time
POST /v1/agency/time/checkout-bills/{billId}/send
E-mail a checkout bill raised from tracked time.
認証
ベアラー トークンとして API キーを送信します。キーには agency.time.manage 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
組織 ID を入力する場所
このエンドポイントは、JSONボディのフィールドとして org_id を受け取ります。
組織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_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 · 503