Skip to main content

Preview Re-Sign-Off Checks

GET 

/api/ledger/close/periods/:period/re-sign-off/preview

The checks a re-sign-off of a restated month would be held to, evaluated now and then rolled back. A month's saved checklist is the evidence it was signed on, so it is never changed here; read this instead to know which warnings to acknowledge and which blocking checks need an override reason before calling Re-Sign Period. Period keys are YYYY-MM.

Required scope: accounting:read

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

Response: checklist — the items in the same shape as the period detail's checklist: key, title, type, severity, status (pass, warn, fail, pending, skipped, open, done), result, can_be_overridden, user_can_override and the rest. Items whose status is warn, and manual items still open, go in acknowledged_keys.

The two expensive checks (trial balance and provider documents reconciled) don't run in this request. Each carries the result of the last Run Re-Sign-Off Checks for the month's current revision, marked result.checked_for_re_sign_off, kept for 30 minutes and dropped by Recheck Period Restatement; otherwise its result at the last sign-off, marked result.as_of_sign_off. Re-Sign Period accepts acknowledgements for what this returns, and its job runs every check again.

Authentication: Bearer token. Requires the accounting settings management permission.

Errors: 422 when the month has no restatement waiting for sign-off or is on or before the hard close date.

The response also carries review: who may re-sign the month under independent review (the close_independent_reviewer accounting setting). changed_by lists the people recorded changing a document behind the month since its last sign-off; while review is required they may not re-sign it, and re_sign_off_blocked_reason says so for the caller. When the tenant has a single accounting user who changed the month, needs_self_review_reason is true and the re-sign-off must include self_review_reason.

Request​

Responses​

OK

Response Headers
    Content-Type