agency-invoicing
PATCH /v1/agency-invoicing/profile
Change your invoicing identity or defaults.
Authentication
Send an API key as a bearer token. The key must carry the agency.invoicing.manage permission; a key without it is refused with 403, not 404.
Where your organisation id goes
This endpoint takes org_id as a query parameter. Leave it out and the call covers your whole tenancy subtree; send it to narrow the call to one organisation.
Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X PATCH https://api.zinndigital.com/v1/agency-invoicing/profile \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
⛔ `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`.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
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… |
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
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 | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
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 | Yes | — |
default_payment_terms_days | integer | No | — |
default_footer | string | No | — |
default_notes | string | No | — |
number_prefix | string | Yes | — |
number_padding | integer | No | — |
next_number | integer | Yes | 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`. |
Errors this endpoint can return
401 · 403 · 404 · 422 · 429