ავტორიზაცია
API გასაღები გაგზავნეთ როგორც მატარებელი ტოკენი (bearer token). გასაღებს უნდა ჰქონდეს billing.invoice.manage ნებართვა; ამის გარეშე გასაღები უარყოფილი იქნება 403 და არა 404 სტატუსით.
ეს ბოლო წერტილი არ იღებს ორგანიზაციის იდენტიფიკატორს. თქვენი გასაღები უკვე აიდენტიფიცირებს იმ ორგანიზაციას, რომელსაც ის ეკუთვნის, და პასუხი შემოფარგლულია მისით.
სცადეთ
შეSubstituted any value inside angle brackets with your own and the key placeholder with a key from your dashboard.
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-ს წინააღმდეგ, რათა იხილოთ რეალური პასუხი. გაAღით ეს ენდპოინტი 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