Get Setup Status
GET/api/ledger/setup/status
Accounting setup wizard state: which steps are done and what's left.
Any valid API token can call this endpoint — no specific scope required. Manage tokens.
Authentication: Requires Bearer token.
Returns generation_enabled (the per-tenant on/off switch), has_chart + chart_count (does a chart of accounts exist), accounting_integration ({provider:xero|qbo, name} or null), and required_mappings — the step 2 role list (role, label, category plus the default code/name/type), and suggested_accounts — the step 1 chart of accounts, each code defined once (code, name, type). Manual setup is two steps: edit the accounts, then map each role to one of them. Several roles can share an account. warehouses lists the stock-holding warehouses, for the optional step that gives a warehouse its own inventory account.
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.