docs: deposits + loans

Dwigoric · Dec 1, 2023 · e328ccf · e328ccf
1 parent c54c4ef
commit e328ccf
Show file tree

Hide file tree

Showing 10 changed files with 145 additions and 13 deletions.
diff --git a/docs/topics/Adding-Deposit-Ledger-Transaction.md b/docs/topics/Adding-Deposit-Ledger-Transaction.md
@@ -1,3 +1,5 @@
 # Adding Deposit Ledger Transaction
 
-Start typing here...
+To add a deposit transaction, click the ___Add New Transaction___ button found at the bottom of the deposit ledger. 
+
+From there, fill in the fields. Click on the ___Submit___ button when you are done, and it will immediately be reflected to the system.
diff --git a/docs/topics/Adding-Loan-Ledger-Transaction.md b/docs/topics/Adding-Loan-Ledger-Transaction.md
@@ -1,3 +1,13 @@
 # Adding Loan Ledger Transaction
 
-Start typing here...
+To add a loan transaction, click the ___Add New Transaction___ button found at the bottom of the loan ledger. If the ___Add New Transaction___ button cannot be pressed, that could be due to the fact the loan has not been released.
+
+From there, you can pick whether you are encoding a:
+- Payment
+  - To deduct from your outstanding balance.
+- Dues
+  - To add from your outstanding balance.
+- Balance Readjustment
+  - Purely for editing and readjusting the loanee's balance.
+
+Once you are done with the transaction, simply click the __submit__ button to submit it to the database, and it will be instantly reflected to the ledger.
diff --git a/docs/topics/Creating-New-Deposit.md b/docs/topics/Creating-New-Deposit.md
@@ -1,5 +1,25 @@
 # Creating New Deposit
 
+When creating a deposit application, you do not need to fill out all the fields.
+The fields related to the member's information are required, but their information will be retrieved when you search for their profile.
+
+<procedure title="Creating a loan application" type="steps">
+<step>
+Search for a member by their name or username.
+</step>
+<step>
+Click on the member's name to select them, or press
+Enter or tab.
+<img src="member-search-result.png" alt="Member search result" />
+</step>
+<step>
+Fill out the loan application form.
+<step>
+Click on the <strong>Submit</strong> button to submit the deposit application.
+</step>
+
+Deposits do not need any approval, hence they are immediately reflected to the system once submitted.
+
 <seealso>
     <category ref="deposits">
         <a href="Deposit-Dashboard.md" />

diff --git a/docs/topics/Deposit-Dashboard.md b/docs/topics/Deposit-Dashboard.md
@@ -1,5 +1,25 @@
 # Deposit Dashboard
 
+Present in the __Deposit Dashboard__ page are all the loans present in the system.
+
+Each row contains information on a certain deposit. Information present are as follows:
+- Deposit Category
+  - This can be categorized as:
+    - Share Capital
+    - Savings
+    - Time Deposit
+- Deposit Holder; A button that can forward the user to the deposit holder's profile.
+- Approval Date
+
+## Sorting, Filtering, and Searching
+
+Deposits are not sorted in any order, but it is possible to add you own sort. Adding your own sort can be done by clicking the header of the certain field you would like to toggle. An arrow would then appear, pointing up for ascending, and pointing down for descending. Clicking the header once again would remove the sorting of that specific header. Additionally, the search bar found on the top left of the deposits table can help filter specific fields you wish to search.
+
+## Accessing the Deposit Ledger
+
+To access the deposit ledger of a specific deposit, find the deposit to view, navigate to the right most part of the deposit's row and find the arrow. This will forward you to the deposit's ledger page.
+
+
 <seealso>
     <category ref="deposits">
         <a href="Creating-New-Deposit.md" />

diff --git a/docs/topics/Deposit-Ledger.md b/docs/topics/Deposit-Ledger.md
@@ -1,3 +1,29 @@
 # Deposit Ledger
 
-Start typing here...
+The loan ledger can be accessed through:
+
+*  The [Deposit Dashboard](Deposit-Dashboard.md)
+*  Respective [Member Profile](Member-Profiles.md)
+
+The full contents of a deposit can be found in this page as well. The contents are as follows:
+- Running Amount
+- Deposit ID
+- Type of Deposit
+  - This can be categorized into:
+    - Share Capital
+    - Savings
+    - Time Deposit
+- Date of Deposit
+
+Below the loan info is the actual loan ledger. Per row, the information are as follows:
+- Date of Payment
+- GV/OR Number
+- Transaction Type
+  - This can be categorized into
+    - Deposit
+    - Withdrawal
+- Amount
+- Interest
+- Balance   
+- Date of Entry
+- Officer in Charge
diff --git a/docs/topics/Deposits.md b/docs/topics/Deposits.md
@@ -1,5 +1,10 @@
 # Deposits
 
