Get Books Health Check Estimate
GET/api/ledger/health-check/estimate
How many metered provider reads a window would cost: one trial balance per month end that is not already stored, plus the month end before the window when it does not start a financial year, plus one base-currency read.
accounting:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token + accounting.index permission.
Errors: 422 with errors.health_check[0].data.reason = not_connected or invalid_window.
Request
Responses
- 200
- 401
- 403
- 422
- 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.
Unprocessable Entity
Response Headers
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.