Field Reference
Complete reference of all fields in the Loans module.
This page provides a full reference of every field used across the Loans module, including loan records, repayment schedules, loan types, and status values.
Loan Record Fields
These fields appear when viewing or creating a loan entry.
| Field | Type | Description | Example |
|---|---|---|---|
| ID | Text | Unique identifier for the loan record | loan_abc123 |
| Borrower | Text | The name of the employee or driver who received the loan | Ahmed Hassan |
| Borrower Type | Enum | Whether the borrower is an Employee or a Driver | Driver |
| Loan Type | Text | The category of loan assigned to this record | Salary Advance |
| Amount | Number | The total loan amount in AED | 5,000.00 |
| Interest Rate | Number | The annual interest rate as a percentage | 0 |
| Tenure | Number | The repayment period in months | 6 |
| Monthly Installment | Number | The amount deducted each month in AED | 833.33 |
| Total Repayable | Number | The total amount to be repaid including any interest | 5,000.00 |
| Outstanding Balance | Number | The remaining amount still owed by the borrower | 3,333.34 |
| Status | Enum | The current status of the loan | ACTIVE |
| Start Date | Date | The date when repayment begins | 2025-02-01 |
| Disbursement Date | Date | The date when funds were released to the borrower | 2025-01-20 |
| Notes | Text | Optional comments about the loan purpose or context | "Salary advance for January" |
| Created At | Date | The date when the loan application was submitted | 2025-01-15 |
| Approved By | Text | The name of the user who approved the loan (shown only if approved) | Admin User |
| Rejection Reason | Text | The reason provided when a loan is rejected (shown only if rejected) | "Exceeds limit" |
Loan Status Values
Each loan has one of the following statuses at any given time.
| Status | Display Label | Description |
|---|---|---|
| PENDING | Pending | The loan application has been submitted and is awaiting review by an authorized approver. |
| APPROVED | Approved | The loan has been approved. Funds have not yet been disbursed to the borrower. |
| REJECTED | Rejected | The loan application has been denied. A rejection reason is provided by the approver. |
| DISBURSED | Disbursed | Funds have been released to the borrower. Repayment has not yet started. |
| ACTIVE | Active | The loan is being actively repaid. At least one installment payment has been recorded. |
| COMPLETED | Paid | All installments have been paid in full. The loan is fully settled. |
| DEFAULTED | Defaulted | The borrower has failed to make required payments. The loan is in default. |
| CANCELLED | Cancelled | The loan was cancelled before funds were disbursed. |
For details on how statuses transition, see Approval Workflow.
Repayment Schedule Fields
These fields appear in the repayment schedule table for each installment of a loan.
| Field | Type | Description | Example |
|---|---|---|---|
| Installment # | Number | The sequential number of the installment | 3 |
| Due Date | Date | The date when this installment payment is due | 2025-04-01 |
| Amount | Number | The total installment amount in AED | 833.33 |
| Principal | Number | The portion of the payment applied to the loan balance | 833.33 |
| Interest | Number | The portion of the payment covering interest charges | 0.00 |
| Status | Enum | The payment status of this installment -- Paid, Pending, or Overdue | Pending |
| Payment Date | Date | The actual date when the payment was made (shown only for paid installments) | 2025-04-01 |
| Remaining Balance | Number | The outstanding loan balance after this installment is paid | 2,500.01 |
Installment Status Values
| Status | Description |
|---|---|
| Paid | The installment has been paid. The payment date and amount are recorded. |
| Pending | The installment is not yet due. It is scheduled for a future date. |
| Overdue | The due date has passed and the payment has not been received. |
Loan Type Fields
These fields are used when configuring loan types.
| Field | Type | Description | Example |
|---|---|---|---|
| Name | Text | The display name of the loan type | Salary Advance |
| Max Amount | Number | The maximum amount (AED) that can be loaned under this type | 10,000.00 |
| Max Tenure | Number | The maximum repayment period in months | 12 |
| Default Interest Rate | Number | The default annual interest rate (%) pre-filled when creating a loan | 0 |
| Description | Text | An explanation of the loan type's purpose and policies | "Short-term advance on upcoming salary" |
| Status | Enum | Whether the loan type is Active (available for new loans) or Inactive (hidden from creation form) | Active |
List View Columns
The main Loan List table displays the following columns.
| Column | Source Field | Description |
|---|---|---|
| Borrower | Borrower | The name of the employee or driver |
| Loan Type | Loan Type | The category of loan |
| Amount (AED) | Amount | The total loan amount, formatted in AED |
| Monthly Installment | Monthly Installment | The per-month repayment amount |
| Outstanding Balance | Outstanding Balance | The remaining amount to be repaid |
| Status | Status | A color-coded badge showing the current loan status |
| Start Date | Start Date | When repayment begins |
Notes
All monetary values in the Loans module are displayed in AED (United Arab Emirates Dirham). Amounts are stored with two decimal places of precision.
The "Approved By" field is only visible after a loan has been approved. The "Rejection Reason" field is only visible after a loan has been rejected. These fields do not appear on newly created (Pending) loans.
The COMPLETED status is displayed as "Paid" throughout the user interface to clearly communicate that the loan has been fully repaid.