Skip to content

by Startups.Studio

Period.recognize

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

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

Noun: Period
Mode: do
Event: Period.recognized

You, to your agent

Recognize the latest period.

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

import { $ } from 'startup-builder'

const { entries, period } = await $.Period.recognize({ period: 'period_1' })

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

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

Inputs

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

Outputs

Output	Type	Required	Description
`entries`	list of Entry	required	The recognition Entries it posted.
`period`	Period	required	The Period whose revenue was recognized.

Effects

Emits Period.recognized.
Performed by the Finance Lead.
Two-way: it runs at once, in the try, send and do modes.
Runs daily, and once more before the Period closes.
Recognizes a Subscription by elapsed days and an Order on delivery.

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.recognize

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.lock

Previous Page

Period.update

Next Page