TrueRental User Guide

Notes about command format:

• Commands are case-sensitive and should always be lowercase.
  E.g. help, cadd, cedit, list.

• Words in UPPER_CASE are the parameters to be supplied by the user.
  E.g. in cadd n/NAME, NAME is a parameter which can be used as add n/John Doe.

• Items without brackets are mandatory, you must provide a value.
  E.g. n/NAME for cadd, CLIENT_INDEX and a/ADDRESS for radd.

• Items in square brackets [] are mandatory to have at least one of them, you should not omit all of them in a command.
  E.g cedit can be used as cedit 1 n/Steven Tan e/steventan@abc.com p/98765432 or cedit 1 n/Steven Tan p/98765432.

• Items in curly brackets {} are optional, you may choose not to have them in your command.
  E.g. radd can be used as radd 1 a/140 Robinson Road, #03-05, Chow House or radd 1 a/140 Robinson Road, #03-05, Chow House m/3200 dd/10 d/0.

• Items with ...​ after them can be used multiple times.
  E.g. k/KEYWORDS for find can be used as find k/Steven Tan k/98765432 (2 times), find k/98765432 (1 time), etc.

• Parameters can be in any order.
  E.g. if the command specifies n/NAME p/PHONE_NUMBER, p/PHONE_NUMBER n/NAME is also acceptable.

• There should be minimally one whitespace between every parameter option flag
  E.g. n/James Tan e/jamestan@example.com.

• Extraneous parameters for commands that do not take in parameters (such as help, list, exit, sort and clear) will be ignored.
  E.g. if the command specifies help 123, it will be interpreted as help.

• Some commands will prompt for confirmation. Inputting y or yes counts as confirmation, and any other input counts as cancellation.

• If you are using a PDF version of this document, be careful when copying and pasting commands that span multiple lines as space characters surrounding line-breaks may be omitted when copied over to the application.

Notes about this user guide:

• Please refer to this user guide whenever you feel something is wrong with the application to determine whether it is a genuine problem.
• If you are a more technical or experienced user, feel free to check out our Developer Guide for detailed technical information about TrueRental.
• The client referred to in this user guide is the property owner or landlord who has engaged you to manage their property.
• The rental information referred to in this user guide consists of the details of the property being rented, including key information for example address, rental start date, and other relevant property details.
• The customer (as part of the rental information) referred to in this user guide is the tenant of the property owned by the client.
• Monthly rent is equivalent to monthly rent amount.
  • Both are referring to the monthly rent amount for the property owned by your client.
• Deposit is equivalent to deposit amount.
  • Both are referring to the security deposit amount for the property owned by your client, paid by the tenant at the start of the lease.
• Customer list is equivalent to customers.
  • Both are referring to the list of tenant(s) for the property owned by your client.
• Rent due date is equivalent to rental monthly payment date.
  • Both are referring to the specific date (of the month) on which the rent payment is due for the property owned by your client.

Tip: Refer to respective features within Features for a better understanding of each command.

Tip: Alternatively, you can press the button at the top of the navigation button bar to view the help page, or simply press f1.

Constraints:

1. A client must have at least either one phone number or one email address.

Tip:

1. A client can have any number of tags, ranging from 0 to infinity.
2. A client's name with special characters, such as Ravi S/O Ramasamy will not be accepted.
   Please omit any special characters within the name, such as Ravi SO Ramasamy.

Constraints:

• The CLIENT_INDEX refers to the index number shown in the displayed client list and must be a positive integer starting from 1.
• The value of address for the rental information cannot be empty.

Note: Displays all rental information related to the client at the specified CLIENT_INDEX.

Constraints: The CLIENT_INDEX refers to the index number shown in the displayed client list and must be a positive integer starting from 1.

Constraints:

• The CLIENT_INDEX refers to the index shown in the displayed client list and must be a positive number.
• The range starts from 1 till the last number shown within the list.
• A client name cannot be empty.
• A client must have at least either one phone number or one email address.
• A client's NAME, PHONE_NUMBER and EMAIL will be replaced by the provided value in the command, given that it is not a duplicate.
• All the client's existing TAGs will be removed and replaced by the provided value in the command.

Tip:

