personal finance

Create a savings goal

post/personal-finance/goals

Request

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

Request body

namestring required

Goal name

descriptionstring

Goal description

targetAmountnumber required

Target amount

currencystring required

Currency for this goal (only contributions in this currency count)

currentAmountnumber

Current amount saved (defaults to 0)

deadlinestring

Deadline (YYYY-MM-DD)

colorstring

Color hex code

iconstring

Icon name (Lucide icon)

isActiveboolean

Whether the goal is active

Example request

{
  "name": "New Laptop",
  "description": "Saving for a MacBook Pro",
  "targetAmount": 2500,
  "currency": "USD",
  "currentAmount": 500,
  "deadline": "2024-12-31",
  "color": "#3b82f6",
  "icon": "Laptop"
}

Response

Goal created

Changes

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