agency-time
GET /v1/agency/time/unbilled
What is outstanding, per client and currency.
Автентифікація
Надішліть ключ API як маркер носія (bearer token). Ця кінцева точка не вказує конкретного дозволу в специфікації, тому надайте своєму ключу мінімально необхідні права та перевірте відповідь, замість того щоб припускати.
Де вказується ідентифікатор вашої організації
Цей ендпоїнт приймає org_id як параметр запиту. Залиште його порожнім, і виклик охопить увесь ваше дерево орендарів; надішліть його, щоб звузити виклик до однієї організації.
Ідентифікатор вашої організації знаходиться на екрані API-ключів у вашій панелі керування, поруч із самим ключем. Це той самий ідентифікатор у кожному вашому запиті.
Спробувати
Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.
curl -X GET https://api.zinndigital.com/v1/agency/time/unbilled \
-H "Authorization: Bearer zdk_live_…"Увійшли в систему? Консоль API у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого API, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі API
Деталі
The same figure a threshold trigger fires on — one function, deliberately, because two implementations of "how much is outstanding" is how a client is shown £900 and invoiced £1,100. unpriced_minutes is reported separately from the money: hours logged against work with no rate card are not worth zero, they are unpriced, and an agency that cannot see them will not fix them. can_bill says whether the invoicing suite is reachable at all, so the console never offers a Bill-now button that can only refuse.
Параметри
| Назва | Тип | Обов'язкове | Що це таке |
|---|---|---|---|
org_id (query) | string | Ні | — |
client_id (query) | string | Ні | — |
until (query) | string | Ні | Only count work up to and including this date. |
Відповідь
| Назва | Тип | Обов'язкове | Що це таке |
|---|---|---|---|
data | UnbilledBucket[] | Так | — |
can_bill | boolean | Так | Whether the agency invoicing suite is reachable at all. Told to the console rather than discovered by pressing the button, so it never offers a Bill-now that can only refuse. |
billing_target | string<agency_invoicing, platform_checkout> | Ні | Where Bill now sends the work. platform_checkout only for Zinn Digital®'s own organisation, whose client work is billed on Zinn®'s checkout (docs/670 §3). |
can_start_from_quote | boolean | Ні | Whether this caller may list quote requests and start projects from them here — the issuer organisation AND the same quotes.manage staff permission the admin queue requires. |
can_manage_checkout_bills | boolean | Ні | Whether this caller may send and void checkout bills here — the issuer organisation AND the same billing.entitlement.manage staff permission the admin console requires. |
Помилки, які може повертати ця кінцева точка
401 · 403 · 422