Create budget

Create a new budget covering the twelve months starting from the given month and year. Budgeted amounts are added afterwards with PATCH /api/budgets/{id}.

Required permission: Full Write Accounting

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The details of the budget

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.

string | null

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

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
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json