Create an Income Source

This endpoint creates an income source for the specified user.

The details that should be specified in the request body are:

• the income source (string) - the income’s description
• the payDate (date) - the date the income was paid
• the category (string) - the category of the income
• the account’s id (string) - the account that was credited
• the amount (number) - the amount made from the income source

When you’re withdrawing from an investment, you can use this endpoint by assigning the investment ID to the income source. This will ensure the amount is deducted from the investment and credited to the account.

The response body is a JSON object that includes an array of all the user’s income sources. The individual income object contains:

• the income source (string) - the income’s description
• the payDate (date) - the date the income was paid
• the category (string) - the category of the income
• the account’s id (string) - the account that was credited
• the amount (number) - the amount made from the income source
• _id (string) - the unique identifier for the income

POST /income/add

Create an Income Source

cURL

curl --request POST \
  --url https://cashboard-f5x2.onrender.com/income/add \
  --header 'Content-Type: application/json' \
  --data '
{
  "source": "Side Hustle: Selling Shoes",
  "payDate": "11/02/2024",
  "category": "side hustle",
  "account": "662fbf9eac827e370c18d4b9",
  "amount": "7000"
}
'

201

{
  "income": [
    {
      "source": "Side Hustle: Selling Shoes",
      "payDate": "2024-11-02T00:00:00.000Z",
      "account": "662fbf9eac827e370c18d4b9",
      "category": "side hustle",
      "amount": 7000,
      "_id": "662fbfcaac827e370c18d4bf"
    }
  ]
}

Query Parameters

user · string

required

Body

application/json

The body is of type object.

Response

201

application/json

Created

The response is of type object.