agency-time
POST /v1/agency/time/checkout-bills/{billId}/send
E-mail a checkout bill raised from tracked time.
Упълномощаване
Изпратете API ключ като токен за носене. Ключът трябва да притежава разрешението 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, за да можете да видите действителния отговор. Отворете този крайpoint в 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. |
Грешки, които този крайpoint може да върне
401 · 403 · 404 · 422 · 503