personal finance

Create a personal transaction

post/personal-finance/transactions

Request

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

Request body

type'expense' | 'income' | 'saving' required

Type of transaction

descriptionstring required

Transaction description

amountnumber required

Amount in the transaction currency

currencystring required

Currency code (ISO 4217)

transactionDatestring required

Transaction date (YYYY-MM-DD)

categoryIdstring

Category ID

payeestring

Payee name

notesstring

Additional notes

savingsGoalIdstring

Savings goal ID (required for type=saving)

Example request

{
  "description": "Grocery shopping at Walmart",
  "amount": 100.5,
  "currency": "USD",
  "transactionDate": "2024-03-15",
  "categoryId": "550e8400-e29b-41d4-a716-446655440000",
  "payee": "Walmart",
  "notes": "Weekly grocery run",
  "savingsGoalId": "550e8400-e29b-41d4-a716-446655440000"
}

Response

Transaction created

idstring required
userIdstring required
categoryIdstring nullable required
type'expense' | 'income' | 'saving' required
descriptionstring required
amountnumber required
currencystring required
transactionDatestring date-time required
payeestring nullable required
notesstring nullable required
isFromGroupSyncboolean required
groupTransactionIdstring nullable required
savingsGoalIdstring nullable required
receiptUrlstring nullable required
deletedAtstring date-time nullable required
createdAtstring date-time required
updatedAtstring date-time required

Changes

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