Playground

Playground

Expense

/api/v1/finance/expenses

An expense claim.

listgetcreateupdateapprove

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.
submitted_by_iduuidUUID of the Person who submitted this expense.
approved_by_iduuidUUID of the Person who approved or rejected this expense. Null until actioned.
categorystringExpense category for grouping and policy enforcement.
descriptionstringHuman-readable description of what was purchased and why.
amountnumberExpense amount in the stated currency.
currencystringISO 4217 three-character currency code.
expense_datedate-timeISO 8601 date the expense was incurred.
statusstringLifecycle status of the expense claim.
receipt_refstringMinIO path or external URL of the receipt image or PDF.
project_iduuidUUID of the Project this expense is charged against.
cost_center_iduuidUUID of the CostCenter this expense is charged against.
notesstringAdditional notes from the submitter or approver.
person_iduuidThe person who incurred the expense.
datedate-timeISO 8601 date of the expense.
merchantstringMerchant or vendor the expense was paid to.
receipt_urlstringExternal URL of the receipt image or PDF.
approved_byuuidPerson who approved this expense.
tagsjsonFree-form tags for grouping and filtering.

API

client.finance.expenses.*
Loading manifest…