billing
PATCH /v1/accounting/xero
Change what a connection syncs.
認証
ベアラー トークンとして API キーを送信します。キーには billing.invoice.manage 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X PATCH https://api.zinndigital.com/v1/accounting/xero \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "includeSubclientInvoices": <boolean> }'ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
Today the one option is includeSubclientInvoices, which is meaningful only for a reseller: with it on, the invoices the reseller raised to its own clients are pushed into the reseller's Xero as well as the invoices Zinn® raised to them. ⛔ It never widens the scope to invoices Zinn® raised directly to those clients. Those are Zinn®'s own sales, on Zinn®'s legal entity, and are none of the reseller's business — the engine discriminates on the invoice's legal entity owner, not on the organization tree alone. Requires billing.invoice.manage.
リクエスト本文
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
includeSubclientInvoices | boolean | はい | See updateXeroConnection. |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
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 · 404 · 422 · 429