reseller

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

One statement, with the line for every client.

Uwierzytelnianie

Wyślij klucz API jako token bearer. Klucz musi posiadać uprawnienie reseller.view; klucz bez niego jest odrzucany z kodem 403, a nie 404.

Miejsce na identyfikator organizacji

Ten punkt końcowy przyjmuje org_id jako parametr zapytania. Pomiń go, a wywołanie obejmie całe drzewo dzierżawy; prześlij go, aby ograniczyć wywołanie do jednej organizacji.

Identyfikator Twojej organizacji znajduje się na ekranie kluczy API w Twoim panelu, obok samego klucza. Jest to ten sam identyfikator w każdym wywołaniu, które wykonujesz.

Wypróbuj

Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.

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

Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API

Szczegóły

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`.

Parametry

Nazwa	Typ	Wymagane	Co to jest
`statementId (path)`	`Uuid`	Tak	—
`org_id (query)`	`Uuid`	Nie	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…

Odpowiedź

Nazwa	Typ	Wymagane	Co to jest
`id`	`Uuid`	Tak	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`period_start`	`string`	Tak	—
`period_end`	`string`	Tak	—
`currency`	`string`	Tak	—
`status`	`string<open, needs_review, issued, paid>`	Tak	`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`	Tak	—
`unpriced_lines`	`integer`	Tak	—
`line_count`	`integer`	Tak	—
`invoice_id`	`Uuid \| null`	Nie	—
`generated_at`	`string`	Tak	—
`lines`	`WholesaleStatementLine[]`	Nie	—

Błędy, które ten punkt końcowy może zwrócić

401 · 403 · 404 · 429