reseller
GET /v1/reseller/statements/{statementId}
One statement, with the line for every client.
Autenticação
Envie uma chave de API como um token de portador. A chave deve ter a permissão reseller.view; uma chave sem ela é recusada com 403, e não 404.
Onde vai o ID da sua organização
Este endpoint aceita org_id como parâmetro de consulta. Omita-o e a chamada abrangerá toda a sua subárvore de locatários; envie-o para restringir a chamada a uma única organização.
O ID da sua organização está na tela de chaves de API no seu painel, ao lado da própria chave. É o mesmo ID em todas as chamadas que você fizer.
Experimente
Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.
curl -X GET https://api.zinndigital.com/v1/reseller/statements/{statementId} \
-H "Authorization: Bearer zdk_live_…"Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API
Detalhes
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`.
Parâmetros
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
statementId (path) | Uuid | Sim | — |
org_id (query) | Uuid | Não | 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… |
Resposta
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
id | Uuid | Sim | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
period_start | string | Sim | — |
period_end | string | Sim | — |
currency | string | Sim | — |
status | string<open, needs_review, issued, paid> | Sim | `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 | Sim | — |
unpriced_lines | integer | Sim | — |
line_count | integer | Sim | — |
invoice_id | Uuid | null | Não | — |
generated_at | string | Sim | — |
lines | WholesaleStatementLine[] | Não | — |
Erros que este endpoint pode retornar
401 · 403 · 404 · 429