Skip to content

Latest commit

 

History

History
881 lines (656 loc) · 34.3 KB

README.md

File metadata and controls

881 lines (656 loc) · 34.3 KB

Mint User Guide v2.1

Introduction

Mint is an all-in-one money managing app that helps you track your daily expenses, set budgets and long term financial goals(coming soon). It is optimized for use via a Command Line Interface (CLI).

At Mint, we are all about enhancing your user experience. Mint allows you to efficiently key in entries with intuitive commands. You will also have access to tools such as budget warning and a variety of view options to help you better track your finances.

As our team comprises university students, we hope that we can help fellow young adults in keeping track of their finances. We want to help you get started in your journey to financial freedom.

The purpose of this guide is to help you to navigate the app and use all of its functionalities through step-by-step-instructions.

  • If you are a new user, click here to get started!

  • If you want to find out more about our features, click here!

  • If you are unsure of where to start, you can refer to our table of contents.

Table of Contents

Quick Start

Before you get started, ensure that you have Java 11 or above installed in your Computer. Once that is done, follow the steps below!

Setting Up

  1. Download the latest version of tp.jar from here.

  2. Copy the tp.jar file to the folder you desire.

Running the Programme

  1. Open your desired Command Line Interface and ensure that you are in the directory where you saved the folder. If you are new to the Command Line Interface, click here to see how you can change the directory.
  2. Once you ensured you are in the correct directory, run the programme using the command java -jar tp.jar.
  3. To test if the programme is working, type a command and press Enter to execute it. e.g., typing help and pressing Enter will display the list of commands to help you use our application.

Some example commands you can try:

  1. Add an expense to your list: add a/13 d/2021-12-03 n/Movie ticket c/1

    This command adds a Movie ticket that you have purchased for 13 dollars on December 3rd 2021 under the Entertainment category

  2. Exit the programme: exit

    This command terminates the program.

Refer to the Features Section below for details of each comm

[For users new to CLI] Changing the Directory to your tp.jar file

  1. Right-click on your tp.jar file and select Properties. There would be a pop up with all the information.
  2. Look for the Location and copy the entire string.
  3. Go back to your Command Line Interface and enter the command cd [paste what you copied here]
  4. Now you are in the directory of your tp.jar file.

Prerequisites before using Mint

Acceptable tag formats

Tag Description Format Example of input
n/NAME Name of the entry Any string of characters n/Hai di lao, n/123
a/AMOUNT Amount in dollars. Numbers after decimal points are in cents. Positive number smaller than 1 million. It will be automatically rounded to 2 decimal points if higher precision is given. a/12.50
d/DATE Date or start date Any of the acceptable date formats from 2000-01-01 to 2200-12-31. If the date is not specified, the default date set will be today. d/2016-02-13, d/2016-2-13 would be the date of entry added.
c/CATEGORY_NUMBER Category number Please refer to the available categories. If the CATEGORY_NUMBER is not specified, the default CATEGORY_NUMBER would be c/7 which is Others. c/1
i/INTERVAL How often one receives or pay for entries String of either MONTH or YEAR. The string is not case-sensitive. i/mOnTH, i/year, i/YEAR
e/END_DATE End date of the recurring period. One will not receive or pay for the recurring entry from this date. Any of the acceptable date formats from 2000-01-01 to 2200-12-31 that is after the d/DATE. If the end date is not specified, the default date set would be forever (2200-12-31) e/2016-02-13, e/2016-2-13

Acceptable date formats

Example: 5th Jaunary 2020

Format Example of input
yyyy-MM-dd 2020-01-05
yyyy-M-dd 2020-1-05
yyyy-MM-d 2020-01-5
yyyy-M-d 2020-1-5
dd-MM-yyyy 05-01-2020
d-MM-yyyy 5-01-2020
d-M-yyyy 5-1-2020
dd-M-yyyy 05-1-2020
dd MMM yyyy (for MMM, capitalise only the first letter, e.g. Jan) 05 Jan 2020
d MMM yyyy (for MMM, capitalise only the first letter, e.g. Jan) 5 Jan 2020

