Skip to main content

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.

Required scope: accounting:read

Grant 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_off or carried_refresh), kind_label, signed_at, user, reason, notes, and reports (report_key, label, revision, is_stale, generated_at). Open one with revision on 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​

OK

Response Headers
    Content-Type