Skip to main content
PATCH

Authorizations

X-API-Key
string
header
required

Owner-typed API key (ORGANIZATION, PERSON, VALUE_UNIT). Manage org-scoped lifecycle with /v1/public-api-keys; cross-org governance is restricted to /v1/sys/public-api-keys.

Path Parameters

id
string
required

Body

application/merge-patch+json

Merge-patch payload for budget updates. Omitted fields remain unchanged. Explicit null clears description and externalId.

periodStart
string<date> | null

Budget period start (inclusive). Omit to keep unchanged.

Example:

"2026-02-01"

periodEnd
string<date> | null

Budget period end (inclusive). Omit to keep unchanged.

Example:

"2026-11-30"

budgetAmount
number | null

Budget amount in the budget currency. Omit to keep unchanged.

Example:

280000

currencyUnitId
string | null

Id of the currency unit. Omit to keep unchanged.

Example:

"7c9e6679-7425-40de-944b-e07fc1f90ae7"

description
string | null

Budget description. Provide null to clear it.

Example:

"Q1 platform budget (revised)"

externalId
string | null

External system identifier. Provide null to clear it.

Example:

"BUDGET_Q1_2026_REV"

Response

Budget updated

id
string
targetId
string
targetType
enum<string>
Available options:
VALUEUNIT,
ORGANIZATIONALUNIT,
TEAM
periodStart
string<date>
Example:

"2022-03-10"

periodEnd
string<date>
Example:

"2022-03-10"

budgetAmount
number
currencyUnitId
string
description
string
externalId
string
spentAmount
number
remainingAmount
number
spentPercentage
number<double>
unvaluedMinutes
integer<int64>