reseller
GET /v1/reseller/statements/{statementId}
One statement, with the line for every client.
Authentication
Send an API key as a bearer token. The key must carry the reseller.view permission; a key without it is refused with 403, not 404.
Where your organisation id goes
This endpoint takes org_id as a query parameter. Leave it out and the call covers your whole tenancy subtree; send it to narrow the call to one organisation.
Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X GET https://api.zinndigital.com/v1/reseller/statements/{statementId} \
-H "Authorization: Bearer zdk_live_…"Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
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`.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
statementId (path) | Uuid | Yes | — |
org_id (query) | Uuid | No | 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… |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
id | Uuid | Yes | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
period_start | string | Yes | — |
period_end | string | Yes | — |
currency | string | Yes | — |
status | string<open, needs_review, issued, paid> | Yes | `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 | Yes | — |
unpriced_lines | integer | Yes | — |
line_count | integer | Yes | — |
invoice_id | Uuid | null | No | — |
generated_at | string | Yes | — |
lines | WholesaleStatementLine[] | No | — |
Errors this endpoint can return
401 · 403 · 404 · 429