Skip to main content

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.

Required scope: accounting:read

Grant 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​

OK

Response Headers
    Content-Type