Skip to content

Policy

A Policy is a ruling a Startup declares on how its numbers are computed or its choices made, such as revenue recognition.

Properties

PropertyTypeRequiredDescription
ruletextrequiredThe ruling, stated so code can apply it.

Object

JSON
{
  "$id": "https://api.sb/quietcopy.com/policies/policy_1",
  "$type": "Policy",
  "rule": "Example rule"
}

Relationships

  • A Policy computes many Metrics: a Policy rules how Metrics are computed, such as revenue under revenue recognition. computes, inverse computedUnder.

Verbs

  1. createCreates a Policy.
    POST /{namespace}/policiesdoPolicy.created
  2. getReturns one Policy by id.
    GET /{namespace}/policies/{id}readNo Event
  3. listReturns Policies, newest first, one page at a time.
    GET /{namespace}/policiesreadNo Event
  4. updateChanges the given properties of a Policy.
    PATCH /{namespace}/policies/{id}doPolicy.updated
  5. deleteDeletes a Policy; its history is kept.
    DELETE /{namespace}/policies/{id}doPolicy.deleted

Permissions

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

Operationowneradminmemberviewer
Policy.createYesYesNoNo
Policy.getYesYesYesYes
Policy.listYesYesYesYes
Policy.updateYesYesNoNo
Policy.deleteYesYesNoNo

Call it

Text
Add a policy to TutorLoop.

Example

The revenue recognition Policy of a bookkeeping service recognizes each $2,400 catch-up engagement month by month as the books are delivered, not at payment.