Skip to main content

Get Period Restatement

GET 

/api/ledger/close/periods/:period/restatement

What has moved in a closed month against its latest signed revision, as of the last detection run. Nothing is recomputed, so last_checked_at says how current it is; Recheck Period Restatement runs a fresh comparison. Period keys are YYYY-MM.

Required scope: accounting:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Response:

  • state — needs_review when the change is waiting for re-sign-off, otherwise none. A change at or below the review threshold in accounting settings is recorded and shown here, but stays none.
  • baseline — the signed revision compared against: revision, kind, signed_at, signed_by.
  • headline — net_income_delta, gross_own_change, carried_delta, accounts_changed. Own change happened in this month; carried change came in from an earlier month.
  • reports — one per report: report_key, kind (flow, balance or informational), comparable, reason (why it can't be compared: snapshot_missing, unavailable, schema_changed or previous_month_not_comparable) gross_own (the report's gross own change) and totals that moved, each with field, snapshot, live, delta, own and carried. held is true on a report that can't be compared now: it keeps the change last measured, which stands, and keeps the month needing review, until the report compares again or a re-sign-off accepts it.
  • accounts — accounts that moved: code, name, snapshot, live, own_change, carried, account_id.
  • causes — the source documents behind the change: source_type, source_id, label, entries, last_changed_at, link_route, link_type_label.
  • provider_reach — changes that can't reach the accounting provider: paid_documents (on a document the provider has locked, e.g. paid) and behind_provider_lock (counted per connection: changes dated on or before that connection's lock that it hasn't taken; a change already synced, excluded from sync or voided doesn't count; a batch member counts as synced when its posted batch's current entry is). A re-sign-off doesn't make the provider match, so once one accepted such changes they keep being counted here, read live, until the documents sync or the provider lock is lowered.
  • first_detected_at, last_checked_at — timestamps, or null.

Authentication: Bearer token.

Errors: 422 when the period predates the accounting start date or is in the future.

Request​

Responses​

OK

Response Headers
    Content-Type