Policy
A Policy is a ruling a Startup declares on how its numbers are computed or its choices made, such as revenue recognition.
Properties
| Property | Type | Required | Description |
|---|---|---|---|
rule | text | required | The ruling, stated so code can apply it. |
Object
{
"$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, inversecomputedUnder.
Verbs
createCreates a Policy.POST /{namespace}/policiesgetReturns one Policy by id.GET /{namespace}/policies/{id}listReturns Policies, newest first, one page at a time.GET /{namespace}/policiesupdateChanges the given properties of a Policy.PATCH /{namespace}/policies/{id}deleteDeletes a Policy; its history is kept.DELETE /{namespace}/policies/{id}
Permissions
Which Access level may call each Verb. One-way Verbs wait their delay window.
| Operation | owner | admin | member | viewer |
|---|---|---|---|---|
Policy.create | Yes | Yes | No | No |
Policy.get | Yes | Yes | Yes | Yes |
Policy.list | Yes | Yes | Yes | Yes |
Policy.update | Yes | Yes | No | No |
Policy.delete | Yes | Yes | No | No |
Call it
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.