Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
1 change: 1 addition & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{}
20 changes: 10 additions & 10 deletions docs/getting-started/modules.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,21 +18,21 @@ SQL Payroll consists of 3 main modules:

| Module | Description |
| -------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
| [**Maintain Allowance**](../usage/payroll/maintenance/maintain-allowance.md) | Define the allowance type, rate and contribution |
| **Maintain Claims** | Define the claims type and amount |
| [**Maintain Commission**](../usage/payroll/maintenance/maintain-commission.md) | Define the commission type, rate and contribution |
| [**Maintain Contribution**](../usage/payroll/maintenance/maintain-contribution.md) | Enable to set Bonus, Director Fee, EPF, working hour/day per month, OT, etc. |
| **Maintain Deduction** | Define the deduction type, rate and contribution |
| [**Maintain Frequency**](../usage/payroll/maintenance/maintain-frequency.md) | Enable to set different frequency, eg. weekly, half month |
| [**Maintain Overtime**](../usage/payroll/maintenance/maintain-overtime.md) | Define the overtime type, rate , unit type, and contribution |
| [**Maintain Payment Method**](../usage/payroll/maintenance/maintain-payment-method.md) | Define the bank information |
| [**Maintain Wages**](../usage/payroll/maintenance/maintain-wages.md) | Enable to set different contribution on Wages, such EPF, SOCSO, EIS, PCB, OT,EA and HRDF |
| [**Maintain Allowance**](../usage/payroll/setup.md#maintain-allowance) | Define the allowance type, rate and contribution |
| [**Maintain Claims**](../usage/payroll/setup.md#maintain-claim) | Define the claims type and amount |
| [**Maintain Commission**](../usage/payroll/setup.md#maintain-commission) | Define the commission type, rate and contribution |
| [**Maintain Contribution**](../usage/payroll/setup.md#maintain-contribution) | Enable to set Bonus, Director Fee, EPF, working hour/day per month, OT, etc. |
| [**Maintain Deduction**](../usage/payroll/setup.md#maintain-deduction) | Define the deduction type, rate and contribution |
| [**Maintain Frequency**](../usage/payroll/setup.md#maintain-frequency) | Enable to set different frequency, eg. weekly, half month |
| [**Maintain Overtime**](../usage/payroll/setup.md#maintain-overtime) | Define the overtime type, rate , unit type, and contribution |
| [**Maintain Payment Method**](../usage/payroll/setup.md#maintain-payment-method) | Define the bank information |
| [**Maintain Wages**](../usage/payroll/setup.md#maintain-wages) | Enable to set different contribution on Wages, such EPF, SOCSO, EIS, PCB, OT,EA and HRDF |

## Other Basic modules

| Module | Description |
| --------------------------------------------------------------------- | -------------------------------------------------------------------- |
| [**Maintain Employee**](../usage/human-resource/maintain-employee.md) | Help to maintain employees biodata |
| [**Maintain Employee**](../usage/human-resource/human-resources-setup.md#maintain-employee) | Help to maintain employees biodata |
| **Maintain Branch** | Define the branch name, eg. HQ, branch A, B, C, etc |
| **Maintain Department** | Define the department, eg. Accounts, Sales, Production, etc |
| **Maintain Group** | Define the group level, eg. Director, Manager, Executive, Clerk, etc |
Expand Down
4 changes: 2 additions & 2 deletions docs/integration/hrms/autostart.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ description: A guide to enable Auto Start (Android only)
This setting only available on **Android** devices that supports Auto Start
:::

**Step:** Search **'SQL HRMS'** | Allow Auto Start
**Step:** Search **'SQL HRMS'** | Allow Auto Start

![autostart](../../../static/img/integration/hrms/autostart/autostart.png)

:::info
Expand Down
71 changes: 43 additions & 28 deletions docs/integration/hrms/e-claim/app-usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,19 @@ description: An E Claim features in SQL HRMS app guide
![dashboard](../../../../static/img/integration/hrms/e-claim/dashboard.png)

- **Claim Status Count Summary**:
- User's total approved, pending and rejected claims in the current year
- User can tap on each status to view claims with the respective status
- User's total approved, pending and rejected claims in the current year
- User can tap on each status to view claims with the respective status
- **Claim Amount Summary**: User's total amount of pending and approved claims submitted in the current year
- **Claim Balance Summary**: User’s pending and approved claims on each expenses types by month and by year

## Claim Submission
**Step 1:**

**Step 1:**

**Default Claim:** Select expense type, claim date, amount and description

**E-Invoice Claim:** Select attachment that includes a **VALID** E-Invoice QR code

- User can view the MTD limit, YTD limit and claim balance for each selected expenses type
- For E-Invoice Claim, post date, ref 1 and ref 2 will be filled in based on the E-Invoice and are not editable
- User need to allow Camera and Photos (only for iOS device) permission in order to continue the service (refer [Android Permission](../permission.md#android-2) and [iOS Permission](../permission.md#ios-2))
Expand All @@ -29,7 +31,8 @@ description: An E Claim features in SQL HRMS app guide
![claim-submission](../../../../static/img/integration/hrms/e-claim/claim-submission.png)

#### Claim Submission Warning Dialog Box
The app will help to do the following checkings after user click on the ***'Submit' button***:

The app will help to do the following checkings after user click on the ***'Submit' button***:

1. **Exceed MTD Limit:** Prompts if total submitted amount (including previous submission) exceed the monthly limit of the expenses type

Expand All @@ -44,6 +47,7 @@ User can choose to change the claim details by submitting a new claim (***'Reapp
:::

#### Claim Submission Sucessful

The app will prompt this dialog message upon successful submission

1. Successful Dialog Box
Expand All @@ -59,20 +63,21 @@ The app will prompt this dialog message upon successful submission
![claim-successful-email-noti](../../../../static/img/integration/hrms/e-claim/claim-successful-email-noti.png)

## Claim Status

User can view all his claim transactions once enter this page

![claim-status](../../../../static/img/integration/hrms/e-claim/claim-status.png)

- User can apply filter and sorting order to view different claim transaction listing:
- Filtering options:
- Expenses type
- Date range
- Claim status
- Sorting options:
- Date
- Expenses type
- Claim Status
- Type of claim status:
- Filtering options:
- Expenses type
- Date range
- Claim status
- Sorting options:
- Date
- Expenses type
- Claim Status
- Type of claim status:

| **Icon** | **Claim Status** | **Remark** |
| :------- | :--------------- | :--------- |
Expand All @@ -86,31 +91,33 @@ User can view all his claim transactions once enter this page

![claim-detail](../../../../static/img/integration/hrms/e-claim/claim-detail.png)

- User are allowed to edit the claim transaction details or cancel the claim on **Pending Approval** claims.
- User are allowed to edit the claim transaction details or cancel the claim on **Pending Approval** claims.
- ***'View Change Log' button***: View change log of the claim

## Team Claim (Manager only)

Manager can view all claim transactions of his team once enter this page

![team-claim](../../../../static/img/integration/hrms/e-claim/team-claim.png)

- Manager can apply filter and sorting order to view different claim transaction listing:
- Filtering options:
- Expenses type
- Date range
- Claim Status
- Branch
- Department
- Sorting options:
- Date
- Expenses type
- Claim Status
- Filtering options:
- Expenses type
- Date range
- Claim Status
- Branch
- Department
- Sorting options:
- Date
- Expenses type
- Claim Status

### Claim Approval

![claim-approval](../../../../static/img/integration/hrms/e-claim/claim-approval.png)

- Managers can apply different actions on his team’s claim transaction based on the claim status

| **Claim Status** | **Allowed Actions** |
| :--------------- | :------------------ |
| Pending Approval | Approve, Reject |
Expand All @@ -122,7 +129,8 @@ Manager can view all claim transactions of his team once enter this page
- ***'View Change Log' button***: View change log of the claim

#### Claim Approval Warning Dialog Box
The following checkings will be carried out when manager approving a claim:

The following checkings will be carried out when manager approving a claim:

1. **MTD Claim Over Limit:**
- The app will prompt this dialog box if total approval amount (including previous claim transaction) already exceed the monthly limit of the expenses type
Expand All @@ -137,18 +145,22 @@ The following checkings will be carried out when manager approving a claim:
![ytd-over-limit](../../../../static/img/integration/hrms/e-claim/ytd-over-limit.png)

#### Claim Comment Dialog Box

Manager can enter a comment for the claim approval / claim status update (optional) before proceed the updates

![claim-comment-dialog](../../../../static/img/integration/hrms/e-claim/claim-comment-dialog.png)

#### Claim Status Update Successful

The app will prompt a dialog message upon successful update on the claim status

![claim-status-update-successful](../../../../static/img/integration/hrms/e-claim/claim-status-update-successful.png)

### Notification

#### Claim Approval
User will receive the following notification once manager approves his claim:

User will receive the following notification once manager approves his claim:

1. App Notification

Expand All @@ -159,7 +171,8 @@ User will receive the following notification once manager approves his claim:
![claim-approval-email-noti](../../../../static/img/integration/hrms/e-claim/claim-approval-email-noti.png)

### Claim Approval Failed
User will receive the following notification if manager failed to approve his claim (exceed year limit):

User will receive the following notification if manager failed to approve his claim (exceed year limit):

1. App Notification

Expand All @@ -170,7 +183,8 @@ User will receive the following notification if manager failed to approve his cl
![claim-approval-failed-email-noti](../../../../static/img/integration/hrms/e-claim/claim-approval-failed-email-noti.png)

### Claim Approval Rejected
User will receive the following notification once manager rejects his leave:

User will receive the following notification once manager rejects his leave:

1. App Notification

Expand All @@ -181,6 +195,7 @@ User will receive the following notification once manager rejects his leave:
![claim-approval-rejected-email-noti](../../../../static/img/integration/hrms/e-claim/claim-approval-rejected-email-noti.png)

## Activity Center

User can view his and his team’s (manager only) claim transaction updates from the Activity Center (Dashboard | Activity Center (Bell icon on top left))

![activity-center](../../../../static/img/integration/hrms/e-claim/activity-center.png)
7 changes: 4 additions & 3 deletions docs/integration/hrms/e-claim/payroll-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,18 @@ description: An E Claim setup guide in SQL Payroll
---

## Maintain Claim

**Step 1:** Payroll | Maintenance | Maintain Claim… | Select a Claim/ Create New

**Step 2:** Set Yearly Limit and Monthly Limit
Option 1: Maintain Claim
Option 1: Maintain Claim

![maintain-claim1](../../../../static/img/integration/hrms/e-claim/maintain-claim1.png)

Option 2: Maintain Employee | Claim Limit tab
Option 2: Maintain Employee | Claim Limit tab

![maintain-claim2](../../../../static/img/integration/hrms/e-claim/maintain-claim2.png)

:::info
Payroll / SQL HRMS app will prioritize claim limit set in Maintain Employee over the claim limit in Maintain Claim
:::
:::
4 changes: 2 additions & 2 deletions docs/integration/hrms/e-claim/sync-cloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ description: An E Claim sync cloud guide in SQL Payroll
- **Red Highlight:** Rejected claim
- Editable columns:
- Comment
- Action:
- Action:
- Approved
- Reject
- Unapprove
Expand All @@ -22,6 +22,7 @@ description: An E Claim sync cloud guide in SQL Payroll
![sync-cloud](../../../../static/img/integration/hrms/e-claim/sync-cloud.png)

## Edit Mode

**Step 1:** Right-click on the grid | Edit

![sync-cloud-edit](../../../../static/img/integration/hrms/e-claim/sync-cloud-edit.png)
Expand All @@ -34,4 +35,3 @@ description: An E Claim sync cloud guide in SQL Payroll
- Amount

**Step 2:** Save

Loading