agency-invoicing

PATCH `/v1/agency-invoicing/profile`

Change your invoicing identity or defaults.

Упълномощаване

Изпратете API ключ като токен за носене. Ключът трябва да притежава разрешението 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, за да можете да видите действителния отговор. Отворете този крайpoint в 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`.

Грешки, които този крайpoint може да върне

401 · 403 · 404 · 422 · 429

PATCH /v1/agency-invoicing/profile