Budget programs: create, get, list

Reference for Budget, one group of Budget programs.

Budget.create

Creates a Budget. Verb page.

Text

do: return await $.Budget.create(input)

Emits Budget.created.

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.

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

JSON

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

Budget.get

Returns one Budget by id. Verb page.

Text

do: return await $.Budget.get(input)

Reads only: it emits no Event.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Budget.
`at`	`string`		A time or Version name: the record as it stood then. Unset: as it stands now.

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

JSON

{
  "name": "do",
  "arguments": {
    "code": "return await $.Budget.get({ id: 'budget_qnCdsFGLVN' })"
  }
}

Budget.list

Returns Budgets, newest first, one page at a time. Verb page.

Text

do: return await $.Budget.list(input)

Reads only: it emits no Event.

Inputs

Input	Type	Description
`limit`	`integer`	At most this many records, up to 100. The default is 20.
`after`	`string`	The cursor from the previous page.
`where`	`string`	A filter over the properties, such as `paidAt = null and total.amount > 500`.
`sort`	`string`	Properties to sort by, comma-separated; a leading minus sorts descending.
`total`	`boolean`	True adds the match count as `meta.total`, exact up to 10,000 matches and estimated above.
`facets`	`string`	Properties to count by value, comma-separated, returned as `meta.facets`.
`fields`	`string`	Properties to return on each record, comma-separated; `$id` and `$type` always return.
`include`	`string`	Related records to embed in place of their URLs, comma-separated.
`depth`	`integer`	How many levels of related records to embed. The default is 1.
`q`	`string`	Words to match across the text properties, ranked by relevance.
`match`	`string`	Ranks the search by `words`, or `meaning`; words is the default.

Returns

Output	Type	Required	Description
`budgets`	list of Budget	required	One page of Budgets.

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

JSON

{
  "name": "do",
  "arguments": {
    "code": "return await $.Budget.list({ limit: 20 })"
  }
}

Budget.createCopy Anchor Link

Budget.getCopy Anchor Link

Budget.listCopy Anchor Link

Budget.create

Budget.get

Budget.list