Note:

  • day must be between '1' to '31'.
  • if user give a day that is not supposed to exist, day will be rounded down.
    • e.g. 2021-09-31 will be received as 2021-09-30 , as September only has 30 days.

Available categories

Category tag Expense Category Income Category
c/0 Food Allowance
c/1 Entertainment Wages
c/2 Transportation Salary
c/3 Household Interest
c/4 Apparel Investment
c/5 Beauty Commission
c/6 Gift Gift
c/7 Others Others

Features

Notes about commands

  • Items in square brackets are optional.

    e.g n/NAME [d/DATE] can be used as n/burger d/2021-10-20 or as n/burger

  • Parameters with tags or optional modifiers can be in any order.

    e.g. if the command specifies n/NAME a/AMOUNT, the order a/AMOUNT n/NAME is also acceptable.

  • Extraneous parameters for commands that do not take in parameters (such as help, budget and exit) will be ignored.

    e.g. if the command specifies help 123, it will be interpreted as help.

  • Extraneous parameters in between the command and the first tag for commands that take in tag parameters will not be considered if it is not valid.

    e.g. if the command specifies add oh yummy food income n/wage, it will be interpreted as add income n/wage.

    e.g. if the command specifies delete hmm income a/15.0 c/1, it will be interpreted as delete a/15.0 c/1, as delete is used for both expense and income.


Notes about recurring entries

  • Recurring entries will be recurred on the same day as the DATE if the interval is MONTH; same day and month if the interval is YEAR
  • If theEND_DATE of the recurring entry is before the next recurring date, it will not be recurred on that next recurring date.
  • If the day is not available on some months or years, it will automatically be rounded down.

Examples:

  • Netflix monthly subscription starts on 2021-09-21 and ends on 2030-03-20.

    • DATE is 2021-03-21; INTERVAL is MONTH; END_DATE is 2030-03-20.
    • It will be billed on 2021-09-21, 2021-10-21, and so on until 2030-02-21.
  • Nintendo yearly subscription starts on 2020-02-29 and ends on 2023-01-15.

    • DATE is 2020-02-29;INTERVAL is YEAR; END_DATE is 2023-01-15.
    • It will be billed on 2020-02-29, 2021-02-28, and 2022-02-28 only.
    • As February 29th is not available on non-Leap years, the date was rounded down to February 28th for those years.
    • As 2023-01-15 is before the next recurring date of 2023-02-28, it will not be recurred on 2023-02-28.
  • The school starts to give monthly allowance on 2021-08-31 until 2023-08-31.

    • DATE is 2021-08-31; INTERVAL is MONTH; END_DATE is 2023-08-31.
    • It will be received on 2021-08-31, 2021-09-30, and so on until 2023-08-31.
    • As 31st is not available on September, the day was rounded down to 30th.

Viewing help: help

Shows a list of possible user commands

Format: help

Adding entries: add

Adds an expense or income to your tracker

Format: add [income] n/NAME a/AMOUNT [d/DATE] [c/CATEGORY_NUMBER]

  • Adds an entry of the specified NAME, DATE, AMOUNT and CATEGORY_NUMBER
  • If income is included after add, entry will be an income entry, else it will be an expense entry.
  • Refer to acceptable tag formats for more information about tag definitions and formats.

Examples and Expected Output:

  • Adding a textbook that costs $15: add n/textbook a/15
add n/Textbook a/15
I've added: Expense  | OTHERS | 2021-10-28 | Textbook | $15.00
  • Adding a cheeseburger that costs $4.20 that you had on 20th April 2021 and categorize it under " Food": add n/Cheese Burger a/4.2 d/2021-04-20 c/0
add n/Cheese burger a/4.2 d/2021-04-20 c/0
I've added: Expense  | FOOD | 2021-04-20 | Cheese burger | $4.20
  • Adding the income you made from sales, amounting to $34 add income n/Sales a/34 d/2021-02-19 c/1
add income n/Sales a/34 d/2021-02-19 c/1
I've added: Income  | WAGES | 2021-02-19 | Sales | $34.00

Adding Recurring Entries: addR

Adds an expense or income to your tracker

