reseller
GET /v1/reseller/statements/{statementId}
One statement, with the line for every client.
Authentification
Envoyez une clé API en tant que jeton du porteur. La clé doit posséder l'autorisation reseller.view ; une clé qui ne l'a pas est refusée avec le code 403, et non 404.
Où insérer l'ID de votre organisation
Cet point de terminaison prend org_id comme paramètre de requête. Omettez-le et l'appel couvrira l'ensemble de votre sous-arbre de location ; envoyez-le pour restreindre l'appel à une seule organisation.
L'identifiant de votre organisation se trouve sur l'écran des clés API de votre tableau de bord, à côté de la clé elle-même. Il s'agit du même identifiant pour chaque appel que vous effectuez.
Essayer
Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.
curl -X GET https://api.zinndigital.com/v1/reseller/statements/{statementId} \
-H "Authorization: Bearer zdk_live_…"Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API
Détails
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`.
Paramètres
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
statementId (path) | Uuid | Oui | — |
org_id (query) | Uuid | Non | 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… |
Réponse
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
id | Uuid | Oui | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
period_start | string | Oui | — |
period_end | string | Oui | — |
currency | string | Oui | — |
status | string<open, needs_review, issued, paid> | Oui | `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 | Oui | — |
unpriced_lines | integer | Oui | — |
line_count | integer | Oui | — |
invoice_id | Uuid | null | Non | — |
generated_at | string | Oui | — |
lines | WholesaleStatementLine[] | Non | — |
Erreurs que cet point de terminaison peut renvoyer
401 · 403 · 404 · 429