Get Go-Live Readiness
GET/api/ledger/go-live-readiness
Get the latest go-live readiness run, every recorded override, and whether the tenant has yet to start its books. Reads only: it does not run the checks.
accounting:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token + accounting.index permission (403 without it).
Check keys: product_costs, payout_codes_mapped, inventory_gl_tie_out (blocking); provider_inventory_tracking, stale_open_purchase_orders, unfinished_receipts, foreign_currency_bills, accountant_review (warning). provider_inventory_tracking warns when QuickBooks Online or Xero still tracks inventory itself (QuickBooks items of type Inventory, Xero items tracked as inventory); its payload lists the items and link.url points to the guide for switching tracking off. Status is pass, fail (blocking), warn (warning) or skipped (not applicable).
Opening-stock lock: lock_opening_stock_after_go_live (boolean) is the account setting; opening_stock_locked (boolean) is true when that setting is on AND the books are live, i.e. when initial counts can no longer change.
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.