Skip to content

by Startups.Studio

Period.close

POST /{namespace}/periods/{period}/close

Close ends a month’s books once every Entry in the Period is reconciled, and makes its statements final.

Noun: Period
Mode: do
Event: Period.closed

You, to your agent

Close the latest period.

curl -X POST https://api.sb/ledgerlark.com/periods/period_1/close \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

import { $ } from 'startup-builder'

const period = await $.Period.close({ period: 'period_1' })

npx startup-builder do Period.close --json '{"period":"period_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Period.close({ period: 'period_1' })"
  }
}

Inputs

Input	Type	Required	Description
`period`	Period	required	The open Period.

Outputs

Output	Type	Required	Description
`period`	Period	required	The closed Period.

Effects

Emits Period.closed.
Performed by the Finance Lead.
Two-way: it runs at once, in the try, send and do modes.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	Period.close
The record is not in a state that allows this Verb, so the call is refused.	`refused`	Read the record, run the Verb that moves it to an allowed state, then retry.	Period.close

When it waits

Gate	Default
Decision class	Low: two-way, nothing at stake
Delay window	None: it runs once review passes.
Limit	The call Limit of the Permission it runs under.
Over the Limit	It waits `pending` for an Approval from the Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

Period

Previous Page

Period.get

Next Page