Playground

Playground

BudgetLine

/api/v1/finance/budget-lines

A line item under a Budget.

listgetcreateupdate

Schema

FieldTypeNotes
id*uuidServer-assigned ULID with type prefix (e.g. per_…).
tenant_id*stringTenant scope — auto-stamped from the caller's JWT.
app_idstringApp scope. Stamped ONLY when the caller's JWT was minted for a specific Application (integration API keys). Absent for human-user sessions. Filters reads when present.
created_at*date-timeServer stamp.
updated_at*date-timeServer stamp; updated on every patch.
created_byuuidPerson id from the caller's JWT (sub).
updated_byuuidPerson id from the last writer's JWT (sub).
sourcestringProvenance tag — defaults to 'edm'.
source_typeenumfrontend | backend | server | system | apiWhere the write originated. Defaults to 'api'.
is_deletedbooleanSoft-delete flag. Excluded from default list queries.
deleted_atdate-timeStamped when soft-deleted; null otherwise.
deleted_byuuidPerson id who soft-deleted; null otherwise.
schema_versionnumberDocument schema version. Bumped on incompatible writes.
budget_iduuidUUID of the parent Budget.
categorystringCategory label for this budget line (e.g. 'Software Licenses', 'Travel').
allocated_amountnumberAmount allocated to this budget line category.
spent_amountnumberComputed total actuals charged against this line. Read-only — maintained by the platform.
remaining_amountnumberComputed remaining balance (allocatedAmount - spentAmount). Read-only — maintained by the platform.
notesstringFree-form notes about this budget line.
descriptionstringWhat this budget line covers.
amountnumberBudgeted amount for this line.
currencystringISO 4217 three-character currency code.
spentnumberAmount spent to date.
cost_center_iduuidUUID of the CostCenter this budget line belongs to.
tagsjsonFree-form tags for grouping and filtering.

API

client.finance.budgetLines.*
Loading manifest…