Budget · StartupBuilder

Properties

Property	Type	Required	Description
`account`	`string`	required	The chart-of-accounts code it plans, such as `expense.ads`.
`period`	Period	required	The Period it plans.
`amount`	`money`	required	The amount set for the account in the Period.
`actual`	`money`		What the Entries in the Period add up to so far.

Object

JSON

{
  "$id": "https://api.sb/patentpad.com/budgets/budget_1",
  "$type": "Budget",
  "account": "expense.ads",
  "period": "period_1",
  "amount": {
    "amount": 499,
    "currency": "USD"
  },
  "actual": {
    "amount": 499,
    "currency": "USD"
  }
}

Relationships

A Budget plans one Period: a Budget plans one Period, read beside the actual Entries that fall in it. plans, inverse budgets.

Verbs

createCreates a Budget.
POST /{namespace}/budgetsdoBudget.created
getReturns one Budget by id.
GET /{namespace}/budgets/{id}readNo Event
listReturns Budgets, newest first, one page at a time.
GET /{namespace}/budgetsreadNo Event
updateChanges the given properties of a Budget.
PATCH /{namespace}/budgets/{id}doBudget.updated
deleteDeletes a Budget; its history is kept.
DELETE /{namespace}/budgets/{id}doBudget.deleted

Permissions

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

Operation	`owner`	`admin`	`member`	`viewer`
`Budget.create`	Yes	Yes	Yes	No
`Budget.get`	Yes	Yes	Yes	Yes
`Budget.list`	Yes	Yes	Yes	Yes
`Budget.update`	Yes	Yes	Yes	No
`Budget.delete`	Yes	Yes	Yes	No

Call it

Text

Add a budget to ShiftNote with a period.

Example

A tutoring marketplace sets a $4,000 Budget on expense.ads for one month. By the 18th its Entries add up to $3,100, so actual reads $3,100 and the remaining $900 bounds the month's ad spend.

PropertiesCopy Anchor Link

ObjectCopy Anchor Link

RelationshipsCopy Anchor Link

VerbsCopy Anchor Link

PermissionsCopy Anchor Link

Call itCopy Anchor Link

ExampleCopy Anchor Link