agency-invoicing
GET /v1/agency-invoicing/clients/{clientId}
One client, with their whole invoice history.
Автентифікація
Надішліть ключ API як маркер носія (bearer token). Ключ повинен мати дозвіл agency.invoicing.view; ключ без нього відхиляється з кодом 403, а не 404.
Де вказується ідентифікатор вашої організації
Цей ендпоїнт приймає org_id як параметр запиту. Залиште його порожнім, і виклик охопить увесь ваше дерево орендарів; надішліть його, щоб звузити виклик до однієї організації.
Ідентифікатор вашої організації знаходиться на екрані API-ключів у вашій панелі керування, поруч із самим ключем. Це той самий ідентифікатор у кожному вашому запиті.
Спробувати
Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.
curl -X GET https://api.zinndigital.com/v1/agency-invoicing/clients/{clientId} \
-H "Authorization: Bearer zdk_live_…"Увійшли в систему? Консоль API у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого API, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі API
Деталі
⭐ Every invoice you have raised against them, what they still owe and what they have been billed in total — the "all client history" screen in one request rather than a filtered list. Requires `agency.invoicing.view`.
Параметри
| Назва | Тип | Обов'язкове | Що це таке |
|---|---|---|---|
clientId (path) | Uuid | Так | — |
org_id (query) | Uuid | Ні | Which of your organizations is invoicing. Required only when you belong to more than one — otherwise it is inferred from your DIRECT membership, never from the subtree-expanded… |
Відповідь
| Назва | Тип | Обов'язкове | Що це таке |
|---|---|---|---|
id | Uuid | Так | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
name | string | Так | — |
contact_name | string | Ні | — |
email | string | Ні | — |
phone | string | Ні | — |
address | string | Ні | — |
tax_number_label | string | Ні | — |
tax_number | string | Ні | — |
currency | string | Так | — |
locale | string | Ні | Which language this client's invoices and payment page render in. An agency in Berlin invoicing a French client sends a French invoice. |
notes | string | Ні | — |
archived | boolean | Ні | — |
created_at | string | Ні | — |
invoices | AgencyInvoice[] | Ні | — |
outstanding_minor | integer | Ні | What this client still owes, in minor units. |
invoiced_total_minor | integer | Ні | Everything ever billed to them, void invoices excluded. |
Помилки, які може повертати ця кінцева точка
401 · 403 · 404 · 429