agency-time
GET /v1/agency/time/report
Time reporting for a period, by person, client and project.
Аутентификация
Передайте API-ключ в качестве маркера носителя (bearer token). Эта конечная точка не указывает конкретное разрешение в спецификации, поэтому предоставьте своему ключу минимум необходимых прав и проверьте ответ, вместо того чтобы делать предположения.
Идентификатор вашей организации
Этот эндпоинт принимает org_id в качестве параметра запроса. Оставьте его пустым, и вызов охватит все поддерево вашей аренды; передайте его, чтобы сузить область вызова до одной организации.
Идентификатор вашей организации находится на экране ключей API в вашей панели управления, рядом с самим ключом. Это один и тот же идентификатор для каждого вашего запроса.
Попробовать
Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.
curl -X GET https://api.zinndigital.com/v1/agency/time/report \
-H "Authorization: Bearer zdk_live_…"Вошли в систему? Консоль API в вашей панели управления автоматически подставляет реальный идентификатор вашей организации и ваш собственный ключ, а также выполняет запрос к работающему API, чтобы вы могли увидеть актуальный ответ. Откройте эту конечную точку в API-консоли
Подробнее
⛔ **Unbilled, unpriced and non-billable are three different things and this says which.** Collapsing them is how an agency loses money quietly: hours with no rate card and hours marked internal both contribute nothing to revenue, but one is money about to be lost and the other is a decision they made. `billable_minutes` is the total minus non-billable — *not* "billed". An hour logged as billable and not yet invoiced is billable work, and calling it anything else is how an agency talks itself out of chasing it.
Параметры
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
org_id (query) | string | Нет | — |
from (query) | string | Нет | Defaults to the first of the current month. |
to (query) | string | Нет | Defaults to today. |
client_id (query) | string | Нет | — |
user_id (query) | string | Нет | — |
Ответ
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
period_start | string | Да | — |
period_end | string | Да | — |
total_minutes | integer | Да | — |
billable_minutes | integer | Нет | Total minus NON-BILLABLE — ⛔ not "billed". An hour logged as billable and not yet invoiced is billable work, and calling it anything else is how an agency talks itself out of ch… |
billed_minutes | integer | Да | — |
unbilled_minutes | integer | Да | — |
non_billable_minutes | integer | Да | — |
billed_minor_by_currency | object | Нет | — |
by_user | TimeReportBucket[] | Нет | — |
by_client | TimeReportBucket[] | Нет | — |
by_project | TimeReportBucket[] | Нет | — |
Ошибки, которые может возвращать этот эндпоинт
401 · 403 · 422