Skip to content

Statement

A Statement is a report computed from Entries for one Period under a Policy, such as a P&L, a balance sheet or a payout statement.

Properties

PropertyTypeRequiredDescription
kindstringrequiredWhich report: profitAndLoss, balanceSheet, cashFlow, payout for a Supplier, or capitalAccount for a Fund investor.
periodPeriodrequiredThe Period it reports.
scopestringrequiredWhose books it covers: one Startup, one Company, or a whole Portfolio.
linesjsonrequiredThe computed lines, with captive revenue from sibling Startups shown both in and out.
partyPartyThe Supplier, Partner or investor a payout or capitalAccount Statement is addressed to.

Object

JSON
{
  "$id": "https://api.sb/shiftnote.app/statements/statement_1",
  "$type": "Statement",
  "kind": "profitAndLoss",
  "period": "period_1",
  "scope": "startup",
  "lines": {},
  "party": "party_1"
}

Relationships

  • A Statement reports one Period: a Statement reports one Period; each closed Period carries its P&L, balance sheet and cash flow. reports, inverse statements.

Verbs

  1. getReturns one Statement by id.
    GET /{namespace}/statements/{id}readNo Event
  2. listReturns Statements, newest first, one page at a time.
    GET /{namespace}/statementsreadNo Event

A Statement is kept forever and never edited: it has no update or delete.

Permissions

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

Operationowneradminmemberviewer
Statement.getYesYesYesYes
Statement.listYesYesYesYes

Call it

Text
Show me the latest statement.

Example

At a month's close a Startup gets a profitAndLoss Statement computed from its Entries. Revenue from a sibling Startup shows as captive, both inside and outside the total.