Budget methods: update, delete

Reference for Budget, one group of Budget methods.

Budget.update

Changes the given properties of a Budget. Verb page.

TypeScript

interface BudgetVerbs {
  update(input: BudgetUpdateInput, options?: SB.CallOptions): SB.Call<Budget>
}

Emits Budget.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Budget.
`account`	`string`		The chart-of-accounts code it plans, such as `expense.ads`.
`period`	Period		The Period it plans.
`amount`	`money`		The amount set for the account in the Period.

Returns

Output	Type	Required	Description
`budget`	Budget	required	The Budget.

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

Example

TypeScript

import { $ } from 'startup-builder'

const budget = await $.Budget.update({ id: 'budget_qnCdsFGLVN', account: 'expense.ads' })

Deletes a Budget: a soft delete that keeps its history, undone by Thing.restore. Verb page.

TypeScript

interface BudgetVerbs {
  delete(input: BudgetDeleteInput, options?: SB.CallOptions): SB.Call<Budget>
}

Emits Budget.deleted.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Budget.

Returns

Output	Type	Required	Description
`budget`	Budget	required	The Budget.

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

Example

TypeScript

import { $ } from 'startup-builder'

const budget = await $.Budget.delete({ id: 'budget_qnCdsFGLVN' })