Update budget

put

https://{tenant}.onechurchsoftware.com/api/budgets/{id}

Full update: omitted fields are cleared or reset (the name falls back to its default, and the description, tag group, and default tag are cleared), except funds and accounts, which are left unchanged when omitted. First retrieve the current budget from /api/budgets/{id}, apply your changes, then send back the full object.

Required permission: Full Write Accounting

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int32

required

≥ 1

The id of the budget

Body Params

The details of the budget

startYear

int32

required

The year the budget starts in.

startMonth

object | null

required

The month the budget starts in (1-12, and the month's name). The budget always covers the twelve months from this start; on writes only the id is used.

status

object | null

required

The budget's status (budget_status_draft or budget_status_published). On writes, provide either the id or the code; the code wins when both are set.

name

string | null

The budget's name. Defaults to Budget {year} when omitted.

description

string | null

The budget's description.

tagGroup

object | null

The accounting tag group the budget tracks (id and name), when one is selected. Only the id is used on writes; omit it to clear the tag group.

defaultTag

object | null

The tag applied by default to the budget's amounts (id and name), when one is selected. Only the id is used on writes; the tag must belong to the selected tag group.

funds

array of objects | null

The funds the budget covers. On writes, provide each fund as just its id; omit the list to leave the funds unchanged.

funds

accounts

array of objects | null

The accounts the budget covers. On writes, provide each account as just its id; omit the list to leave the accounts unchanged.

accounts

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

401

Authentication is required, or the Ocs-Api-Key header is missing or invalid.

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

text/json

200OK

404Not Found