billing

PATCH `/v1/accounting/xero`

Change what a connection syncs.

אימות

שלחו מפתח API כאסימון נושא (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 בלוח הבקרה שלך מזינה את מזהה הארגון האמיתי שלך ואת המפתח שלך, ומריצה את הבקשה מול ה-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

PATCH /v1/accounting/xero