Budget routes: update, delete

Reference for Budget, one group of Budget routes.

Budget.update

Changes the given properties of a Budget. Verb page.

Text

PATCH /{namespace}/budgets/{id}

Path: id. Body, as JSON: the other inputs. 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

Terminal

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

JSON

{
  "api": "https://api.sb/leaseline.app",
  "budget": {
    "$id": "https://api.sb/leaseline.app/budgets/budget_qnCdsFGLVN",
    "$type": "Budget",
    "account": "expense.ads",
    "period": "period_VEVuYACTsH",
    "amount": {
      "amount": 29,
      "currency": "USD"
    }
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Budget.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Budget.delete

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