Skip to main content
PATCH
Update 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

itemId
string<uuid>
required

Line item ID

Body

application/json
description
string

Item description

Required string length: 1 - 1000
quantity
number

Quantity

Required range: x >= 0
unitPrice
number

Unit price

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

Recurrence

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

Term in months

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

Status

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

Currency code; must match 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 | null

Item notes (null to clear)

Maximum string length: 5000
categoryId
string<uuid> | null

Category ID (null to clear)

linkedItemId
string<uuid> | null

Linked item ID. Set this or linkedItemType to null to clear the link.

linkedItemType
enum<string> | null

Linked item type. Set this or linkedItemId to null to clear the link.

Available options:
device,
planner,
goal,
other,
null

Response

Line item updated successfully

data
object
required