+Loans can be viewed in two different ways:
+* Through the [Deposit Dashboard](Deposit-Dashboard.md), which contains all deposits in the system
+present in the system
+* Through a [member's profile](Member-Profiles.md), which contains all deposits of that specific member.
+
 <seealso>
     <category ref="deposits">
         <a href="Deposit-Dashboard.md" />

diff --git a/docs/topics/Loan-Dashboard.md b/docs/topics/Loan-Dashboard.md
@@ -1,9 +1,6 @@
 # Loan Dashboard
 
-The first thing you see once you enter the website is the ___Loan Dashboard___.
-This page houses all loans found in the database that are accepted.
-
-![Dashboard Page](dashboard-page.png)
+The first thing you see once you enter the website is the ___Loan Dashboard___. This page houses all loans found in the database that are accepted.
 
 Each row contains information on a certain loan. Information present are:
 - Type of Loan
@@ -15,7 +12,7 @@ Each row contains information on a certain loan. Information present are:
 
 ## Sorting, Filtering, and Searching
 
-Additionally, loans are sorted firstly by ___status___, then by ___due date___. Adding your own sort is possible by clicking the header of the certain field you would like to toggle. An arrow would then appear, pointing up for ascending, and pointing down for descending. Clicking the header once again would remove the sorting of that specific header. Also, the search bar found on the top right of the loan table can help filter specific fields you wish to search.
+Additionally, loans are sorted firstly by ___status___, then by ___due date___. Adding your own sort is possible by clicking the header of the certain field you would like to toggle. An arrow would then appear, pointing up for ascending, and pointing down for descending. Clicking the header once again would remove the sorting of that specific header. Also, the search bar found on the top left of the loans table can help filter specific fields you wish to search.
 
 ## Signifiers
 

diff --git a/docs/topics/Loan-Ledger.md b/docs/topics/Loan-Ledger.md
@@ -1,3 +1,52 @@
 # Loan Ledger
 
-Start typing here...
+The loan ledger can be accessed through:
+
+*  The [Loan Dashboard](Loan-Dashboard.md)
+*  Respective [Member Profile](Member-Profiles.md)
+
+The full contents of a loan can be found in this page as well. The contents are as follows:
+- Outstanding balance of the loan
+    - This is remaining balance needed to be paid
+- Original loan amount
+    - This is the original loan amount that was applied for
+- Loanee
+- Loan ID
+- Loan Approval Date
+  - Date the loan was accepted
+- Type of Loan
+  - Can be categorized into:
+    - Emergency
+    - Multipurpose
+    - Educational
+    - Petty Cash
+    - Commerical
+    - Livelihood
+- Term of Loan
+- Mode of Payment
+  - Can be categorized into:
+    - Daily
+    - Weekly
+    - Monthly
+- Coborrower Name
+- Status
+  - Can be categorized into:
+    - Pending
+    - Approved
+    - Approved (For Release)
+    - Rejected 
+    - Completed
+
+Below the loan info is the actual loan ledger. Per row, the information are as follows:
+- Date of Transaction
+- GV/OR Number
+- Amount Due
+- Amount Paid
+- Balance
+- Interest Due
+- Interest Paid
+- Fines Due
+- Fines Paid
+- Date of Entry
+- Officer in Charge
+
diff --git a/docs/topics/Loans.md b/docs/topics/Loans.md
@@ -1,10 +1,9 @@
 # Loans
 
 Loans can be viewed in two different ways:
-* Through the [Loan Dashboard](Loan-Dashboard.md), which contains all loans
+* Through the [Loan Dashboard](Loan-Dashboard.md), which contains all loans in the system
 present in the system
-* Through a [member's profile](Member-Profiles.md), which contains all loans
-of that specific member.
+* Through a [member's profile](Member-Profiles.md), which contains all loans of that specific member.
 
 
 <seealso>

diff --git a/docs/topics/Marking-Loan-as-Released.md b/docs/topics/Marking-Loan-as-Released.md
@@ -1,3 +1,7 @@
 # Marking Loan as Released
 
-Start typing here...
+When loans are approved from the __Pending Loans__ page, they must be released in order to add transactions. Loans can be seen as released at the __Loan Dashboard__ with a status of ___Approved (For Release)___
+
+To do that, simply navigate to the loan ledger of the loan you wish to ___Mark Loan as Released___. There you will find a ___Mark Loan as Released___ button to the left of the ___Edit Loan___ button. If the ___Mark Loan as Released___ is not present in the page, the loan has already been marked as released.
+
+Pressing the ___Mark Loan as Released___ button will then forward you to a prompt asking if you are sure you want to mark the loan as released. Simply click ___Yes___, and the loan will be released, ready for transactions to be added.