reseller

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

One statement, with the line for every client.

Authentifizierung

Senden Sie einen API-Schlüssel als Bearer-Token. Der Schlüssel muss über die Berechtigung reseller.view verfügen; ein Schlüssel ohne diese wird mit 403 statt 404 abgelehnt.

Hier kommt Ihre Organisations-ID hin

Dieser Endpunkt akzeptiert org_id als Abfrageparameter. Lassen Sie ihn weg, erfasst der Aufruf Ihren gesamten Mandanten-Unterbaum; übergeben Sie ihn, um den Aufruf auf eine Organisation einzugrenzen.

Die ID Ihrer Organisation finden Sie im Dashboard auf dem Bildschirm für API-Schlüssel direkt neben dem Schlüssel selbst. Sie ist bei jedem Ihrer Aufrufe dieselbe.

Ausprobieren

Ersetzen Sie alles in spitzen Klammern durch Ihre eigenen Werte und den Platzhalter für den Schlüssel durch einen Schlüssel aus Ihrem Dashboard.

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

Angemeldet? Die API-Konsole in Ihrem Dashboard trägt automatisch Ihre echte Organisations-ID sowie Ihren eigenen Schlüssel ein und führt die Anfrage gegen die Live-API aus, sodass Sie die tatsächliche Antwort sehen können. Öffnen Sie diesen Endpunkt in der API-Konsole

Details

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

Parameter

Name	Typ	Erforderlich	Was es ist
`statementId (path)`	`Uuid`	Ja	—
`org_id (query)`	`Uuid`	Nein	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…

Antwort

Name	Typ	Erforderlich	Was es ist
`id`	`Uuid`	Ja	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`period_start`	`string`	Ja	—
`period_end`	`string`	Ja	—
`currency`	`string`	Ja	—
`status`	`string<open, needs_review, issued, paid>`	Ja	`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`	Ja	—
`unpriced_lines`	`integer`	Ja	—
`line_count`	`integer`	Ja	—
`invoice_id`	`Uuid \| null`	Nein	—
`generated_at`	`string`	Ja	—
`lines`	`WholesaleStatementLine[]`	Nein	—

Fehler, die dieser Endpunkt zurückgeben kann

401 · 403 · 404 · 429