Get Pending Start Date Transition
GET/api/ledger/opening-balance/transition
Returns the pending guarded accounting-start-date change awaiting confirmation, or null under start_date_transition when the books are settled (no change in flight).
Any valid API token can call this endpoint — no specific scope required. Manage tokens.
When an applied opening balance's effective accounting start date is moved, the change is PARKED rather than applied immediately: the old anchor's books are already posted, so the user must explicitly confirm (apply) or abandon (rollback). This read-only endpoint surfaces that parked change so the UI can render the review banner.
Authentication: Requires Bearer token.
Response fields (start_date_transition):
id— transition row idstatus—pendingwhile awaiting confirmationold_effective_start_date/new_effective_start_date— the effective accounting start dates (where the opening entry posts)old_anchor_date/new_anchor_date— the trial-balance "as at" anchor (= effective start − 1 day) that the replacement opening balance is imported againstold_opening_total— the frozen total of the currently-applied opening balancenew_opening_total— the PROJECTED total of the replacement opening balance at the new anchor. This isnulluntil the replacement trial balance has been captured atnew_anchor_date— a GET preview never forces a metered provider capture, so the projection is simply withheld until the async capture lands.
Returns { "start_date_transition": null } when no transition is pending.
Request
Responses
- 200
- 401
- 403
- 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.
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.