billing

PATCH `/v1/accounting/xero`

Change what a connection syncs.

Autenticação

Envie uma chave de API como um token de portador. A chave deve ter a permissão billing.invoice.manage; uma chave sem ela é recusada com 403, e não 404.

Este endpoint não requer um ID de organização. Sua chave já identifica a organização à qual pertence, e a resposta é delimitada a ela.

Experimente

Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.

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

Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API

Detalhes

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

Corpo da requisição

Nome	Tipo	Obrigatório	O que é
`includeSubclientInvoices`	`boolean`	Sim	See `updateXeroConnection`.

Resposta

Nome	Tipo	Obrigatório	O que é
`id`	`Uuid`	Não	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`status`	`string<not_connected, connected, needs_reconnect, disconnected>`	Sim	`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`	Não	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`	Não	Reseller option — also push the invoices this organization raised to its OWN clients. Never includes invoices Zinn® raised directly to those clients.
`entitled`	`boolean`	Não	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`	Não	—
`lastSyncAt`	`string`	Não	When a push last SUCCEEDED. Null means never — not "broken".
`brokenSince`	`string`	Não	When it first stopped working, so "down for three weeks" is answerable.
`lastError`	`string`	Não	A reason written for the customer. Never the vendor's error verbatim.
`counts`	`XeroSyncCounts`	Sim	How this organization's invoices stand with Xero.

Erros que este endpoint pode retornar

401 · 403 · 404 · 422 · 429

PATCH /v1/accounting/xero