Update Books Health Check Settings
PUT/api/ledger/health-check/settings
Change the health check settings. Only the fields sent change.
accounting:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token + accounting.manage_settings permission.
Request body:
bands(array of 4 numbers, optional): upper bounds in percent for Close match, Within a normal range, Worth a review and Large difference; above the last reads Rebuild suggested. Must strictly increase. Default[5, 10, 30, 90].account_channel_map(object, optional): provider income account code → sales channel id, or null for "not a channel account". Merged into the stored map.remove_account_codes(array of strings, optional): account codes to remove from the map.footer_enabled(boolean, optional): show the footer under results and on exports. Off by default.footer_text(string or null, optional, max 500).
Errors: 422 when bands do not strictly increase, a sales channel does not exist, or the footer is too long.
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.