billing

DELETE /v1/accounting/xero

Disconnect this organization's Xero.

Všechny koncové body billing

Autentizace

Zašlete API klíč jako nosný token (bearer token). Klíč musí mít oprávnění billing.invoice.manage; klíč bez něj je odmítnut s kódem 403, nikoli 404.

Tento koncový bod nevyžaduje žádné ID organizace. Váš klíč již identifikuje organizaci, ke které patří, a odpověď je na ni omezena.

Vyzvednout

Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.

curl -X DELETE https://api.zinndigital.com/v1/accounting/xero \
  -H "Authorization: Bearer zdk_live_…"

Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API

Podrobnosti

Deletes the stored Xero credential and stops syncing. The record of what was already pushed is kept, so the customer can still see which invoices reached their books. ⛔ Invoices waiting to be sent are marked *not sent* rather than held: a deliberate disconnect must not accumulate a hidden backlog that floods their ledger the day they reconnect. This is the opposite of an expired connection, where the queue IS kept. Requires `billing.invoice.manage`.

Odpověď

NázevTypPožadovánoCo to je
idUuidNeUUIDv7 identifier — sortable by creation time (docs/02 §8).
statusstring<not_connected, connected, needs_reconnect, disconnected>Ano`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.
countsXeroSyncCountsAnoHow this organization's invoices stand with Xero.

Chyby, které může tento koncový bod vrátit

401 · 403 · 404 · 429