billing

GET `/v1/accounting/xero`

This organization's connection to its own Xero.

Autentizace

Zašlete API klíč jako nosný token (bearer token). Klíč musí mít oprávnění billing.view; klíč bez něj je odmítnut s kódem 403, nikoli 404.

Tento koncový bod nevyžaduje žádné ID organizace. Váš klíč již identifikuje organizaci, ke které patří, a odpověď je na ni omezena.

Vyzvednout

Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.

curl -X GET https://api.zinndigital.com/v1/accounting/xero \
  -H "Authorization: Bearer zdk_live_…"

Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API

Podrobnosti

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.

Odpověď

Název	Typ	Požadováno	Co to je
`id`	`Uuid`	Ne	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`status`	`string<not_connected, connected, needs_reconnect, disconnected>`	Ano	`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…
`tenantName`	`string`	Ne	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 it…
`includeSubclientInvoices`	`boolean`	Ne	Reseller option — also push the invoices this organization raised to its OWN clients. Never includes invoices Zinn® raised directly to those clients.
`entitled`	`boolean`	Ne	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`	Ne	—
`lastSyncAt`	`string`	Ne	When a push last SUCCEEDED. Null means never — not "broken".
`brokenSince`	`string`	Ne	When it first stopped working, so "down for three weeks" is answerable.
`lastError`	`string`	Ne	A reason written for the customer. Never the vendor's error verbatim.
`counts`	`XeroSyncCounts`	Ano	How this organization's invoices stand with Xero.

Chyby, které může tento koncový bod vrátit

401 · 403 · 429