Автентифікація
Надішліть ключ API як маркер носія (bearer token). Ця кінцева точка не вказує конкретного дозволу в специфікації, тому надайте своєму ключу мінімально необхідні права та перевірте відповідь, замість того щоб припускати.
Де вказується ідентифікатор вашої організації
Цей ендпоїнт приймає org_id як параметр запиту. Залиште його порожнім, і виклик охопить увесь ваше дерево орендарів; надішліть його, щоб звузити виклик до однієї організації.
Ідентифікатор вашої організації знаходиться на екрані API-ключів у вашій панелі керування, поруч із самим ключем. Це той самий ідентифікатор у кожному вашому запиті.
Спробувати
Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.
curl -X POST https://api.zinndigital.com/v1/agency-invoicing/clients \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Увійшли в систему? Консоль API у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого API, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі API
Параметри
| Назва | Тип | Обов'язкове | Що це таке |
|---|---|---|---|
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… |
Тіло запиту
| Назва | Тип | Обов'язкове | Що це таке |
|---|---|---|---|
name | string | Ні | — |
contact_name | string | Ні | — |
email | string | Ні | — |
phone | string | Ні | — |
address | string | Ні | — |
tax_number_label | string | Ні | — |
tax_number | string | Ні | — |
currency | string | Ні | — |
country | string | Ні | Two-letter ISO code, or empty or null to clear. Anything else is refused. |
locale | string | Ні | — |
notes | string | Ні | — |
archived | boolean | Ні | — |
Відповідь
| Назва | Тип | Обов'язкове | Що це таке |
|---|---|---|---|
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 | Так | — |
country | string | Ні | ISO-3166-1 alpha-2, optional. Required only to bill this client on Zinn®'s own checkout (the platform organisation, docs/670 §3), where the country decides the VAT on the bill and… |
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 | Ні | — |
Помилки, які може повертати ця кінцева точка
401 · 403 · 404 · 422 · 429