Skip to main content
POST
Create budget line item

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
description
string
required

Item description (required)

Required string length: 1 - 1000
unitPrice
number
required

Unit price (required)

Required range: x >= 0
quantity
number

Quantity (default: 1)

Required range: x >= 0
recurrence
enum<string>

Recurrence (default: One-Time)

Available options:
One-Time,
Monthly,
Annual
termMonths
integer

Term in months (default: 1)

Required range: 1 <= x <= 120
status
enum<string>

Status (default: draft)

Available options:
pending,
approved,
rejected,
draft
currency
enum<string>

Currency code (defaults to the parent budget currency)

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

Item notes

Maximum string length: 5000
categoryId
string<uuid>

Category ID (from planner_item_types)

linkedItemId
string<uuid>

Linked item ID. Must be provided together with linkedItemType.

linkedItemType
enum<string>

Linked item type. Must be provided together with linkedItemId.

Available options:
device,
planner,
goal,
other

Response

Line item created successfully

data
object
required