agency-invoicing
PATCH /v1/agency-invoicing/tax-rates/{rateId}
Change a tax rate.
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/tax-rates/{rateId} \
-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
⭐ Changing a rate does NOT restate any invoice that already carries it — the percentage and the name are copied onto each line when it is saved. That is what lets you move VAT from 20% to 17.5% next April without rewriting last month. Requires `agency.invoicing.manage`.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
rateId (path) | Uuid | Yes | — |
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 |
|---|---|---|---|
name | string | No | — |
rate_bps | integer | No | — |
registration_number | string | No | — |
note | string | No | — |
is_default | boolean | No | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
id | Uuid | Yes | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
name | string | Yes | What the document calls it. ⛔ Free text, not an enum: the line must read "VAT", "MwSt.", "TVA" or "Sales tax" depending on who is being invoiced. |
rate_bps | integer | Yes | — |
registration_number | string | No | — |
note | string | No | — |
is_default | boolean | No | — |
Errors this endpoint can return
401 · 403 · 404 · 422 · 429