Skip to main content
POST
Create Budget

Authorizations

Authorization
string
header
required

Token-based authentication with required prefix "Token"

Body

name
string
required
start_date
string<date>
required
description
string | null
cadence
string | null
end_date
string<date> | null
periods
integer
Required range: 0 <= x <= 32767
breakdown_type
enum<string>
  • standard - Standard (Account-based)
  • department_row - Department (Row)
Available options:
standard,
department_row
tag_ids
integer<int64>[]
Required range: -9223372036854776000 <= x <= 9223372036854776000
tag_group_ids
integer<int64>[]
Required range: -9223372036854776000 <= x <= 9223372036854776000
currency
string
Maximum string length: 3
entity
integer | null
department
integer | null

Response

201 - application/json
id
integer
required
read-only
entity_name
string
required
read-only
prior_start_date
string
required
read-only
prior_end_date
string
required
read-only
department_name
string
required
read-only
tags
object[]
required
read-only
is_deleted
boolean
default:false
required
read-only
deleted_at
string<date-time> | null
required
read-only
name
string
required
start_date
string<date>
required
created_at
string<date-time>
required
read-only
last_modified_at
string<date-time>
required
read-only
customer
integer
required
read-only
description
string | null
cadence
string | null
end_date
string<date> | null
periods
integer
Required range: 0 <= x <= 32767
breakdown_type
enum<string>
  • standard - Standard (Account-based)
  • department_row - Department (Row)
Available options:
standard,
department_row
tag_ids
integer<int64>[]
Required range: -9223372036854776000 <= x <= 9223372036854776000
tag_group_ids
integer<int64>[]
Required range: -9223372036854776000 <= x <= 9223372036854776000
currency
string
Maximum string length: 3
entity
integer | null
department
integer | null