Skip to main content

Move Hard Close Date

POST 

/api/ledger/close/hard-date

Move the hard close date in either direction, or clear it. This is the only way to change the date. The rules are checked now and again in the background job that makes the move, after a fresh comparison of the months it would harden. Returns the background job id.

Required scope: accounting:write

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

Moving forward: the date must be the last day of a month that has ended, every month in the span must be closed, and none may be waiting for re-sign-off or unable to be compared with what was signed. Lowering or clearing reopens the months it uncovers to posting and withdraws their carry-forwards; preview it first.

Body:

  • hard_date — date (Y-m-d) or null, required. Null clears the date.
  • reason — string, required, up to 500 characters. Goes on the hard close date history.
  • acknowledge_in_flight — boolean, optional. Required as true when entries dated in the span have not posted yet.
  • override_unclosed — boolean, optional. Cross months that were never closed. Needs the accounting.period.override permission.

SKU can't write a provider's lock date, so set it in the provider as well.

Authentication: Bearer token. Requires the accounting.period.hard_close permission.

Errors: 422 with hard_date listing every remaining blocker (see Preview Hard Close Date Move), reason when it is blank, or acknowledge_in_flight when in-flight entries were not acknowledged. 403 when override_unclosed crosses unclosed months without the override permission.

Request​

Responses​

OK

Response Headers
    Content-Type