Export Books Health Check Run
POST/api/ledger/health-check/runs/:id/export
Export a completed run as XLSX (a summary sheet plus one sheet per section) or PDF, to share with an accountant. The export is built in the background as a tracked job; its result carries the download link. Trust is shown beside every grade, and the footer is included only when it is turned on.
accounting:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token + accounting.sync permission.
Request body:
format(string, required):xlsxorpdf
Errors: 422 when the run has not completed or the format is not allowed; 404 when the run does not exist.
Request
Responses
- 200
- 401
- 403
- 404
- 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.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
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.