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