Skip to content

by Startups.Studio

Budget.update

PATCH /{namespace}/budgets/{id}

Changes the given properties of a Budget.

Noun: Budget
Mode: do
Event: Budget.updated

You, to your agent

Change the latest budget.

curl -X PATCH https://api.sb/tutorloop.com/budgets/budget_1 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"account":"expense.ads"}'

import { $ } from 'startup-builder'

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

npx startup-builder do Budget.update --json '{"id":"budget_1","account":"expense.ads"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Budget.update({ id: 'budget_1', account: 'expense.ads' })"
  }
}

Update changes the given properties of a Budget. It is inherited: every Noun has get, list, create, update and delete.

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.

Outputs

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

Effects

Emits Budget.updated.
Two-way: try, send, do.

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.	Budget.update

When it waits

Gate	Default
Decision class	Low: two-way, nothing at stake
Delay window	None: it runs once review passes.
Limit	The call Limit of the Permission it runs under.
Over the Limit	It waits `pending` for an Approval from the Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

Budget.list

Previous Page

Card

Next Page