Authenticatie
Stuur een API-sleutel mee als bearer token. De sleutel moet over de permissie billing.invoice.manage beschikken; een sleutel zonder deze permissie wordt geweigerd met een 403 in plaats van een 404.
Dit eindpunt vereist geen organisatie-id. Uw sleutel identificeert al de organisatie waartoe deze behoort, en het antwoord is hierop afgestemd.
Probeer het
Vervang alles tussen punthaakjes door uw eigen waarden en de sleutelplaatsvervanger door een sleutel uit uw dashboard.
curl -X PATCH https://api.zinndigital.com/v1/accounting/xero \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "includeSubclientInvoices": <boolean> }'Ingelogd? De API-console in je dashboard vult je echte organisatie-id en je eigen sleutel in, en voert het verzoek uit tegen de live API zodat je de daadwerkelijke respons kunt zien. Open dit eindpunt in de API-console
Details
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`.
Aanvraaglichaam
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
includeSubclientInvoices | boolean | Ja | See `updateXeroConnection`. |
Reactie
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
id | Uuid | Nee | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
status | string<not_connected, connected, needs_reconnect, disconnected> | Ja | `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 | Nee | 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 | Nee | Reseller option — also push the invoices this organization raised to its OWN clients. Never includes invoices Zinn® raised directly to those clients. |
entitled | boolean | Nee | 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 | Nee | — |
lastSyncAt | string | Nee | When a push last SUCCEEDED. Null means never — not "broken". |
brokenSince | string | Nee | When it first stopped working, so "down for three weeks" is answerable. |
lastError | string | Nee | A reason written for the customer. Never the vendor's error verbatim. |
counts | XeroSyncCounts | Ja | How this organization's invoices stand with Xero. |
Fouten die dit eindpunt kan retourneren
401 · 403 · 404 · 422 · 429