Format: addR [income] n/NAME a/AMOUNT i/INTERVAL [d/DATE] [c/CATEGORY_NUMBER] [e/END_DATE]

  • Adds an entry of the specified NAME, DATE, AMOUNT, INTERVAL, END_DATE and CATEGORY_NUMBER
  • If income is included after add, entry will be an income entry, else it will be an expense entry.
  • Refer to acceptable tag formats for more information about tag definitions and formats.

Examples and Expected Output:

  • Add your phone bills that recurs every month for $90 under the "HOUSEHOLD" category:addR a/90 d/2021-12-03 n/phone bills c/3 i/MONTH
addR a/90 d/2021-12-03 n/phone bills c/3 i/MONTH
I've added: Expense | HOUSEHOLD | 2021-12-03 | phone bills |-$90.00 | MONTH | Forever :D
  • Add your phone bills that recurs every year until 25 October 2023, for $5 under the "HOUSEHOLD" category:addR a/5 n/phone bills c/3 i/year e/2023-10-26
addR a/5 n/phone bills c/4 i/year e/2023-10-26
I've added: Expense | HOUSEHOLD | 2021-10-29 | phone bills |-$5.00 | YEAR | 2023-10-26
  • Add your salary as an income, that recurs every month, at $10,000 under the "OTHERS" category:addR income a/10000 n/salary d/2021-10-10 i/mOnTh
addR income a/10000 n/salary d/2021-10-10 i/mOnTh
I've added: Income  | OTHERS | 2021-10-10 | salary | $10,000.00 | MONTH | Forever :D

Viewing entries: view

Shows a list of all the entries, each with the associated NAME, CATEGORY_NUMBER, DATE, and AMOUNT (INTERVAL and END_DATE also for recurring entries.)

Format: view [income] [expense] [by SORTTYPE] [month MONTH] [year YEAR] [from STARTDATE [ENDDATE]] [up/ascending]

  • Summary of modifiers for view function
Modifier Effect Remarks
by date Sorts the list by date in descending order. The default sorting order
by amount Sorts the list by amount in descending order.
by name Sorts the list by name in descending order.
by cat Sorts the list by category in descending order.
income Filters for income entries only
expense Filters for expense entries only
from [STARTDATE] Filters for entries that are on or after the STARTDATE. STARTDATE and ENDDATE can be any of the acceptable date formats.
from [STARTDATE] [ENDDATE] Filters for entires entries that are between STARTDATE and ENDDATE, inclusive.
month [MONTH] Filters for entries of the specified MONTH in a year. MONTH should be the numerical month value from 1 to 12. If the year modifier was not used, it will default to the current year. If MONTH was not specified, it will default to the current month.
year [YEAR] Filters for entries of the specified YEAR. YEAR should be the numerical year value from 2000 to 2200. If YEAR was not specified, it will default to the current year.
up/ascending Sorts the list in ascending order instead of descending order.

Examples and Expected Output:

  • View all your entries: view
view
Here is the list of your entries:
  Type  |    Category    |    Date    |        Name         | Amount  | Every |   Until
Income  |      GIFT      | 2021-12-25 | Christmas allowance | $200.00 |       |
Expense | TRANSPORTATION | 2021-11-04 |        Taxi         |-$6.99   |       |
Income  |   ALLOWANCE    | 2021-10-31 |      Allowance      | $1.00   | MONTH | 2023-08-31
Expense | ENTERTAINMENT  | 2021-10-04 |        Movie        |-$22.44  |       |
Income  |   ALLOWANCE    | 2021-09-30 |      Allowance      | $1.00   | MONTH | 2023-08-31
Income  |   ALLOWANCE    | 2021-08-31 |      Allowance      | $1.00   | MONTH | 2023-08-31
Expense |      FOOD      | 2021-04-20 |    Cheese burger    |-$15.00  |       |
                                                 Net Total: | $158.57
Here is the list of all recurring entries, where some were added to the above list:
Expense |     OTHERS     | 2022-01-01 |      New year       |-$100.00 | YEAR  | Forever :D
Income  |   ALLOWANCE    | 2021-08-31 |      Allowance      | $1.00   | MONTH | 2023-08-31
  • View all your income entries: view income
view income
Here is the list of your entries:
  Type  | Category  |    Date    |        Name         | Amount  | Every |   Until
