reseller

GET `/v1/reseller/statements/{statementId}`

One statement, with the line for every client.

Упълномощаване

Изпратете API ключ като токен за носене. Ключът трябва да притежава разрешението 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, за да можете да видите действителния отговор. Отворете този крайpoint в 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…

Отговор

Име	Тип	Задължително	Какво представлява
`id`	`Uuid`	Да	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`period_start`	`string`	Да	—
`period_end`	`string`	Да	—
`currency`	`string`	Да	—
`status`	`string<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_minor`	`integer`	Да	—
`unpriced_lines`	`integer`	Да	—
`line_count`	`integer`	Да	—
`invoice_id`	`Uuid \| null`	Не	—
`generated_at`	`string`	Да	—
`lines`	`WholesaleStatementLine[]`	Не	—

Грешки, които този крайpoint може да върне

401 · 403 · 404 · 429

GET /v1/reseller/statements/{statementId}