reseller

GET /v1/reseller/statements/{statementId}

One statement, with the line for every client.

Усі кінцеві точки reseller

Автентифікація

Надішліть ключ API як маркер носія (bearer token). Ключ повинен мати дозвіл reseller.view; ключ без нього відхиляється з кодом 403, а не 404.

Де вказується ідентифікатор вашої організації

Цей ендпоїнт приймає org_id як параметр запиту. Залиште його порожнім, і виклик охопить увесь ваше дерево орендарів; надішліть його, щоб звузити виклик до однієї організації.

Ідентифікатор вашої організації знаходиться на екрані API-ключів у вашій панелі керування, поруч із самим ключем. Це той самий ідентифікатор у кожному вашому запиті.

Спробувати

Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.

curl -X GET https://api.zinndigital.com/v1/reseller/statements/{statementId} \
  -H "Authorization: Bearer zdk_live_…"

Увійшли в систему? Консоль API у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого API, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі API

Деталі

Each line snapshots the client, the plan, Zinn®'s list price, the discount that was applied and the result — so the charge stays explainable after the rate changes. Requires `reseller.view`.

Параметри

НазваТипОбов'язковеЩо це таке
statementId (path)UuidТак
org_id (query)UuidНіWhich of your organizations this applies to. Required only when you belong to more than one here — otherwise it is inferred, and an id outside your direct memberships is a 404 r…

Відповідь

НазваТипОбов'язковеЩо це таке
idUuidТакUUIDv7 identifier — sortable by creation time (docs/02 §8).
period_startstringТак
period_endstringТак
currencystringТак
statusstring<open, needs_review, issued, paid>Так`needs_review` means at least one line could not be priced. It is the one state that must not become an invoice — an under-priced bill looks exactly like a correct one and nobod…
subtotal_minorintegerТак
unpriced_linesintegerТак
line_countintegerТак
invoice_idUuid | nullНі
generated_atstringТак
linesWholesaleStatementLine[]Ні

Помилки, які може повертати ця кінцева точка

401 · 403 · 404 · 429