billing

PATCH `/v1/accounting/xero`

Change what a connection syncs.

المصادقة

أرسل مفتاح واجهة برمجة التطبيقات (API key) كرمز حامل (bearer token). يجب أن يحمل المفتاح إذن billing.invoice.manage؛ والمفتاح الذي لا يملكه يُرفض بالرمز 403 وليس 404.

لا يقبل هذا الطرف أي معرف للمؤسسة. يحدد مفتاحك بالفعل المؤسسة التي ينتمي إليها، وتكون الاستجابة محصورة في نطاقها.

جربه الآن

استبدل أي شيء بين أقواس زاوية بقيمك الخاصة، والعنصر النائب للمفتاح بمفتاح من لوحة تحكمك.

curl -X PATCH https://api.zinndigital.com/v1/accounting/xero \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "includeSubclientInvoices": <boolean> }'

هل سجلت الدخول؟ تقوم وحدة تحكم واجهة برمجة التطبيقات في لوحة التحكم الخاصة بك بربط معرف مؤسستك الحقيقي ومفتاحك الخاص، وتنفذ الطلب مقابل واجهة برمجة التطبيقات المباشرة لتتمكن من رؤية الاستجابة الفعلية. افتح هذه النهاية الطرفية في وحدة تحكم 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 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 · 422 · 429

PATCH /v1/accounting/xero