Income  |   GIFT    | 2021-12-25 | Christmas allowance | $200.00 |       |
Income  | ALLOWANCE | 2021-10-31 |      Allowance      | $1.00   | MONTH | 2023-08-31
Income  | ALLOWANCE | 2021-09-30 |      Allowance      | $1.00   | MONTH | 2023-08-31
Income  | ALLOWANCE | 2021-08-31 |      Allowance      | $1.00   | MONTH | 2023-08-31
                                            Net Total: | $203.00
Here is the list of applicable recurring entries, where some were added to the above list:
Income  | ALLOWANCE | 2021-08-31 |      Allowance      | $1.00   | MONTH | 2023-08-31
  • View all entries in April 2021: view month 4 year 2021
view month 4 year 2021
For the year 2021:
For the month of APRIL:
Here is the list of your entries:
  Type  | Category |    Date    |     Name      | Amount | Every |   Until
Expense |   FOOD   | 2021-04-20 | Cheese burger |-$15.00 |       |
                                     Net Total: |-$15.00
Here is the list of recurring entries added to the above list:
  • View all entries from 13th January 2022 to 15th March 2022, sorted by amount in ascending order: view from 2022-01-13 2022-03-15 by amount ascending
view from 2022-01-13 2022-03-15 by amount ascending
Here is the list of your entries:
Since 2022-01-13 to 2022-03-15:
  Type  |   Category    |    Date    |   Name    | Amount | Every |   Until
Income  |   ALLOWANCE   | 2022-01-31 | Allowance | $1.00  | MONTH | 2023-08-31
Income  |   ALLOWANCE   | 2022-02-28 | Allowance | $1.00  | MONTH | 2023-08-31
Expense |    OTHERS     | 2022-02-28 | Nintendo  |-$19.99 | YEAR  | 2023-01-15
                                      Net Total: |-$17.99
Here is the list of recurring entries added to the above list:
Income  |   ALLOWANCE   | 2021-08-31 | Allowance | $1.00  | MONTH | 2023-08-31
Expense |    OTHERS     | 2020-02-29 | Nintendo  |-$19.99 | YEAR  | 2023-01-15
  • Assume today's date is 2021-11-06

Deleting an entry: delete

Deletes an existing entry.

Format: delete [n/NAME] [d/DATE] [a/AMOUNT] [c/CATEGORY_NUMBER]

  • At least one of the optional fields must be provided.
  • Our program searches the entry that matches the fields provided by the user.
    • If there is more than 1 Expense or Income matching the query, the program will return a list for the user to choose from. The user would then have to confirm the deletion of the entry.
    • If there is 1 Expense or Income matching the query, the program will prompt the user to confirm the deletion of that Expense or Income .
  • Deletes an entry of the specified NAME, DATE, AMOUNT, or CATEGORY_NUMBER
  • Refer to acceptable tag formats for more information about tag definitions and formats.
  • Dummy strings between delete and the first tag will not affect the program.

Examples and Expected Outputs:

  • Deleting a textbook that you bought on 21st September 2012 that costs $15: delete n/Textbook d/2012-09-21 a/15.
  • Your query matches 1 Expense or Income in the list.
delete n/Textbook d/2012-09-21
Is this what you want to delete?
    Expense  | OTHERS | 2012-09-21 | Textbook | $40.00
Type "y" if yes. Type "n" if not.

  • The entry shown is what you want to delete: y.
delete n/Textbook d/2012-09-21
Is this what you want to delete?
    Expense  | OTHERS | 2012-09-21 | Textbook | $40.00
Type "y" if yes. Type "n" if not.
y
I have deleted: Expense  | OTHERS | 2012-09-21 | Textbook | $40.00

  • Deleting a cheeseburger that you ate on 20th April 2020 that costs $4.2: delete n/Cheese Burger d/2020-04-20 a/4.2.

  • Your query matches more than 1 Expense or Income in the list.

delete n/Cheese Burger d/2020-04-20 a/4.2
Here is the list of items containing the keyword.
 Index |   Type  | Category |    Date    |     Name      | Amount | Every |   Until
   1   | Income  |  OTHERS  | 2020-04-20 | Cheese Burger |-$4.20  
   2   | Expense |  OTHERS  | 2020-04-20 | Cheese Burger |-$4.20  
