billing
GET /v1/accounting/xero
This organization's connection to its own Xero.
Ìfàṣẹ́pọ̀
Fi bọ́ọ̀lù (bearer token) ranṣẹ gẹ́gẹ́ bí kọ́kọ́rọ́ API. Kọ́kọ́rọ́ náà gbọ́dọ̀ ní ìyọ̀ǹda billing.view; a ó kọ̀ ọ́ silẹ pẹlu 403, kii ṣe 404, ti kọ́kọ́rọ́ náà kò bá ní i.
Ojú abánisọ̀rọ̀ yìí kò gba id ajọ kankan. Kọ́kọ́rọ́ rẹ ti mọ ajọ ti o jẹ ti e, a o si fèsì nipa rẹ̀.
Gbiyanju rẹ
Rọ́pọ̀ èyíkéyìí nínú àwọn àmì ìtọ́ka < > pẹ̀lú iye tirẹ̀, àti àmì ìdánimọ̀ bọ́tìnnì náà pẹ̀lú bọ́tìnnì kan láti inú dásibọ̀ọ̀dù rẹ.
curl -X GET https://api.zinndigital.com/v1/accounting/xero \
-H "Authorization: Bearer zdk_live_…"Ṣé o ti wọlé? Iwọ̀n api ní nú ìgbékalẹ̀ rẹ kún id àjọ gidi rẹ ati bọtini tirẹ, o si nṣiṣẹ ibeere na lòdì si api gidi ki o le rii esi gidi na. Ṣí ojú abáná yìí sílẹ̀ nínú kọnsólù API
Àwọn kúlẹ̀kúlẹ̀
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`.
Idahun
| Orúkọ | Iru | Tí a nílò | Kini o jẹ |
|---|---|---|---|
id | Uuid | Bẹẹkọ | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
status | string<not_connected, connected, needs_reconnect, disconnected> | Bẹẹni | `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 | Bẹẹkọ | 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 | Bẹẹkọ | Reseller option — also push the invoices this organization raised to its OWN clients. Never includes invoices Zinn® raised directly to those clients. |
entitled | boolean | Bẹẹkọ | 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 | Bẹẹkọ | — |
lastSyncAt | string | Bẹẹkọ | When a push last SUCCEEDED. Null means never — not "broken". |
brokenSince | string | Bẹẹkọ | When it first stopped working, so "down for three weeks" is answerable. |
lastError | string | Bẹẹkọ | A reason written for the customer. Never the vendor's error verbatim. |
counts | XeroSyncCounts | Bẹẹni | How this organization's invoices stand with Xero. |
Awọn aṣiṣe ti ibudo ipari yii le da pada
401 · 403 · 429