Field Reference
Complete reference of all fields in the Fines module.
This page provides a complete reference of all fields, status values, and mappings used in the Fines module.
Fine Record Fields
| Field | Type | Description | Example |
|---|---|---|---|
| ID | Text | Unique identifier for the fine record | fin_abc123 |
| Employee/Driver | Text | The person who was fined | John Smith |
| Target Type | Enum | Whether the fine was issued to an Employee or Driver | Driver |
| Category | Text | The fine type/category applied | Traffic Violation |
| Amount (AED) | Number | The fine amount in AED | 500.00 |
| Date | Date | The date when the violation occurred | 2025-01-15 |
| Description | Text | Details about the violation and circumstances | "Ran red light on Sheikh Zayed Rd" |
| Evidence | File | Supporting documentation such as photos, screenshots, or reports | evidence.jpg |
| Workflow Status | Enum | The current approval status of the fine | APPROVED |
| Payment Status | Enum | The current collection status of the fine | UNPAID |
| Display Status | Text | The combined status shown in the Fines List table | DEDUCTED |
| Created At | Date | When the fine record was created in the system | 2025-01-16 |
| Approved By | Text | The user who approved or rejected the fine | Admin User |
| Rejection Reason | Text | The reason provided when a fine is rejected | "Insufficient evidence" |
Workflow Status Values
The workflow status tracks where the fine is in the approval process.
| Value | Description |
|---|---|
| PENDING | The fine has been submitted and is waiting for an authorized user to review and approve or reject it |
| APPROVED | The fine has been reviewed and approved. It is now eligible for salary deduction, waiver, or loan conversion |
| REJECTED | The fine has been reviewed and rejected. The approver has provided a reason. The fine will not be charged |
| CANCELLED | The fine was cancelled before an approval decision was made. This is typically done by the person who created the fine |
| CONVERTED_TO_LOAN | The fine has been converted to a loan for installment repayment through the Loans module |
Payment Status Values
The payment status tracks the collection of the fine amount. This status is only meaningful for fines with an APPROVED workflow status.
| Value | Description |
|---|---|
| UNPAID | The fine has been approved but the amount has not yet been collected from the employee or driver |
| PARTIAL | A partial payment has been received toward the fine. The remaining balance is still outstanding |
| PAID | The full fine amount has been collected, typically through automatic salary deduction in payroll |
| WAIVED | The fine amount has been forgiven by management. No payment will be collected |
Display Status Mapping
The display status is a simplified label shown in the Fines List table. It combines the workflow status and payment status into a single, easy-to-read value.
| Workflow Status | Payment Status | Displayed As |
|---|---|---|
| PENDING | UNPAID | Pending |
| APPROVED | UNPAID | Approved |
| APPROVED | PAID | Deducted |
| APPROVED | WAIVED | Waived |
| REJECTED | -- | Rejected |
| CANCELLED | -- | Cancelled |
| CONVERTED_TO_LOAN | -- | Converted |
"Deducted" means the fine was approved and the full amount has been deducted from the person's salary. "Waived" means the fine was approved but then forgiven. "Converted" means the fine was turned into a loan for installment repayment.
Fine Category Fields
Fine categories define the types of fines available for selection when creating a fine.
| Field | Type | Description | Example |
|---|---|---|---|
| Name | Text | The name of the fine category | Traffic Violation |
| Description | Text | An explanation of what violations this category covers | Speeding, red light, wrong parking |
| Default Amount (AED) | Number | The pre-set fine amount for this category (can be overridden per fine) | 500.00 |
| Status | Enum | Whether the category is available for use | Active |
Category Status Values
| Value | Description |
|---|---|
| Active | The category is available and appears in the dropdown when creating a new fine |
| Inactive | The category is hidden from the creation form but preserved for existing fine records |
Target Type Values
| Value | Description |
|---|---|
| Employee | The fine is issued to a company employee |
| Driver | The fine is issued to a driver |
Related Pages
- Fines Overview -- Module overview and navigation
- Creating a Fine -- How to issue a new fine
- Approval Workflow -- Detailed explanation of the dual status system
- Converting Fines to Loans -- Loan conversion process
- Managing Fine Categories -- Setting up fine types