Enter the index of the item you want to delete. To cancel, type "cancel"
  • The first entry shown is what you want to delete. Index is 1: 1.
delete n/Cheese Burger d/2020-04-20 a/4.2
Here is the list of items containing the keyword.
 Index |   Type  | Category |    Date    |     Name      | Amount | Every |   Until
   1   | Income  |  OTHERS  | 2020-04-20 | Cheese Burger |-$4.20  
   2   | Expense |  OTHERS  | 2020-04-20 | Cheese Burger |-$4.20  
Enter the index of the item you want to delete. To cancel, type "cancel"
1
I have deleted: Income  | OTHERS | 2020-04-20 | Cheese Burger | $4.20

Deleting a recurring entry: deleteR

Deletes an existing recurring entry.

Format: deleteR [n/NAME] [d/DATE] [a/AMOUNT] [c/CATEGORY_NUMBER] [i/INTERVAL] [e/END_DATE]

  • At least one of the optional fields must be provided.
  • Our program searches the entry that matches the fields provided by the user.
    • If there is more than 1 RecurringExpense or RecurringIncome matching the query,the program will return a list for the user to choose from. The user would then have to confirm the deletion of the entry.
    • If there is 1 RecurringExpense or RecurringIncome matching the query, the program will prompt the user to confirm the deletion of that RecurringExpense or RecurringIncome .
  • Deletes an entry of the specified NAME, DATE, AMOUNT, or CATEGORY_NUMBER
  • Refer to acceptable tag formats for more information about tag definitions and formats.

Examples:

  • deleteR n/Netflix
  • deleteR i/mOnTh

Examples and Expected Output:

  • Deleting a Netflix subscription: deleteR n/Netflix.
  • Your query matches 1 RecurringExpense or RecurringIncome in the list.
deleteR n/Netflix
Is this what you want to delete?
    Expense | OTHERS | 2021-10-28 | Netflix |-$90.00 | YEAR | Forever :D
Type "y" if yes. Type "n" if not.
  • The entry shown is what you want to delete: y.
deleteR n/Netflix
Is this what you want to delete?
    Expense | OTHERS | 2021-10-28 | Netflix |-$90.00 | YEAR | Forever :D
Type "y" if yes. Type "n" if not.
y
I have deleted: Expense | OTHERS | 2021-10-28 | Netflix |-$90.00 | YEAR | Forever :D

  • Deleting a monthly recurring entry: deleteR i/mOnTh.

  • Your query matches more than 1 RecurringExpense or RecurringIncome in the list.

deleteR i/mOnTh
Here is the list of items containing the keyword.
 Index |   Type  | Category |    Date    |  Name   | Amount | Every |   Until
   1   | Expense |  OTHERS  | 2021-10-28 | Netflix |-$40.00 | MONTH | Forever :D
   2   | Expense |  OTHERS  | 2021-10-28 |   Viu   |-$30.00 | MONTH | Forever :D
Enter the index of the item you want to delete. To cancel, type "cancel"
  • The first recurring entry shown is what you want to delete. Index is 1: 1.
deleteR i/mOnTh
Here is the list of items containing the keyword.
 Index |   Type  | Category |    Date    |  Name   | Amount | Every |   Until
   1   | Expense |  OTHERS  | 2021-10-28 | Netflix |-$40.00 | MONTH | Forever :D
   2   | Expense |  OTHERS  | 2021-10-28 |   Viu   |-$30.00 | MONTH | Forever :D
Enter the index of the item you want to delete. To cancel, type "cancel"
1
I have deleted: Expense | OTHERS | 2021-10-28 | Netflix |-$40.00 | MONTH | Forever :D

Deleting all entries: deleteAll

Deletes all existing entries.

Format: deleteAll [normal] [recurring]

  • Deletes all normal and recurring entries in the list.
  • [normal](optional) and [recurring](optional) if appended, only deletes all entries of the corresponding type.
  • If no modifiers are specified, it defaults to deleting all entries regardless of type.
  • normal and recurring can be substituted for n and r respectively as a shortcut.
  • deleteall also accepted as a command.

