reseller

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

One statement, with the line for every client.

Аутентификация

Отправьте ключ 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…

Ответ

Имя	Тип	Обязательно	Что это
`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[]`	Нет	—

Ошибки, которые может возвращать этот эндпоинт

401 · 403 · 404 · 429

GET /v1/reseller/statements/{statementId}