Get Period History
GET/api/ledger/close/periods/:period/history
A month's permanent record: every signed revision with the reports signed at it, and every event, newest first. A month never touched returns both empty. Period keys are YYYY-MM.
accounting:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Response:
current_revision— the latest signed revision, 0 if none.revisions—revision,kind(close,re_sign_offorcarried_refresh),kind_label,signed_at,user,reason,notes, andreports(report_key,label,revision,is_stale,generated_at). Open one withrevisionon Get Close Report.events—id,event,event_label,user,from_date,to_date,amount,reason,context,created_at. Events:closed,restatement_detected,restatement_updated,restatement_cleared,re_signed,reopened.
Authentication: Bearer token.
Errors: 422 when the period predates the accounting start date or is in the future.
Event types: started (a close was started), preparation_taken_over (someone took over preparing the month; context.previous_preparer_id names who they replaced), closed, restatement_detected, restatement_updated, restatement_cleared, re_signed, reopened, hard_date_moved, provider_lock_changed.
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.