Skip to content
StartupBuilder
by startups.studio
by Startups.Studio
Code
Changelog
APIFinancePeriod

Period routes: close, lock, recognize

The Period Verbs close, lock, recognize as api.sb routes, with inputs, result, refusals and an example.

Reference for Period, one group of Period routes.

Period.close

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

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

Path: period. Emits Period.closed.

Inputs

InputTypeRequiredDescription
periodPeriodrequiredThe open Period.

Returns

OutputTypeRequiredDescription
periodPeriodrequiredThe closed Period.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.
The record is not in a state that allows this Verb, so the call is refused.refusedRead the record, run the Verb that moves it to an allowed state, then retry.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/periods/period_VEVuYACTsH/close \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "period": {
    "$id": "https://api.sb/leaseline.app/periods/period_VEVuYACTsH",
    "$type": "Period",
    "month": "2026-10-22",
    "status": "Closed"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Period.close",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Period.lock

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

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

Path: period. Emits Period.locked.

Inputs

InputTypeRequiredDescription
periodPeriodrequiredThe closed Period.

Returns

OutputTypeRequiredDescription
periodPeriodrequiredThe locked Period.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.
The record is not in a state that allows this Verb, so the call is refused.refusedRead the record, run the Verb that moves it to an allowed state, then retry.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/periods/period_VEVuYACTsH/lock \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "period": {
    "$id": "https://api.sb/leaseline.app/periods/period_VEVuYACTsH",
    "$type": "Period",
    "month": "2026-10-22",
    "status": "Locked"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Period.lock",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Period.recognize

Recognize moves the revenue a Period earned out of deferred revenue, by the Startup’s revenue-recognition Policy. Verb page.

Text
POST /{namespace}/periods/{period}/recognize

Path: period. Emits Period.recognized.

Inputs

InputTypeRequiredDescription
periodPeriodrequiredThe open Period to recognize.

Returns

OutputTypeRequiredDescription
entrieslist of EntryrequiredThe recognition Entries it posted.
periodPeriodrequiredThe Period whose revenue was recognized.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/periods/period_VEVuYACTsH/recognize \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "entries": [
    {
      "$id": "https://api.sb/leaseline.app/entries/entry_syZbJCW683",
      "$type": "Entry",
      "account": "cash",
      "amount": {
        "amount": 29,
        "currency": "USD"
      },
      "direction": "debit",
      "startup": "startup_l3hr1EnUGY"
    }
  ],
  "period": {
    "$id": "https://api.sb/leaseline.app/periods/period_VEVuYACTsH",
    "$type": "Period",
    "month": "2026-10-22",
    "status": "Open"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Period.recognize",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

get, list, update

Previous

Quote

Next