billing

PATCH `/v1/accounting/xero`

Change what a connection syncs.

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

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

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

Спробувати

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

curl -X PATCH https://api.zinndigital.com/v1/accounting/xero \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "includeSubclientInvoices": <boolean> }'

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

Деталі

Today the one option is `includeSubclientInvoices`, which is meaningful only for a reseller: with it on, the invoices the reseller raised **to its own clients** are pushed into the reseller's Xero as well as the invoices Zinn® raised to them. ⛔ It never widens the scope to invoices Zinn® raised **directly** to those clients. Those are Zinn®'s own sales, on Zinn®'s legal entity, and are none of the reseller's business — the engine discriminates on the invoice's legal entity owner, not on the organization tree alone. Requires `billing.invoice.manage`.

Тіло запиту

Назва	Тип	Обов'язкове	Що це таке
`includeSubclientInvoices`	`boolean`	Так	See `updateXeroConnection`.

Відповідь

Назва	Тип	Обов'язкове	Що це таке
`id`	`Uuid`	Ні	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`status`	`string<not_connected, connected, needs_reconnect, disconnected>`	Так	`connected` is healthy. `needs_reconnect` means the link died (Xero expires a refresh token after 60 days of inactivity, and access can be revoked in Xero) — invoices raised mea…
`tenantName`	`string`	Ні	The Xero organization's own name. ⭐ The single most useful field on the screen: connecting the wrong company is the mistake that hurts, and the name is what lets a customer see…
`includeSubclientInvoices`	`boolean`	Ні	Reseller option — also push the invoices this organization raised to its OWN clients. Never includes invoices Zinn® raised directly to those clients.
`entitled`	`boolean`	Ні	Whether the plan includes accounting sync (or it has been bought as an add-on). Reported even when false so the screen can explain rather than show nothing.
`connectedAt`	`string`	Ні	—
`lastSyncAt`	`string`	Ні	When a push last SUCCEEDED. Null means never — not "broken".
`brokenSince`	`string`	Ні	When it first stopped working, so "down for three weeks" is answerable.
`lastError`	`string`	Ні	A reason written for the customer. Never the vendor's error verbatim.
`counts`	`XeroSyncCounts`	Так	How this organization's invoices stand with Xero.

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

401 · 403 · 404 · 422 · 429

PATCH /v1/accounting/xero