Autenticazione
Invia una chiave API come token di tipo bearer. La chiave deve disporre dell'autorizzazione reseller.manage; una chiave sprovvista di tale autorizzazione viene rifiutata con 403 anziché 404.
L'ID della tua organizzazione va qui
Questo endpoint accetta org_id come parametro di query. Omettilo e la chiamata coprirà l'intero sottoalbero del tuo tenant; invialo per limitare la chiamata a una singola organizzazione.
L'identificativo della tua organizzazione si trova nella schermata delle chiavi API nella tua dashboard, accanto alla chiave stessa. È lo stesso identificativo in ogni chiamata che effettui.
Provalo
Sostituisci qualsiasi elemento tra parentesi angolari con i tuoi valori e il segnaposto key con una chiave dalla tua dashboard.
curl -X PUT https://api.zinndigital.com/v1/reseller/brand/invoice \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Hai effettuato l'accesso? La console API nella tua dashboard inserisce il tuo ID organizzazione reale e la tua chiave personale, ed esegue la richiesta sull'API live in modo da poter vedere la risposta effettiva. Apri questo endpoint nella console API
Dettagli
Requires `reseller.manage`. ⭐ These are printed on **your** invoices, under your company, your VAT number and your number series — so the payment details are yours. Your clients are charged on your own payment gateway and you are the merchant of record for them. ⛔ **Changing these does not change invoices already issued**, and must not: every value is frozen onto each document when it is raised. Restating where last month's invoice was payable would be a different demand for money under the same number. Refused with 422 when your clients are still invoiced under Zinn Digital®.
Parametri
| Nome | Tipo | Obbligatorio | Che cos'è |
|---|---|---|---|
org_id (query) | Uuid | No | The organization this call acts on. Optional for a caller with exactly one direct membership; **required** for anyone with more than one — which is every reseller and every agen… |
Corpo della richiesta
| Nome | Tipo | Obbligatorio | Che cos'è |
|---|---|---|---|
footer_text | string | No | Small print at the foot of the document — typically your registered company name and number. |
payment_terms | string | No | When and how you expect to be paid. |
payment_details | string | No | Remittance details — account name, IBAN, BIC, a payment link. Line breaks are preserved exactly as you type them. |
support_contact | string | No | Where your client asks about this invoice. |
Risposta
| Nome | Tipo | Obbligatorio | Che cos'è |
|---|---|---|---|
configured | boolean | Sì | False when your clients are still invoiced under Zinn Digital®, in which case there is nothing here to set. |
legal_entity_name | string | Sì | The company these invoices are issued by. |
footer_text | string | Sì | — |
payment_terms | string | Sì | — |
payment_details | string | Sì | — |
support_contact | string | Sì | — |
Errori che questo endpoint può restituire
401 · 403 · 422 · 429