Skip to content

by Startups.Studio

Budget.create

POST /{namespace}/budgets

Creates a Budget.

Noun: Budget
Mode: do
Event: Budget.created

You, to your agent

Add a budget to ShiftNote with a period.

curl -X POST https://api.sb/shiftnote.app/budgets \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"account":"expense.ads","period":"period_1","amount":{"amount":79,"currency":"USD"}}'

import { $ } from 'startup-builder'

const budget = await $.Budget.create({ account: 'expense.ads', period: 'period_1', amount: { amount: 79, currency: 'USD' } })

npx startup-builder do Budget.create --json '{"account":"expense.ads","period":"period_1","amount":{"amount":79,"currency":"USD"}}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Budget.create({ account: 'expense.ads', period: 'period_1', amount: { amount: 79, currency: 'USD' } })"
  }
}

Create makes a new Budget from the inputs below. It is inherited: every Noun has get, list, create, update and delete.

Inputs

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

Outputs

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

Effects

Emits Budget.created.
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.create

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

Previous Page

Budget.delete

Next Page