Get Close Period
GET/api/ledger/close/periods/:period
Full detail for one period (period key format YYYY-MM): the close checklist with each item's latest evaluation, lock state (active lock date plus per-connection provider lock dates), report snapshot index, and close/reopen eligibility flags. For a month that has not been started, the checklist is a live read-only preview.
Authentication: Bearer token.
Errors: 422 when the period predates the accounting start date or is in the future.
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.