API

Get expense

Get one planned expense.

Returns a single planned expense by id.

GET/v1/get_expense

Query

FieldTypeRequiredDefaultDescription
budgetIdstringYes—Budget that owns the expense.
boxIdstringYes—Id of the parent expense box.
expenseIdstringYes—Planned expense id.

Response data

FieldTypeDescription
idstringId of the planned expense.
boxIdstringId of the parent expense box.
namestringHuman-readable name shown in the app.
descriptionstringFree-text description or memo.
amountnumberPlanned amount.
currencystringISO 4217 currency code.
frequencystringExpense cadence: monthly, bimonthly, quarterly, triannual, semiannual, or annual.
paymentDaynumberDay of month the expense is due (1–31), when set.
paymentAnchorMonthnumberAnchor month (1–12) for non-monthly frequencies, when set.
iconstringIcon key when set in the app.
iconColorstringCurated icon circle fill key when set.
matchingGroupstringOptional Transactions Analysis matching-group label when set.
sortOrdernumberSort position within the parent box.
isDeletedbooleanSoft-delete flag when present on the stored document.
deletedAtstringISO-8601 soft-delete timestamp when present.
createdAtstringCreation timestamp when present (API-created expenses).
updatedAtstringLast update timestamp when present.