Skip to content

by Startups.Studio

Period.lock

POST /{namespace}/periods/{period}/lock

Lock seals a closed Period, so any later correction posts to the next open Period.

Noun: Period
Mode: do
Event: Period.locked

You, to your agent

Lock the latest period.

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

import { $ } from 'startup-builder'

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

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

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

Inputs

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

Outputs

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

Effects

Emits Period.locked.
Performed by the Finance Lead.
One-way (money): it waits out its delay window, and runs in the 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.lock
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.lock

When it waits

Gate	Default
Decision class	Medium: one-way, bounded (money)
Delay window	1 business hour, in which a watcher can pause, redirect or cancel it; then it runs.
Limit	The spend Limit of the Permission or Mandate 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.list

Previous Page

Period.recognize

Next Page