Preview Hard Close Date Move
POST/api/ledger/close/hard-date/preview
Shows what moving the hard close date would do, and writes nothing. Run it before Move Hard Close Date.
accounting:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Body:
hard_date— date (Y-m-d) or null, required. Null previews clearing the date.override_unclosed— boolean, optional. Preview crossing months that were never closed.
Response:
direction—forward,backornone.fromandtoare the current and proposed dates.can_proceed— false while a blocker remains. It does not account for in-flight warnings, which the move asks you to acknowledge.blockers— each withkey,message, and where relevantperiodandoverridable. Keys:no_change,not_month_end,month_not_ended,before_start_date,job_running,unclosed_months(the only overridable one, and it stays listed when overridden),open_restatement,not_comparable,no_history.warnings— each withkey,messageandcount. Forward:in_flight,in_flight_undated. Back:carry_forwards_booked,nightly_sweep.consequences— what lowering lets go (all empty on a forward move):months_returning_to_closed,carry_forwards_withdrawn,carry_forwards_booked,frozen_days_cleared,skipped_rows_requeued,sweep_reachable_months.provider_alignment— each connection as it would stand after the move, in the same shape as Get Hard Close Date'salignment.months_crossed— months in the span that were never closed.
Restatement blockers read the last detection run; the move itself checks again.
Authentication: Bearer token. Requires the accounting.period.hard_close permission.
Errors: 422 when hard_date is missing or not Y-m-d. Rule failures are returned as blockers with a 200, not as errors.
Request
Responses
- 200
- 401
- 403
- 422
- 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.
Unprocessable Content
Response Headers
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.