agency-invoicing
POST /v1/agency-invoicing/preview
Total a set of lines without saving anything.
Autenticazione
Invia una chiave API come token di tipo bearer. La chiave deve disporre dell'autorizzazione agency.invoicing.view; 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 POST https://api.zinndigital.com/v1/agency-invoicing/preview \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "lines": <AgencyInvoiceLineWrite[]> }'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
Backs the live preview in the invoice builder. ⭐ It calls the SAME arithmetic the save path uses — a preview computed by a second implementation is one that can disagree with the invoice, and you would find out after you had sent it. Requires `agency.invoicing.view`.
Parametri
| Nome | Tipo | Obbligatorio | Che cos'è |
|---|---|---|---|
org_id (query) | Uuid | No | Which of your organizations is invoicing. Required only when you belong to more than one — otherwise it is inferred from your DIRECT membership, never from the subtree-expanded… |
Corpo della richiesta
| Nome | Tipo | Obbligatorio | Che cos'è |
|---|---|---|---|
lines | AgencyInvoiceLineWrite[] | Sì | — |
Risposta
| Nome | Tipo | Obbligatorio | Che cos'è |
|---|---|---|---|
line_totals_minor | integer[] | No | — |
subtotal_minor | integer | Sì | — |
discount_minor | integer | No | — |
tax_minor | integer | Sì | — |
total_minor | integer | Sì | — |
tax_groups | AgencyInvoiceTaxGroup[] | No | — |
Errori che questo endpoint può restituire
401 · 403 · 404 · 422 · 429