Salary Mandate
Navigation Path
Salary → Salary Mandate
Salary Mandate Page
URL
/salary/salary-mandate
Page Description
- Displays salary records that are fully verified and approved
- Used for salary bank mandate processing
- Allows exporting mandate data and updating transfer status
- Only verified records appear on this page
Search & Filter Section
Search Fields
| Field Name | Type | Description |
|---|---|---|
| Month | Dropdown | Select salary month |
| Year | Dropdown | Select salary year |
| Client | Dropdown | Filter by client |
| Unit | Dropdown | Filter by unit |
| Employee Code | Text Input | Search by employee code |
Actions
| Action | Description |
|---|---|
| Search | Loads verified mandate records |
| Reset | Clears all filters |
Salary Mandate List Table
Table Columns
| Column Name | Description |
|---|---|
| S No | Serial number |
| Month / Year | Salary month and year |
| Process Type | Salary process type |
| Total Records | Number of employees |
| Total Amount | Total salary amount |
| Transferred | Transfer status |
| Actions | View, Update, Download |
Row Actions
| Action | Description |
|---|---|
| View | Opens salary mandate details |
| Update Transfer Status | Opens transfer update modal |
| Download | Downloads mandate Excel |
Export Mandate
Export Option
- Export button allows downloading the salary mandate Excel
- Export includes:
- Employee bank details
- Salary amounts
- Mandate summary
Update Transfer Status Modal
Triggered From
Salary Mandate List → Update Transfer Status action
Modal Fields
| Field Name | Type | Mandatory | Description |
|---|---|---|---|
| Transfer Date | Date Picker | Yes | Date of salary transfer |
| Transfer Remarks | Text Area | No | Additional remarks |
Modal Actions
| Action | Behavior |
|---|---|
| Update Transfer Status | Marks salary as transferred |
| Cancel | Closes modal without changes |
Page Rules & Restrictions
- Only verified salary records are shown
- Unverified or pending salaries are excluded
- Mandate export is available only for verified data
API Endpoints
The Salary Mandate module interacts with the following API endpoints:
Base URL
export const SALARYMANDATE_URL = '/api/salaryMandate'
Endpoints
| Endpoint | Method | Description | Parameters/Body |
|---|---|---|---|
${SALARYMANDATE_URL} | POST | Create a new salary mandate | Body: data |
${SALARYMANDATE_URL} | GET | Get all salary mandates with pagination | Query: page, limit |
${SALARYMANDATE_URL}/search | POST | Search salary mandates with filters | Body: data (search criteria) |
${SALARYMANDATE_URL}/:mandateId | GET | Get salary mandate by ID | Path: mandateId |
${SALARYMANDATE_URL}/:mandateId | PATCH | Update an existing salary mandate | Path: mandateId, Body: body |
${SALARYMANDATE_URL}/:mandateId/transfer-status | PATCH | Update transfer status for a mandate | Path: mandateId, Body: body |
${SALARYMANDATE_URL}/bulk/transfer-status | PATCH | Bulk update transfer status for multiple mandates | Body: body (array of mandate IDs and status) |
${SALARYMANDATE_URL}/delete/:mandateId | PATCH | Delete a salary mandate (soft delete) | Path: mandateId |
${SALARYMANDATE_URL}/statistics/overview | GET | Get mandate statistics overview | Query: query (filters) |
${SALARYMANDATE_URL}/export | POST | Export mandates to Excel | Body: data (export criteria), Returns: Excel file (blob) |
RTK Query Hooks
The following hooks are available for frontend integration:
useCreateSalaryMandateMutationuseGetAllSalaryMandatesQueryuseSearchSalaryMandatesMutationuseGetSalaryMandateByIdQueryuseUpdateSalaryMandateMutationuseUpdateTransferStatusMutationuseBulkUpdateTransferStatusMutationuseDeleteSalaryMandateMutationuseGetMandateStatisticsQueryuseExportMandatesToExcelMutation
End of Documentation