billing

PATCH `/v1/accounting/xero`

Change what a connection syncs.

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

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

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

401 · 403 · 404 · 422 · 429

PATCH /v1/accounting/xero