billing

DELETE /v1/accounting/xero

Disconnect this organization's Xero.

Alle billing-eindpunten

Authenticatie

Stuur een API-sleutel mee als bearer token. De sleutel moet over de permissie billing.invoice.manage beschikken; een sleutel zonder deze permissie wordt geweigerd met een 403 in plaats van een 404.

Dit eindpunt vereist geen organisatie-id. Uw sleutel identificeert al de organisatie waartoe deze behoort, en het antwoord is hierop afgestemd.

Probeer het

Vervang alles tussen punthaakjes door uw eigen waarden en de sleutelplaatsvervanger door een sleutel uit uw dashboard.

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

Ingelogd? De API-console in je dashboard vult je echte organisatie-id en je eigen sleutel in, en voert het verzoek uit tegen de live API zodat je de daadwerkelijke respons kunt zien. Open dit eindpunt in de API-console

Details

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

Reactie

NaamTypeVerplichtWat dit is
idUuidNeeUUIDv7 identifier — sortable by creation time (docs/02 §8).
statusstring<not_connected, connected, needs_reconnect, disconnected>Ja`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…
tenantNamestringNeeThe 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…
includeSubclientInvoicesbooleanNeeReseller option — also push the invoices this organization raised to its OWN clients. Never includes invoices Zinn® raised directly to those clients.
entitledbooleanNeeWhether 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.
connectedAtstringNee
lastSyncAtstringNeeWhen a push last SUCCEEDED. Null means never — not "broken".
brokenSincestringNeeWhen it first stopped working, so "down for three weeks" is answerable.
lastErrorstringNeeA reason written for the customer. Never the vendor's error verbatim.
countsXeroSyncCountsJaHow this organization's invoices stand with Xero.

Fouten die dit eindpunt kan retourneren

401 · 403 · 404 · 429