Skip to main content

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.

Required scope: accounting:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Authentication: Requires Bearer token + accounting.sync permission.

Request body:

  • format (string, required): xlsx or pdf

Errors: 422 when the run has not completed or the format is not allowed; 404 when the run does not exist.

Request​

Responses​

OK

Response Headers
    Content-Type