Period

PropertiesCopy Anchor Link

ObjectCopy Anchor Link

{
  "$id": "https://api.sb/routewise.dev/periods/period_1",
  "$type": "Period",
  "month": "2026-10-22",
  "status": "Open"
}

RelationshipsCopy Anchor Link

• A Period has many Budgets: a Budget plans one Period, read beside the actual Entries that fall in it. budgets, inverse plans.
• A Period has many Entries: an Entry posts to the month its Event happened; closing the Period locks it. entries, inverse fallsIn.
• A Period has many Statements: a Statement reports one Period; each closed Period carries its P&L, balance sheet and cash flow. statements, inverse reports.

VerbsCopy Anchor Link

1. getReturns one Period by id.
   GET /{namespace}/periods/{id}readNo Event
2. listReturns Periods, newest first, one page at a time.
   GET /{namespace}/periodsreadNo Event
3. updateChanges the given properties of a Period.
   PATCH /{namespace}/periods/{id}doPeriod.updated
4. closeClose ends a month’s books once every Entry in the Period is reconciled, and makes its statements final.
   POST /{namespace}/periods/{period}/closedoPeriod.closed
5. lockLock seals a closed Period, so any later correction posts to the next open Period.
   POST /{namespace}/periods/{period}/lockdoPeriod.locked
6. recognizeRecognize moves the revenue a Period earned out of deferred revenue, by the Startup’s revenue-recognition Policy.
   POST /{namespace}/periods/{period}/recognizedoPeriod.recognized

PermissionsCopy Anchor Link

Which Access level may call each Verb. One-way Verbs wait their delay window.

Call itCopy Anchor Link

Close the latest period.

ExampleCopy Anchor Link

Period 2026-03 of a tutoring marketplace's books closes on the third working day, once 1,840 Transactions reconcile. Then it locks, and no Entry in it changes.