agency-invoicing

PATCH `/v1/agency-invoicing/tax-rates/{rateId}`

Change a tax rate.

Автентифікація

Надішліть ключ API як маркер носія (bearer token). Ключ повинен мати дозвіл agency.invoicing.manage; ключ без нього відхиляється з кодом 403, а не 404.

Де вказується ідентифікатор вашої організації

Цей ендпоїнт приймає org_id як параметр запиту. Залиште його порожнім, і виклик охопить увесь ваше дерево орендарів; надішліть його, щоб звузити виклик до однієї організації.

Ідентифікатор вашої організації знаходиться на екрані API-ключів у вашій панелі керування, поруч із самим ключем. Це той самий ідентифікатор у кожному вашому запиті.

Спробувати

Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.

curl -X PATCH https://api.zinndigital.com/v1/agency-invoicing/tax-rates/{rateId} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

Увійшли в систему? Консоль API у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого API, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі API

Деталі

⭐ 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`.

Параметри

Назва	Тип	Обов'язкове	Що це таке
`rateId (path)`	`Uuid`	Так	—
`org_id (query)`	`Uuid`	Ні	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…

Тіло запиту

Назва	Тип	Обов'язкове	Що це таке
`name`	`string`	Ні	—
`rate_bps`	`integer`	Ні	—
`registration_number`	`string`	Ні	—
`note`	`string`	Ні	—
`is_default`	`boolean`	Ні	—

Відповідь

Назва	Тип	Обов'язкове	Що це таке
`id`	`Uuid`	Так	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`name`	`string`	Так	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`	Так	—
`registration_number`	`string`	Ні	—
`note`	`string`	Ні	—
`is_default`	`boolean`	Ні	—

Помилки, які може повертати ця кінцева точка

401 · 403 · 404 · 422 · 429

PATCH /v1/agency-invoicing/tax-rates/{rateId}