agency-invoicing

PATCH `/v1/agency-invoicing/profile`

Change your invoicing identity or defaults.

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

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

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

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

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

Спробувати

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

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

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

Деталі

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

Параметри

Назва	Тип	Обов'язкове	Що це таке
`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…

Тіло запиту

Назва	Тип	Обов'язкове	Що це таке
`business_name`	`string`	Ні	—
`address`	`string`	Ні	—
`email`	`string`	Ні	—
`phone`	`string`	Ні	—
`website`	`string`	Ні	—
`tax_number_label`	`string`	Ні	—
`tax_number`	`string`	Ні	—
`payment_instructions`	`string`	Ні	—
`logo_sha256`	`string`	Ні	—
`accent_colour`	`string`	Ні	—
`default_currency`	`string`	Ні	—
`default_payment_terms_days`	`integer`	Ні	—
`default_footer`	`string`	Ні	—
`default_notes`	`string`	Ні	—
`number_prefix`	`string`	Ні	—
`number_padding`	`integer`	Ні	—

Відповідь

Назва	Тип	Обов'язкове	Що це таке
`business_name`	`string`	Ні	—
`address`	`string`	Ні	The registered address, one line per newline. Free-form because address shape is a property of a country, not of our schema.
`email`	`string`	Ні	—
`phone`	`string`	Ні	—
`website`	`string`	Ні	—
`tax_number_label`	`string`	Ні	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`	Ні	—
`payment_instructions`	`string`	Ні	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`	Ні	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`	Ні	—
`default_currency`	`string`	Так	—
`default_payment_terms_days`	`integer`	Ні	—
`default_footer`	`string`	Ні	—
`default_notes`	`string`	Ні	—
`number_prefix`	`string`	Так	—
`number_padding`	`integer`	Ні	—
`next_number`	`integer`	Так	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`	Ні	What the next invoice will be called, e.g. `INV-0042`.

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

401 · 403 · 404 · 422 · 429

PATCH /v1/agency-invoicing/profile