• You can remove a client's existing phone number or email address by providing an empty input after p/ or e/ respectively.
• You can remove all the client's existing tags by providing an empty input after t/.
• A client's name with special characters, such as Ravi S/O Ramasamy will not be accepted. Please omit any special character within the name such as Ravi SO Ramasamy.

Constraints:

• The CLIENT_INDEX refers to the index number shown in the displayed client list and must be a positive integer starting from 1.
• The RENTAL_INDEX refers to the client's rental index number shown in the displayed rental information list ( run rview CLIENT_INDEX to display the rental information list) and must be a positive integer starting from 1.
  • If you already know the RENTAL_INDEX of the rental information you want to edit, you can just use it directly in the command without needing to run rview CLIENT_INDEX to check for the RENTAL_INDEX.
• You cannot and should not edit the value of ADDRESS to be empty, as it is required to not be empty.
• Editing a parameter will remove its existing value and replace with the newly specified value.

Tip:

• You can remove the value of existing rental start date, rental end date, rent due date, monthly rent, deposit or customer list of the specified rental information by providing an empty value after s/, e/, dd/, m/, d/ or cl/ respectively.

Constraints: Must contain at least one of the optional fields.

Note: Utilising KEYWORD will perform a search for clients whose details include the keyword. Clients are matched if any of their fields contains the keyword, including rental information details (E.g. name, email, address, etc.).

Tips:

• The search is case-insensitive. e.g hans will match Hans.
• For [k/KEYWORD], [n/NAME], [p/PHONE_NUMBER] and [e/EMAIL], partial input will be matched with any of the fields, if any.
  E.g. Han will match Hans
• Tags ([t/TAG]) will match exactly.
  E.g. t/Friend will only match with the tag Friend, not Friends or MyBestFriend.
• Clients matching at least one keyword will be returned (i.e. OR search).
  E.g. k/Hans k/Bo will return Hans Gruber, Bo Yang`

Note:

• Confirmation required. Type y for yes, any other input will result in a cancellation.
• Deletes the client at the specified CLIENT_INDEX and all related rental information.
• The index refers to the index number shown in the displayed client list.
• The index must be a positive integer starting from 1.

Note:

• Confirmation required. Type y for yes, any other input will result in a cancellation.
• Deletes the rental information at the specified RENTAL_INDEX from the client at the specified CLIENT_INDEX.
• CLIENT_INDEX refers to the index number shown in the displayed client list.
• RENTAL_INDEX refers to the index number shown in the displayed rental information list when the rview command is run. (i.e. rview CLIENT_INDEX)
• CLIENT_INDEX and RENTAL_INDEX must be positive integer starting from 1.

Constraints:

• If there are no more previous commands, it will display the last command within the command history in the command box.
• If there are no more next commands, it will display an empty command in the command box.

Note:

• All commands within the command history will be cleared upon exiting the TrueRental application.
• Only TrueRental specific commands will be stored within the command history.

Constraints:

• The available value for autofill depends on the helping words specified by TrueRental (please refer to the List of helping words after Note for all available helping words).
• Autofill is not customized for every single prefix, all prefixes will have same set of value for autofill.

Note:

• You should not rely on autofill too much as this feature is meant to provide some simple helps only, may not be fully accurate.
• Autofill only help you to get "started" with typing.
• Autofill for prefix is not fully customized for each command, it may have extra prefix that is not used by the command.
• Autofill for prefix may not be working for some commands which does not require extra parameters such as list, or command that does not need prefix such as cdelete.

Constraints:

• Only .json files can be imported.
• The chosen file must have the correct format.
• The correct format is the same as the data file of the app. Visit our Developer Guide for more details.

Note:

• Importing data will delete all current data in the address book. It is recommended to back up the current data via the export command.
• Confirmation required. Type y for yes, any other input will result in a cancellation.
• A new window will be opened that prompts for a file.

Note:

• Address book data can only be exported as .json files.
• A new window will be opened that prompts for a file.

Note: Confirmation required. Type y for yes, any other input will result in a cancellation.

Caution: If your changes to the data file makes its format invalid, TrueRental will discard all data and start with an empty data file at the next run. Hence, it is recommended to take a backup of the file before editing it.
Furthermore, certain edits can cause the TrueRental to behave in unexpected ways (E.g. if a value entered is outside the acceptable range). Therefore, edit the data file only if you are confident that you can update it correctly.