認証
ベアラー トークンとして API キーを送信します。キーには billing.invoice.manage 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X DELETE https://api.zinndigital.com/v1/accounting/xero \
-H "Authorization: Bearer zdk_live_…"ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
Deletes the stored Xero credential and stops syncing. The record of what was already pushed is kept, so the customer can still see which invoices reached their books. ⛔ Invoices waiting to be sent are marked *not sent* rather than held: a deliberate disconnect must not accumulate a hidden backlog that floods their ledger the day they reconnect. This is the opposite of an expired connection, where the queue IS kept. Requires `billing.invoice.manage`.
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
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 mea… |
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… |
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 · 404 · 429