Skip to main content

Get Hard Close Date

GET 

/api/ledger/close/hard-date

The hard close date: nothing dated on or before it can change until it is lowered. Returns the date (null when none is set), who set it and when, every past move of the date and of each provider's imported lock, newest first (history: event is hard_date_moved or provider_lock_changed; a provider row names its connection as {id, name} and has no user or reason), where each connected provider stands, and eligible_dates, the month ends a move can reach with no override, oldest first.

Required scope: accounting:read

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

Each alignment row compares a connected provider's imported lock with the date: direction is aligned, behind (the provider's lock is earlier, or it has none, so those months can still be edited there), ahead (the provider's lock is later) or none (neither has a date). enforced says whether that provider's date also freezes the months here. message is a plain sentence for the mismatch, null when there is none.

Authentication: Bearer token.

Request​

Responses​

OK

Response Headers
    Content-Type