billing

PATCH /v1/accounting/xero

Change what a connection syncs.

Svi billing krajnji točke

Autentifikacija

Pošaljite API ključ kao nosivi token. Ključ mora imati dozvolu billing.invoice.manage; ključ bez nje se odbija s kodom 403, a ne 404.

Ova krajnja točka ne prihvaća ID organizacije. Vaš ključ već identificira organizaciju kojoj pripada, a odgovor je ograničen na nju.

Isprobajte

Zamijenite sve unutar šiljastih zagrada svojim vlastitim vrijednostima, a rezervirano mjesto za ključ s ključem iz vaše nadzorne ploče.

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

Prijavljeni ste? API konzola na vašoj nadzornoj ploči automatski unosi stvarni ID vaše organizacije i vaš vlastiti ključ te šalje zahtjev prema aktivnom API-ju kako biste mogli vidjeti stvarni odgovor. Otvori ovu krajnju točku u API konzoli

Pojedinosti

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

Tijelo zahtjeva

NazivVrstaObaveznoŠto je to
includeSubclientInvoicesbooleanDaSee `updateXeroConnection`.

Odgovor

NazivVrstaObaveznoŠto je to
idUuidNeUUIDv7 identifier — sortable by creation time (docs/02 §8).
statusstring<not_connected, connected, needs_reconnect, disconnected>Da`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…
tenantNamestringNeThe 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…
includeSubclientInvoicesbooleanNeReseller option — also push the invoices this organization raised to its OWN clients. Never includes invoices Zinn® raised directly to those clients.
entitledbooleanNeWhether 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.
connectedAtstringNe
lastSyncAtstringNeWhen a push last SUCCEEDED. Null means never — not "broken".
brokenSincestringNeWhen it first stopped working, so "down for three weeks" is answerable.
lastErrorstringNeA reason written for the customer. Never the vendor's error verbatim.
countsXeroSyncCountsDaHow this organization's invoices stand with Xero.

Pogreške koje ova krajnja točka može vratiti

401 · 403 · 404 · 422 · 429