billing

PATCH `/v1/accounting/xero`

Change what a connection syncs.

Authentification

Envoyez une clé API en tant que jeton du porteur. La clé doit posséder l'autorisation billing.invoice.manage ; une clé qui ne l'a pas est refusée avec le code 403, et non 404.

Cet endpoint ne prend aucun identifiant d'organisation. Votre clé identifie déjà l'organisation à laquelle elle appartient, et la réponse y est limitée.

Essayer

Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.

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

Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API

Détails

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

Corps de la requête

Nom	Type	Obligatoire	Qu'est-ce que c'est
`includeSubclientInvoices`	`boolean`	Oui	See `updateXeroConnection`.

Réponse

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

Erreurs que cet point de terminaison peut renvoyer

401 · 403 · 404 · 422 · 429

PATCH /v1/accounting/xero