billing

GET /v1/accounting/xero

This organization's connection to its own Xero.

Sve billing krajnje tačke

Autentifikacija

Pošaljite API ključ kao bearer token. Ključ mora imati dozvolu billing.view; ključ bez nje se odbija sa 403, a ne sa 404.

Ovaj krajnji tačka ne prihvata ID organizacije. Vaš ključ već identifikuje organizaciju kojoj pripada, a odgovor je ograničen na nju.

Isprobajte

Zamenite bilo šta u uglastim zagradama sopstvenim vrednostima, a ključni placeholder sa ključem sa vaše kontrolne table.

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

Prijavljeni ste? API konzola na vašoj kontrolnoj tabli automatski popunjava ID vaše stvarne organizacije i vaš sopstveni ključ, i izvršava zahtev nad API-jem uživo tako da možete videti stvarni odgovor. Otvorite ovu krajnju tačku u API konzoli

Detalji

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

Odgovor

NazivVrstaObaveznoŠta je ovo
idUuidNeUUIDv7 identifier — sortable by creation time (docs/02 §8).
statusstring<not_connected, connected, needs_reconnect, disconnected>Da`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…
tenantNamestringNeThe 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…
includeSubclientInvoicesbooleanNeReseller option — also push the invoices this organization raised to its OWN clients. Never includes invoices Zinn® raised directly to those clients.
entitledbooleanNeWhether 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.
connectedAtstringNe
lastSyncAtstringNeWhen a push last SUCCEEDED. Null means never — not "broken".
brokenSincestringNeWhen it first stopped working, so "down for three weeks" is answerable.
lastErrorstringNeA reason written for the customer. Never the vendor's error verbatim.
countsXeroSyncCountsDaHow this organization's invoices stand with Xero.

Greške koje ovaj krajnji tačka može da vrati

401 · 403 · 429