agency-invoicing
PATCH /v1/agency-invoicing/profile
Change your invoicing identity or defaults.
Autenticazione
Invia una chiave API come token di tipo bearer. La chiave deve disporre dell'autorizzazione agency.invoicing.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 PATCH https://api.zinndigital.com/v1/agency-invoicing/profile \
-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
⛔ `next_number` is deliberately NOT settable. Rewinding a sequence would mint a duplicate number for a document already in a client's hands; advancing it leaves a gap a tax authority will ask about. Requires `agency.invoicing.manage`.
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'è |
|---|---|---|---|
business_name | string | No | — |
address | string | No | — |
email | string | No | — |
phone | string | No | — |
website | string | No | — |
tax_number_label | string | No | — |
tax_number | string | No | — |
payment_instructions | string | No | — |
logo_sha256 | string | No | — |
accent_colour | string | No | — |
default_currency | string | No | — |
default_payment_terms_days | integer | No | — |
default_footer | string | No | — |
default_notes | string | No | — |
number_prefix | string | No | — |
number_padding | integer | No | — |
Risposta
| Nome | Tipo | Obbligatorio | Che cos'è |
|---|---|---|---|
business_name | string | No | — |
address | string | No | The registered address, one line per newline. Free-form because address shape is a property of a country, not of our schema. |
email | string | No | — |
phone | string | No | — |
website | string | No | — |
tax_number_label | string | No | What the agency calls its tax registration — "VAT number", "ABN", "GSTIN", "EIN". ⛔ Printed only when the number is set too: a label with no number is an empty row, and a number… |
tax_number | string | No | — |
payment_instructions | string | No | Bank details or a "PayPal me at …" line, printed on the document verbatim and shown on the payment page. ⭐ Never translated — translating a payment instruction is not a safe act. |
logo_sha256 | string | No | A digest into the content-addressed logo store, never a URL. That is what lets the PDF inline the mark with no network call at render time. |
accent_colour | string | No | — |
default_currency | string | Sì | — |
default_payment_terms_days | integer | No | — |
default_footer | string | No | — |
default_notes | string | No | — |
number_prefix | string | Sì | — |
number_padding | integer | No | — |
next_number | integer | Sì | The next sequence number. ⛔ Read-only. Rewinding it would mint a duplicate number for a document already in a client's hands. |
next_number_preview | string | No | What the next invoice will be called, e.g. `INV-0042`. |
Errori che questo endpoint può restituire
401 · 403 · 404 · 422 · 429