Examples and Expected Output:

  • Deleting all entries: deleteAll
deleteAll
Are you sure you want to delete all entries?
Type "y" if yes. Type "n" if not.
y
All entries successfully deleted.
  • Deleting all normal entries only: deleteall normal
deleteall normal
Are you sure you want to delete all entries?
Type "y" if yes. Type "n" if not.
y
All entries successfully deleted.

Editing an entry: edit

Edits an existing entry

Format: edit [n/NAME] [a/AMOUNT] [d/DATE] [c/CATEGORY_NUMBER]

  • At least one of the optional fields must be provided
  • When editing fields, existing fields of the Expense or Income indicated by the user will be replaced.
  • Our program searches the entry that matches the fields provided by the user.
    • If there is 1 Expense or Income matching the query, the program will prompt the user to confirm if they wish to edit that entry.
    • If there is more than 1 Expense or Income matching the query, the program will return a list for the user to choose from. The user would then have to confirm if they wish to edit the entry.
  • Refer to acceptable tag formats for more information about tag definitions and formats.

Examples and Expected Output:

  • Edit an entry with description of 'Textbook' recorded on 21 September 2012 for $15: edit n/Textbook d/2012-09-21 a/15.
  • Your query matches 1 Expense or Income in the list.
edit n/Textbook d/2012-09-21 a/15
Is this what you want to edit?
Expense  | OTHERS | 2012-09-21 | Textbook | $15.00
Type "y" if yes. Type "n" if not.
  • The entry shown is what you want to edit: y.
edit n/Textbook d/2012-09-21 a/15
Is this what you want to edit?
    Expense  | OTHERS | 2012-09-21 | Textbook | $15.00
Type "y" if yes. Type "n" if not.
y
  • The field you wish to edit is the amount such that it is $14 instead of $15: a/14.
edit n/Textbook d/2012-09-21 a/15
Is this what you want to edit?
    Expense  | OTHERS | 2012-09-21 | Textbook | $15.00
Type "y" if yes. Type "n" if not.
y
What would you like to edit?
a/14
Got it! I will update the fields accordingly!

  • Edit an entry with description of 'Cheese Burger' recorded on 20 April 2020 for $4.20:edit n/Cheese Burger d/2020-04-20 a/4.2.
  • Your query matches more than 1 Expense or Income in the list.
edit n/Cheese Burger d/2020-04-20 a/4.2
Here is the list of items containing the keyword.
 Index |   Type  | Category |    Date    |     Name      | Amount | Every |   Until
   1   | Expense |  OTHERS  | 2020-04-20 | Cheese Burger |-$4.20  
   2   | Expense |  OTHERS  | 2020-04-20 | Cheese Burger |-$4.20  
Enter the index of the item you want to edit. To cancel, type "cancel"
  • The first entry shown is what you want to edit. Index is 1: 1.
edit n/Cheese Burger d/2020-04-20 a/4.2
Here is the list of items containing the keyword.
 Index |   Type  | Category |    Date    |     Name      | Amount | Every |   Until
   1   | Expense |  OTHERS  | 2020-04-20 | Cheese Burger |-$4.20  
   2   | Expense |  OTHERS  | 2020-04-20 | Cheese Burger |-$4.20  
Enter the index of the item you want to edit. To cancel, type "cancel"
1
  • The field you wish to edit is the category such that it becomes 'FOOD' instead of 'OTHERS': c/0.
edit n/Cheese Burger d/2020-04-20 a/4.2
Here is the list of items containing the keyword.
 Index |   Type  | Category |    Date    |     Name      | Amount | Every |   Until
   1   | Expense |  OTHERS  | 2020-04-20 | Cheese Burger |-$4.20  
   2   | Expense |  OTHERS  | 2020-04-20 | Cheese Burger |-$4.20  
Enter the index of the item you want to edit. To cancel, type "cancel"
1
What would you like to edit?
c/0
Got it! I will update the fields accordingly!

Editing a recurring entry: editR

Edits an existing recurring entry

