billing
GET /v1/accounting/xero
This organization's connection to its own Xero.
Authenticatie
Stuur een API-sleutel mee als bearer token. De sleutel moet over de permissie billing.view 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 GET https://api.zinndigital.com/v1/accounting/xero \
-H "Authorization: Bearer zdk_live_…"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
Whether this organization has connected its own Xero, which Xero organization it is pointed at, and how many of its invoices are waiting, synced or failed. ⛔ `status` distinguishes three states and they are **not** interchangeable. `not_connected` means they have never connected (or disconnected on purpose); `needs_reconnect` means the link existed and **died** — Xero ends a refresh token after 60 days of inactivity, and it also ends when someone removes our access in Xero. Rendering the second as the first tells a paying customer their connection never existed, and hides the fact that invoices are queuing behind it. `entitled` is reported whether or not it is true, so the screen can draw an honest upgrade prompt rather than an empty panel. Requires `billing.view`.
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 · 429