agency-time
POST /v1/agency/time/checkout-bills/{billId}/send
E-mail a checkout bill raised from tracked time.
Автентифікація
Надішліть ключ API як маркер носія (bearer token). Ключ повинен мати дозвіл agency.time.manage; ключ без нього відхиляється з кодом 403, а не 404.
Де вказується ідентифікатор вашої організації
Цей ендпоінт приймає org_id як поле в тілі JSON.
Ідентифікатор вашої організації знаходиться на екрані API-ключів у вашій панелі керування, поруч із самим ключем. Це той самий ідентифікатор у кожному вашому запиті.
Спробувати
Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.
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 у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого 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