Get Close Report
GET/api/ledger/close/periods/:period/reports/:report
One report of the month-end pack. Report keys: income_statement, balance_sheet, trial_balance, inventory_valuation, cogs, ginr, reconciliation_summary. On a closed period this returns the snapshot frozen at close time (source: snapshot); otherwise a live build flagged preliminary. Payloads carry statement-level rows plus a totals map of headline figures.
Authentication: Bearer token.
Errors: 422 for an unknown report key.
Request
Responses
- 200
- 401
- 403
- 404
- 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.
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.