Financial Year
Navigation Path
Company → Masters → Financial Year
1. Financial Year List Page
URL
/masters/financial-year
Page Description
- Displays a list of all financial years configured in the system
- Allows admins to manage active and historical financial year records
- Provides actions to add, edit, and delete financial year entries
List Table Columns
| Column Name | Description |
|---|---|
| S No | Serial number |
| From Date | Financial year start date |
| To Date | Financial year end date |
| Actions | Edit and Delete options |
Row Actions
| Action | Description |
|---|---|
| Edit | Opens Edit Financial Year page with pre-filled data |
| Delete | Opens delete confirmation alert |
2. Add Financial Year Page
Triggered From
Financial Year List Page → Add Financial Year button
Page Description
- Allows admins to define a new financial year period
- Used for payroll, accounting, and statutory calculations
Add Financial Year – Fields
| Field Name | Type | Mandatory | Description |
|---|---|---|---|
| From Date | Date Picker | Yes | Select financial year start date |
| To Date | Date Picker | Yes | Select financial year end date |
Actions
| Action | Behavior |
|---|---|
| Save | Validates and saves the financial year |
| Reset | Clears selected dates |
| Cancel | Returns to Financial Year List page |
Validation Rules
- From Date is mandatory
- To Date is mandatory
- To Date must be later than From Date
- Overlapping financial years are not allowed
3. Edit Financial Year Page
Triggered From
Financial Year List Page → Edit icon
Page Description
- Allows updating existing financial year details
- All fields are pre-filled with saved data
Editable Fields
| Field Name | Editable |
|---|---|
| From Date | Yes |
| To Date | Yes |
Actions
| Action | Behavior |
|---|---|
| Update | Saves changes |
| Cancel | Discards changes and navigates back |
4. Delete Financial Year Confirmation Alert
Triggered From
Financial Year List Page → Delete icon
Alert Content
- Confirmation message before deletion
Actions:
- Confirm / Yes → Deletes the financial year
- Cancel → Closes the alert without action
Delete Behavior
- Financial year is removed permanently after confirmation
- Deletion may be restricted if the financial year is already in use
Field Definitions, Usage, and Calculation Logic
This section provides a technical analysis of the Financial Year Master's data structure and its role in payroll cycles.
1. Field Definitions
| Field Name | Data Type | Description | Example Value |
|---|---|---|---|
startDate | Date | Beginning of the financial period (Required). | 2024-04-01 |
endDate | Date | End of the financial period (Required). | 2025-03-31 |
calendarYear | Number | Representative numeric year for reporting. | 2024 |
isActive | Boolean | Operational status (Default: true). | true |
companyId | ObjectId | Reference to the parent Company. | 60a8b... |
2. Field Usage & System Impact
| Category | Validation / Rule | System Behavior |
|---|---|---|
| Periodicity | startDate < endDate | Enforced at the UI and Controller level to prevent invalid date ranges. |
| Active Cycle | isActive | Only one financial year should typically be "Active" for current payroll processing. |
| Audit Trace | insertedUserId | Automatically linked to the system user for accountability in fiscal setup. |
3. Business & Calculation Logic
The Financial Year Master governs the boundaries of salary processing and statutory filing:
A. Fiscal Bounds & Tax Calculation
- Income Tax: The
startDateandendDatedefine the bucket for investment declarations and tax projections. All salary slips generated within this range are aggregated for Form 16 and fiscal year-end calculations. - Sequentiality: The system uses
calendarYearfor sorting and quick-lookup in drop-down menus (e.g., "FY 2024-25").
B. Administrative Lifecycle
- Soft-Delete: Deleting a financial year (
isDeleted.status: true) hides it from the "Active Year" selection in settings, preventing new transactions from being posted to an old or incorrect fiscal period. - Concurrency: The use of
companyIdensures that multiple companies within the same group can maintain different financial year cycles (e.g., April-March vs Jan-Dec).
C. Relational Integrity
The _id of the Financial Year is a mandatory field in Salary Slip generation and Leave Management (for leave reset cycles). Deletion is restricted if there are processed payroll records linked to the specific year.
The Financial Year Master module interacts with the following API endpoints:
Base URL
export const FINANCIALYEAR_URL = '/api/salaryFinancialYear'
Endpoints
| Endpoint | Method | Description | Parameters/Body |
|---|---|---|---|
${FINANCIALYEAR_URL} | POST | Create a new financial year | Body: data |
${FINANCIALYEAR_URL} | GET | Get all financial years | Query: page, limit |
${FINANCIALYEAR_URL}/:financialYearId | GET | Get financial year by ID | Path: financialYearId |
${FINANCIALYEAR_URL}/:financialYearId | PATCH | Update an existing financial year | Path: financialYearId, Body: body |
${FINANCIALYEAR_URL}/delete/:financialYearId | PATCH | Delete a financial year | Path: financialYearId |
RTK Query Hooks
The following hooks are available for frontend integration:
useCreateFinancialYearMutationuseGetAllFinancialYearsQueryuseGetFinancialYearByIdQueryuseUpdateFinancialYearMutationuseDeleteFinancialYearMutation
End of Documentation