Export Close Pack
POST/api/ledger/close/periods/:period/export
Generate the month-end close pack workbook (XLSX) as a background job: a cover sheet with the period's status, sign-off and checklist outcomes, plus one sheet per report of the pack. Closed periods export their frozen snapshots; open periods export live figures flagged PRELIMINARY. The finished file is delivered as a download from the job result.
Authentication: Bearer token. Requires the accounting sync permission.
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.
Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.
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.