billing

PATCH /v1/accounting/xero

Change what a connection syncs.

Semua titik akhir billing

Pengesahan

Hantar kunci API sebagai token pembawa. Kunci tersebut mesti membawa kebenaran billing.invoice.manage; kunci yang tidak mempunyainya akan ditolak dengan 403, bukan 404.

Titik akhir ini tidak memerlukan id organisasi. Kunci anda telah mengenal pasti organisasi kepunyaannya, dan respons dis skopkan kepadanya.

Cuba

Gantikan apa sahaja di dalam kurungan sudut dengan nilai anda sendiri, dan pemegang tempat kunci dengan kunci dari papan pemuka anda.

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

Sudah log masuk? Konsol API dalam papan pemuka anda mengisi id organisasi sebenar dan kunci anda sendiri, serta menjalankan permintaan terhadap API langsung supaya anda boleh melihat respons sebenar. Buka penamat ini dalam konsol API

Butiran

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`.

Badan permintaan

NamaJenisDiperlukanApakah ia
includeSubclientInvoicesbooleanYaSee `updateXeroConnection`.

Respons

NamaJenisDiperlukanApakah ia
idUuidTidakUUIDv7 identifier — sortable by creation time (docs/02 §8).
statusstring<not_connected, connected, needs_reconnect, disconnected>Ya`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…
tenantNamestringTidakThe 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…
includeSubclientInvoicesbooleanTidakReseller option — also push the invoices this organization raised to its OWN clients. Never includes invoices Zinn® raised directly to those clients.
entitledbooleanTidakWhether 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.
connectedAtstringTidak
lastSyncAtstringTidakWhen a push last SUCCEEDED. Null means never — not "broken".
brokenSincestringTidakWhen it first stopped working, so "down for three weeks" is answerable.
lastErrorstringTidakA reason written for the customer. Never the vendor's error verbatim.
countsXeroSyncCountsYaHow this organization's invoices stand with Xero.

Ralat yang boleh dikembalikan oleh titik akhir ini

401 · 403 · 404 · 422 · 429