Format: editR [n/NAME] [d/DATE] [a/AMOUNT] [c/CATEGORY_NUMBER] [i/INTERVAL] [e/END_DATE]

  • At least one of the optional fields must be provided.
  • When editing fields, existing fields of the Expense or Income indicated by the user will be replaced.
  • Our program searches the entry that matches the fields provided by the user.
    • If there is 1 Expense or Income matching the query, the program will prompt the user to confirm if they wish to edit that entry.
    • If there is more than 1 Expense or Income matching the query, the program will return a list for the user to choose from. The user would then have to confirm if they wish to edit the entry.
  • Refer to acceptable tag formats for more information about tag definitions and formats.

Examples and Expected Output:

  • Edit a recurring entry with description of "Textbook" recorded on 21 September 2012 at $15: editR n/Textbook d/2012-09-21 a/15.
  • Your query matches 1 RecurringExpense or RecurringIncome in the list.
editR n/Textbook d/2012-09-21 a/15
Is this what you want to edit?
Expense | OTHERS | 2012-09-21 | Textbook |-$15.00 | MONTH | Forever :D
Type "y" if yes. Type "n" if not.
  • The entry shown is what you want to edit: y.
editR n/Textbook d/2012-09-21 a/15
Is this what you want to edit?
Expense | OTHERS | 2012-09-21 | Textbook |-$15.00 | MONTH | Forever :D
Type "y" if yes. Type "n" if not.
y
  • The field you wish to edit is the description such that it becomes 'NETFLIX' instead of 'Textbook': n/NETFLIX.
editR n/Textbook d/2012-09-21 a/15
Is this what you want to edit?
Expense | OTHERS | 2012-09-21 | Textbook |-$15.00 | MONTH | Forever :D
Type "y" if yes. Type "n" if not.
y
What would you like to edit?
n/NETFLIX
Got it! I will update the fields accordingly!

  • Edit a recurring entry with description of "Cheese Burger" recorded on 20 April 2020 at $4.20: editR n/Textbook d/2012-09-21 a/15.
  • If user query matches more than 1 Expense or Income in the list.
editR n/Textbook d/2012-09-21 a/15
Here is the list of items containing the keyword.
 Index |   Type  | Category |    Date    |   Name   | Amount | Every |   Until
   1   | Expense |  OTHERS  | 2012-09-21 | Textbook |-$15.00 | MONTH | Forever :D
   2   | Expense |  OTHERS  | 2012-09-21 | Textbook |-$15.00 | MONTH | Forever :D
Enter the index of the item you want to edit. To cancel, type "cancel"
  • The first entry shown is what you want to edit. Index is 1: 1.
editR n/Textbook d/2012-09-21 a/15
Here is the list of items containing the keyword.
 Index |   Type  | Category |    Date    |   Name   | Amount | Every |   Until
   1   | Expense |  OTHERS  | 2012-09-21 | Textbook |-$15.00 | MONTH | Forever :D
   2   | Expense |  OTHERS  | 2012-09-21 | Textbook |-$15.00 | MONTH | Forever :D
Enter the index of the item you want to edit. To cancel, type "cancel"
1
  • The field you wish to edit is the amount such that it is $5 instead of $15: a/5.
editR n/Textbook d/2012-09-21 a/15
Here is the list of items containing the keyword.
 Index |   Type  | Category |    Date    |   Name   | Amount | Every |   Until
   1   | Expense |  OTHERS  | 2012-09-21 | Textbook |-$15.00 | MONTH | Forever :D
   2   | Expense |  OTHERS  | 2012-09-21 | Textbook |-$15.00 | MONTH | Forever :D
Enter the index of the item you want to edit. To cancel, type "cancel"
1
What would you like to edit?
a/5
Got it! I will update the fields accordingly!

View available categories: cat

Shows a list of all available categories and its corresponding tag number.

Format: cat

Expected Output:

Here are the categories and its tag number
Expenses           | Income
c/0 FOOD           | c/0 ALLOWANCE
c/1 ENTERTAINMENT  | c/1 WAGES
c/2 TRANSPORTATION | c/2 SALARY
c/3 HOUSEHOLD      | c/3 INTERESTED
c/4 APPAREL        | c/4 INVESTMENT
c/5 BEAUTY         | c/5 COMMISSION
c/6 GIFT           | c/6 GIFT
c/7 OTHERS         | c/7 OTHERS

