Skip to main content
POST
Create budget

Authorizations

Authorization
string
header
required

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

Body

application/json
title
string
required

Budget title (required)

Required string length: 1 - 255
companyId
string<uuid>
required

Company ID (required)

fiscalYear
integer
required

Fiscal year (required)

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

Period type (default: Annual)

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

Initial status (Draft by default; approval is a later lock transition)

Available options:
Draft,
PendingApproval
currency
enum<string>

Currency code (default: USD)

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

Budget notes

Maximum string length: 10000

Response

Budget created successfully

data
object
required