billing
GET /v1/accounting/xero
This organization's connection to its own Xero.
인증
Bearer 토큰으로 API 키를 전송하세요. 키는 반드시 billing.view 권한을 가지고 있어야 하며, 권한이 없는 키는 404가 아닌 403으로 거부됩니다.
이 엔드포인트는 조직 ID를 받지 않습니다. 사용자의 키가 이미 속한 조직을 식별하며, 응답은 해당 조직으로 한정됩니다.
무료 체험하기
대괄호 안에 있는 모든 내용을 사용자 지정 값으로 바꾸고, 키 플레이스홀더는 대시보드의 키로 바꾸세요.
curl -X GET https://api.zinndigital.com/v1/accounting/xero \
-H "Authorization: Bearer zdk_live_…"로그인하셨나요? 대시보드의 API 콘솔이 실제 조직 ID와 본인의 키를 자동으로 채우고 라이브 API를 대상으로 요청을 실행하므로 실제 응답을 확인할 수 있습니다. API 콘솔에서 이 엔드포인트를 여세요
상세 정보
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.
응답
| 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
id | Uuid | 아니요 | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
status | string<not_connected, connected, needs_reconnect, disconnected> | 예 | 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 | 아니요 | 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 | 아니요 | Reseller option — also push the invoices this organization raised to its OWN clients. Never includes invoices Zinn® raised directly to those clients. |
entitled | boolean | 아니요 | 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 | 아니요 | — |
lastSyncAt | string | 아니요 | When a push last SUCCEEDED. Null means never — not "broken". |
brokenSince | string | 아니요 | When it first stopped working, so "down for three weeks" is answerable. |
lastError | string | 아니요 | A reason written for the customer. Never the vendor's error verbatim. |
counts | XeroSyncCounts | 예 | How this organization's invoices stand with Xero. |
이 엔드포인트가 반환할 수 있는 오류
401 · 403 · 429