personal finance

Create a budget

post/personal-finance/budgets

Request

  • Base URL: http://localhost:3001
  • URL: http://localhost:3001/personal-finance/budgets
  • Auth: bearer (a scheme the document does not define)

Request body

categoryIdstring

Category ID (null for overall budget)

amountnumber required

Budget amount

currencystring required

Currency for this budget (only transactions in this currency count)

alertThresholdnumber

Alert threshold percentage (1-100)

period'monthly' | 'weekly' | 'yearly'

Budget period

startDatestring

Start date (YYYY-MM-DD)

endDatestring

End date (YYYY-MM-DD) - optional

isActiveboolean

Whether the budget is active

Example request

{
  "categoryId": "550e8400-e29b-41d4-a716-446655440000",
  "amount": 500,
  "currency": "USD",
  "alertThreshold": 80,
  "startDate": "2024-03-01",
  "endDate": "2024-12-31"
}

Response

Budget created

Changes

No recorded changes to this operation across all 1 revision of this API.