Skip to main content
POST
Close a period

Authorizations

Authorization
string
header
required

Same flow; ledger:write is required for any mutation.

Body

application/json
period_start
string<date-time>
required
period_end
string<date-time>
required
closed_by_label
string
required

Person or system signing off on the close. Recorded forever.

Example:

"controller@acme"

note
string

Response

Period closed; trial balance snapshotted

object
enum<string>
required
Available options:
period_close
id
string<uuid>
required
period_start
string<date-time>
required
period_end
string<date-time>
required
closed_by_label
string
required

Who closed it, as you labelled them. Not a Kordio identity.

Example:

"controller@acme"

created_at
string<date-time>
required
note
string | null
reopened_at
string<date-time> | null
reopened_by_label
string | null
trial_balance
object

The trial balance as it stood at the moment of closing.