Автентифікація
Надішліть ключ API як маркер носія (bearer token). Ключ повинен мати дозвіл reseller.manage; ключ без нього відхиляється з кодом 403, а не 404.
Де вказується ідентифікатор вашої організації
Цей ендпоїнт приймає org_id як параметр запиту. Залиште його порожнім, і виклик охопить увесь ваше дерево орендарів; надішліть його, щоб звузити виклик до однієї організації.
Ідентифікатор вашої організації знаходиться на екрані API-ключів у вашій панелі керування, поруч із самим ключем. Це той самий ідентифікатор у кожному вашому запиті.
Спробувати
Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.
curl -X PUT https://api.zinndigital.com/v1/reseller/brand/invoice \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Увійшли в систему? Консоль API у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого API, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі API
Деталі
Requires `reseller.manage`. ⭐ These are printed on **your** invoices, under your company, your VAT number and your number series — so the payment details are yours. Your clients are charged on your own payment gateway and you are the merchant of record for them. ⛔ **Changing these does not change invoices already issued**, and must not: every value is frozen onto each document when it is raised. Restating where last month's invoice was payable would be a different demand for money under the same number. Refused with 422 when your clients are still invoiced under Zinn Digital®.
Параметри
| Назва | Тип | Обов'язкове | Що це таке |
|---|---|---|---|
org_id (query) | Uuid | Ні | The organization this call acts on. Optional for a caller with exactly one direct membership; **required** for anyone with more than one — which is every reseller and every agen… |
Тіло запиту
| Назва | Тип | Обов'язкове | Що це таке |
|---|---|---|---|
footer_text | string | Ні | Small print at the foot of the document — typically your registered company name and number. |
payment_terms | string | Ні | When and how you expect to be paid. |
payment_details | string | Ні | Remittance details — account name, IBAN, BIC, a payment link. Line breaks are preserved exactly as you type them. |
support_contact | string | Ні | Where your client asks about this invoice. |
Відповідь
| Назва | Тип | Обов'язкове | Що це таке |
|---|---|---|---|
configured | boolean | Так | False when your clients are still invoiced under Zinn Digital®, in which case there is nothing here to set. |
legal_entity_name | string | Так | The company these invoices are issued by. |
footer_text | string | Так | — |
payment_terms | string | Так | — |
payment_details | string | Так | — |
support_contact | string | Так | — |
Помилки, які може повертати ця кінцева точка
401 · 403 · 422 · 429