Skip to main content

List Connections

GET 
/api/ledger/connections

The connections panel view-model: one row per supported accounting integration instance (QuickBooks Online / Xero).

Authorization

Any valid API token can call this endpoint — no specific scope required. Manage tokens.

Authentication: Requires Bearer token.

Per-connection fields:

  • id / provider (qbo | xero) / name
  • health.sync_status — the connection's sync status value; health.paused — true when sync is not active
  • lock_date — the imported provider books-closed lock date (Y-m-d), or null
  • rate_budget_remaining — Xero only: the remaining daily API budget from the X-DayLimit-Remaining header; null for QBO (no daily budget)
  • last_inbound_event_at — when the last inbound (webhook/CDC) event arrived, or null
  • open_operations — open sync-operation counts keyed by state (pending, queued, in_flight, failed_retryable, needs_action); empty object when no open work
  • capabilities — per-provider feature flags used to show/hide reconciliation lanes: supports_trial_balance (Starting Balances lane — true for both Xero and QuickBooks Online), supports_bank_statement_lines (Statement Match lane — Xero only), supports_webhooks (inbound change events — Xero only)

Request​

Responses​

OK

Response Headers
    Content-Type