Skip to content

Period.locked

Emitted each time a Period is locked.

Period.lock emits Period.locked when it completes on a Period.

PropertyValue
Emitted byPeriod.lock
NounPeriod
WakesNone.

Payload

Each delivery is an Event record. data holds what Period.lock returns.

FieldTypeRequiredDescription
namestringrequiredPeriod.locked.
atdatetimerequiredWhen it happened.
seqintegerIts position in the namespace, one more than the Event before; any seq is a cursor into the history.
datajsonrequiredThe Thing as the Action left it.
data.periodPeriodrequiredThe locked Period.
data.period.monthdaterequiredThe first day of the month it covers.
data.period.statusstringrequiredOne of Open, Closed, or Locked.

Example

JSON
{
  "$id": "https://api.sb/routewise.dev/events/event_1",
  "$type": "Event",
  "name": "Period.locked",
  "at": "2026-10-22T12:00:00Z",
  "data": {
    "period": {
      "$id": "https://api.sb/routewise.dev/periods/period_1",
      "$type": "Period",
      "month": "2026-10-22",
      "status": "Open"
    }
  },
  "seq": 1
}