Skip to main content
PATCH
Update budget

Authorizations

Authorization
string
header
required

Use your API key as a Bearer token. API keys can be generated in Settings → Integrations → API Access.

Path Parameters

id
string<uuid>
required

Budget ID

Body

application/json
title
string

Budget title

Required string length: 1 - 255
fiscalYear
integer

Fiscal year

Required range: 1900 <= x <= 2100
periodType
enum<string>

Period type

Available options:
Annual,
Quarterly,
Monthly
status
enum<string>

Editable status. Approval and archiving use their dedicated managed workflows.

Available options:
Draft,
PendingApproval
currency
enum<string>

Currency code

Available options:
USD,
EUR,
GBP,
CAD,
AUD,
JPY,
CNY,
INR,
CHF,
NZD,
SEK,
NOK,
DKK,
SGD,
HKD,
KRW,
ZAR,
BRL,
MXN,
AED
notes
string | null

Budget notes (null to clear)

Maximum string length: 10000

Response

Budget updated successfully

data
object
required