Setting budget: set

Set budget for individual categories.

Format: set c/CATEGORY_NUMBER a/AMOUNT.

  • set takes in 2 mandatory fields, c/CATEGORY_NUMBER and a/AMOUNT.
  • AMOUNT is in dollars. Numbers after the decimal point are in cents. Eg. 4.50 is $4.50.
  • CATEGORY_NUMBER can be any integer from 0 to 7. Please refer to the available categories.

Example and Expected Output:

  • Set budget for "FOOD" to $100: set c/0 a/100
  • c/0 is the category number for "FOOD"
set c/0 a/100
Budget for FOOD set to $100.00
  • Set budget for "ENTERTAINMENT" to $300: set c/1 a/300
  • c/1 is the category number for "ENTERTAINMENT"
set c/1 a/300
Budget for ENTERTAINMENT set to $300.00

View monthly budget: budget

View your monthly spending and budget for the current month.

Format: budget

  • Your monthly budget breakdown will be shown on the screen.
  • It shows the categories as well as its corresponding amount spent(on the left) and budget set(on the right).
  • A percentage of (amount spent / budget) will be printed

Example and Expected Output:

budget
Here is the budget for NOVEMBER 2021
   Category    | Amount | Budget  | Percentage
     FOOD      |  $5.00 / $100.00 | 5.00%
ENTERTAINMENT  |  $0.00 / Not set | 
TRANSPORTATION |  $0.00 / Not set | 
  HOUSEHOLD    |  $0.00 / Not set | 
   APPAREL     |  $0.00 / Not set | 
    BEAUTY     |  $0.00 / Not set | 
     GIFT      |  $0.00 / Not set | 
    OTHERS     | $23.50 / Not set | 

Exit the program: exit

Exits the Mint program.

Format: exit

Expected Output:

Bye! Thanks for using Mint. See you soon :D

Command Summary

Please refresh page if table is not rendered properly.

Command Format,Examples
add add [income] n/NAME a/AMOUNT [d/DATE] [c/CATEGORY_NUMBER]
e.g. add n/burger a/5 d/2021-10-20 c/0
addR addR [income] n/NAME a/AMOUNT [d/DATE] [c/CATEGORY_NUMBER] i/INTERVAL [e/END_DATE]
e.g. addR a/90 d/2021-12-03 n/phone bills c/3 i/MONTH
edit edit [n/NAME] [a/AMOUNT] [d/DATE] [c/CATEGORY_NUMBER]
e.g. edit n/burger a/5 d/2021-10-20 c/0
editR editR [n/NAME] [d/DATE] [a/AMOUNT] [c/CATEGORY_NUMBER] [i/INTERVAL] [e/END_DATE]
e.g.editR n/Textbook d/2012-09-21 a/15
delete delete [n/NAME] [a/AMOUNT] [d/DATE] [c/CATEGORY_NUMBER]
e.g. delete n/Cheese Burger d/20-10-2021 a/4.2
deleteR deleteR [n/NAME] [d/DATE] [a/AMOUNT] [c/CATEGORY_NUMBER] [i/INTERVAL] [e/END_DATE]
e.g. deleteR n/Netflix
view view [income] [expense] [by SORTTYPE] [month MONTH] [year YEAR] [from STARTDATE [ENDDATE]] [up/ascending]
e.g. view from 2021-03-25 2022-01-02 by amount ascending
view categories cat
set set c/CATEGORY_NUMBER a/AMOUNT
budget budget
deleteAll deleteAll [normal] [recurring]
help help
exit exit

Frequently Asked Questions

  • Why are users able to record AMOUNT as "$0"?

    • This is to allow users to keep a record of entries that are free after discounts or vouchers.
  • Why are users allowed to make recurring entries' END_DATE shorter than the INTERVAL (e.g., set monthly Expense's DATE as 2021-11-04 and END_DATE as 2021-11-15)?

    • This is so that users can use the END_DATE as a reminder to themselves to cancel subscriptions or be aware of the end of receiving fixed incomes.