Get Dashboard Summary
GET/api/ledger/dashboard
The Accounting v2 section landing summary — the whole dashboard in one call. Composed from the existing managers/repositories so it never diverges from the tab it summarizes.
Any valid API token can call this endpoint — no specific scope required. Manage tokens.
Authentication: Requires Bearer token.
Sections:
generation_health— the derived backlog signal (state: healthy | behind | failing | paused) with its label + Vuetify color, plus the raw inputs: kill-switchenabled,environment_override, outboxpending/failed, the drainlast_processed_atheartbeat,stale_after_minutes(5), and the next scheduled runs.behindrequires BOTH queued work AND a stale heartbeat — a large-but-draining queue stays healthy.kpis— four headline counts:pending_sync(pending_sync + update_pending + syncing + retrying),needs_attention(needs_attention + failed + conflict + removed_in_provider),synced, andoutbox_backlog(outbox pending + failed source documents not yet turned into entries).status_breakdown— per-display-status counts in enum order, each with label + color (click a segment to open the All tab filtered on thatdisplay_status). Statuses with no entries are included with count 0.needs_attention— the parkedtotal, thegroup_count, and the top 5 error-causegroups.connections— the accounting connections view-model (provider, health, lock date, rate budget, last inbound, open ops).reconciliation—balance_mismatches: current entries whose line sums disagree with their header totals.recent_entries— the 5 most recent entries (same shape as the entries table).
Request
Responses
- 200
- 401
- 403
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.