# M18 HCM Web Services
Version: 1.0 | Release Date: 30/6/2018
# Payroll Management
# Get Employee List with Specified Payroll Group
HTTP Request
GET http://[server]/jsf/rfws/payroll/payrollGroup/getPayrollGroupEmpList/{payrollGroupId}
Parameters
| Name | Type | Description |
|---|---|---|
| payrollGroupId | Long(Path) | Required. ID of payroll Group |
Result (in JSON Array)
| Name | Type | Description |
|---|---|---|
| size | int | Size of JsonArray in values |
| values | string | Data, depends on Table |
| name | string | Name. Empty |
| fields | string | Field Details |
Sample request:
OkHttpClient client = new OkHttpClient();
long payrollGroupId = 14;
String url = "http://" + server + "/jsf/rfws/payroll/payrollGroup/getPayrollGroupEmpList/" + payrollGroupId;
Request request = new Request.Builder()
.url(url)
.get()
.addHeader("client_id", clientID)
.addHeader("authorization", "Bearer " + token)
.addHeader("cache-control", "no-cache")
.build();
Response response = client.newCall(request).execute();
Sample response:
{
"size": 10,
"values": [
{
"payrollRoleEmp.dept.dept.code": "ADMIN",
"code": "001",
"st_code": "001",
"payrollRoleEmp.position.position.code": "001",
"st_desc": "001",
"dept": 5,
"st_id": 996,
"desc__lang": "001",
"payrollRoleEmp.position.position.desc": "001",
"position": 4,
"id": 996,
"payrollRoleEmp.dept.dept.desc": "Admin",
"status": "Y",
"desc": "001"
},
{
"payrollRoleEmp.dept.dept.code": "T01",
"code": "002",
"st_code": "002",
"payrollRoleEmp.position.position.code": "002",
"st_desc": "002",
"dept": 8,
"photoCode": "cl429O29933038852O476",
"st_id": 15,
"desc__lang": "English",
"payrollRoleEmp.position.position.desc": "00002",
"position": 5,
"id": 15,
"payrollRoleEmp.dept.dept.desc": "T01",
"status": "Y",
"desc": "English"
},
{
"payrollRoleEmp.dept.dept.code": "T01",
"code": "003",
"st_code": "003",
"payrollRoleEmp.position.position.code": "002",
"st_desc": "003",
"dept": 8,
"photoCode": "cl429O29933038852O476",
"st_id": 998,
"desc__lang": "??",
"payrollRoleEmp.position.position.desc": "00002",
"position": 5,
"id": 998,
"payrollRoleEmp.dept.dept.desc": "T01",
"status": "Y",
"desc": "??"
},
{
"payrollRoleEmp.dept.dept.code": "ADMIN",
"code": "004",
"st_code": "004",
"payrollRoleEmp.position.position.code": "001",
"st_desc": "004",
"dept": 5,
"st_id": 436,
"desc__lang": "004_??",
"payrollRoleEmp.position.position.desc": "001",
"position": 4,
"id": 436,
"payrollRoleEmp.dept.dept.desc": "Admin",
"status": "Y",
"desc": "004"
},
{
"payrollRoleEmp.dept.dept.code": "ADMIN",
"code": "005",
"st_code": "005",
"payrollRoleEmp.position.position.code": "002",
"st_desc": "005",
"dept": 5,
"st_id": 437,
"desc__lang": "005",
"payrollRoleEmp.position.position.desc": "00002",
"position": 5,
"id": 437,
"payrollRoleEmp.dept.dept.desc": "Admin",
"status": "Y",
"desc": "005"
},
{
"payrollRoleEmp.dept.dept.code": "SC06",
"code": "006",
"st_code": "006",
"payrollRoleEmp.position.position.code": "002",
"st_desc": "006",
"dept": 178,
"st_id": 438,
"desc__lang": "006",
"payrollRoleEmp.position.position.desc": "00002",
"position": 5,
"id": 438,
"payrollRoleEmp.dept.dept.desc": "SC006",
"status": "Y",
"desc": "006"
},
{
"payrollRoleEmp.dept.dept.code": "ANDY001",
"code": "007",
"st_code": "007",
"payrollRoleEmp.position.position.code": "002",
"st_desc": "007",
"dept": 154,
"st_id": 440,
"desc__lang": "???",
"payrollRoleEmp.position.position.desc": "00002",
"position": 5,
"id": 440,
"payrollRoleEmp.dept.dept.desc": "AH?????",
"status": "Y",
"desc": "???"
},
{
"payrollRoleEmp.dept.dept.code": "ANDY001",
"code": "008",
"st_code": "008",
"payrollRoleEmp.position.position.code": "002",
"st_desc": "008",
"dept": 154,
"st_id": 441,
"desc__lang": "008",
"payrollRoleEmp.position.position.desc": "00002",
"position": 5,
"id": 441,
"payrollRoleEmp.dept.dept.desc": "AH?????",
"status": "Y",
"desc": "008"
},
{
"payrollRoleEmp.dept.dept.code": "CR01",
"code": "010",
"st_code": "010",
"payrollRoleEmp.position.position.code": "002",
"st_desc": "010",
"dept": 157,
"st_id": 507,
"desc__lang": "010",
"payrollRoleEmp.position.position.desc": "00002",
"position": 5,
"id": 507,
"payrollRoleEmp.dept.dept.desc": "CR01",
"status": "Y",
"desc": "010"
},
{
"payrollRoleEmp.dept.dept.code": "ANDY001",
"code": "011",
"st_code": "011",
"payrollRoleEmp.position.position.code": "002",
"st_desc": "011",
"dept": 154,
"st_id": 508,
"desc__lang": "011",
"payrollRoleEmp.position.position.desc": "00002",
"position": 5,
"id": 508,
"payrollRoleEmp.dept.dept.desc": "AH?????",
"status": "Y",
"desc": "011"
}
]
}
# Get Salary Package Details with Specified Salary Package ID
HTTP Request
GET http://[server]/jsf/rfws/payroll/salaryPack/getSalaryPackDetails/{salaryPackId}
Parameters
| Name | Type | Description |
|---|---|---|
| salaryPackId | long(Path) | Required. Salary Package ID |
Result (in JSON Array)
| Name | Type | Description |
|---|---|---|
| size | int | Size of JsonArray in values |
| values | string | Data, depends on Table |
| name | string | Name. Empty |
| fields | string | Field Details |
Sample request:
OkHttpClient client = new OkHttpClient();
long salaryPackId = 10;
String url = "http://" + server + "/jsf/rfws/payroll/salaryPack/getSalaryPackDetails/salaryPackId;
Request request = new Request.Builder()
.url(url)
.get()
.addHeader("client_id", clientID)
.addHeader("authorization", "Bearer " + token)
.addHeader("cache-control", "no-cache")
.build();
Response response = client.newCall(request).execute();
Sample response:
{
"size": 1,
"values": [
{
"cur": 3,
"acccode": "G1",
"amt": 3333,
"fixPayId": 21
}
],
"name": "",
"fields": [
{
"fieldClassName": "Long",
"name": "fixPayId",
"fieldClass": "java.lang.Long",
"classType": 10
},
{
"fieldClassName": "Long",
"name": "cur",
"fieldClass": "java.lang.Long",
"classType": 10
},
{
"fieldClassName": "Double",
"name": "amt",
"fieldClass": "java.lang.Double",
"classType": 10
},
{
"fieldClassName": "String",
"name": "acccode",
"fieldClass": "java.lang.String",
"classType": 0
}
]
}
# Get Specified Employee's Back Pay Calculation Result with Specified Payroll Calculation
HTTP Request
GET http://[server]/jsf/rfws/payroll/backPay/getEmpBackPaySummary/{backPayId}/{payCalcSetId}/{empId}
Parameters
| Name | Type | Description |
|---|---|---|
| backPayId | Long(Path) | Required. The Back Pay ID |
| payCalcSetId | Long(Path) | Required. The Payroll Calculation Setting ID |
| empId | Long(Path) | Required. The Employee ID |
Result (in JSON Array)
| Name | Type | Description |
|---|---|---|
| size | int | Size of JsonArray in values |
| values | string | Data, depends on Table |
Sample request:
OkHttpClient client = new OkHttpClient();
long backPayId = 4;
long payCalcSetId = 54;
long empId = 1150;
String url = "http://" + server + "/jsf/rfws/payroll/backPay/getEmpBackPaySummary/" + backPayId + "/" + payCalcSetId + "/" + empId;
Request request = new Request.Builder()
.url(url)
.get()
.addHeader("client_id", clientID)
.addHeader("authorization", "Bearer " + token)
.addHeader("cache-control", "no-cache")
.build();
Response response = client.newCall(request).execute();
Sample response:
{
"size": 44,
"values": [
{
"empId": 1128,
"paccType": "X",
"cur": 10,
"payCalcSetId": 35,
"pacc": "CONSUR",
"rate": 1,
"paccid": 28,
"mpfConDate": "1900-01-01 00:00:00",
"transferCode": "ACTPAYROLL"
},
{
"empId": 1128,
"paccType": "X",
"cur": 10,
"payCalcSetId": 35,
"pacc": "EEMC",
"rate": 1,
"paccid": 29,
"mpfConDate": "1900-01-01 00:00:00",
"transferCode": "ACTPAYROLL"
},
{
"empId": 1128,
"paccType": "X",
"cur": 10,
"payCalcSetId": 35,
"pacc": "EEVC",
"rate": 1,
"paccid": 30,
"mpfConDate": "1900-01-01 00:00:00",
"transferCode": "ACTPAYROLL"
},
{
"empId": 1128,
"paccType": "X",
"cur": 10,
"payCalcSetId": 35,
"pacc": "ERMC",
"rate": 1,
"paccid": 31,
"mpfConDate": "1900-01-01 00:00:00",
"transferCode": "ACTPAYROLL"
},
{
"empId": 1128,
"paccType": "X",
"cur": 10,
"payCalcSetId": 35,
"pacc": "ERVC",
"rate": 1,
"paccid": 32,
"mpfConDate": "1900-01-01 00:00:00",
"transferCode": "ACTPAYROLL"
},
{
"empId": 1128,
"paccDesc": "FRLS Net Payment",
"paccType": "X",
"newValue": 60000,
"cur": 10,
"payCalcSetId": 35,
"pacc": "FRLS_ACTPAYROLL",
"rate": 1,
"paccid": 355,
"mpfConDate": "1900-01-01 00:00:00",
"oldValue": 60000,
"transferCode": "ACTPAYROLL"
},
{
"empId": 1128,
"paccDesc": "FRLS Contribution Surcharge",
"paccType": "X",
"cur": 10,
"payCalcSetId": 35,
"pacc": "FRLS_CONSUR",
"rate": 1,
"paccid": 313,
"mpfConDate": "1900-01-01 00:00:00",
"transferCode": "ACTPAYROLL"
},
{
"empId": 1128,
"paccDesc": "FRLS Employee Mandatory Contribution (Calculation)",
"paccType": "X",
"cur": 10,
"payCalcSetId": 35,
"pacc": "FRLS_EEMC",
"rate": 1,
"paccid": 380,
"mpfConDate": "1900-01-01 00:00:00",
"transferCode": "ACTPAYROLL"
},
{
"empId": 1128,
"paccDesc": "FRLS Employee Voluntary Contribution (Calculation)",
"paccType": "X",
"cur": 10,
"payCalcSetId": 35,
"pacc": "FRLS_EEVC",
"rate": 1,
"paccid": 383,
"mpfConDate": "1900-01-01 00:00:00",
"transferCode": "ACTPAYROLL"
},
{
"empId": 1128,
"paccDesc": "FRLS Employer Mandatory Contribution (Calculation)",
"paccType": "X",
"cur": 10,
"payCalcSetId": 35,
"pacc": "FRLS_ERMC",
"rate": 1,
"paccid": 279,
"mpfConDate": "1900-01-01 00:00:00",
"transferCode": "ACTPAYROLL"
},
{
"empId": 1128,
"paccDesc": "FRLS Employer Voluntary Contribution (Calculation)",
"paccType": "X",
"cur": 10,
"payCalcSetId": 35,
"pacc": "FRLS_ERVC",
"rate": 1,
"paccid": 402,
"mpfConDate": "1900-01-01 00:00:00",
"transferCode": "ACTPAYROLL"
},
{
"empId": 1128,
"paccDesc": "FRLS Relevant Income of Mandatory Contribution",
"paccType": "X",
"newValue": 60000,
"cur": 10,
"payCalcSetId": 35,
"pacc": "FRLS_MCRELINC",
"rate": 1,
"paccid": 373,
"mpfConDate": "1900-01-01 00:00:00",
"oldValue": 60000,
"transferCode": "ACTPAYROLL"
},
{
"empId": 1128,
"paccDesc": "FRLS Minimum Wage for Current Period",
"paccType": "X",
"cur": 10,
"payCalcSetId": 35,
"pacc": "FRLS_MWCP",
"rate": 1,
"paccid": 256,
"mpfConDate": "1900-01-01 00:00:00",
"transferCode": "ACTPAYROLL"
},
{
"empId": 1128,
"paccDesc": "FRLS Minimum Wage Additional Remuneration",
"paccType": "X",
"cur": 10,
"payCalcSetId": 35,
"pacc": "FRLS_MWREM",
"rate": 1,
"paccid": 394,
"mpfConDate": "1900-01-01 00:00:00",
"transferCode": "ACTPAYROLL"
},
{
"empId": 1128,
"paccDesc": "FRLS Non-Working Wage",
"paccType": "X",
"cur": 10,
"payCalcSetId": 35,
"pacc": "FRLS_NWW",
"rate": 1,
"paccid": 357,
"mpfConDate": "1900-01-01 00:00:00",
"transferCode": "ACTPAYROLL"
},
{
"empId": 1128,
"paccDesc": "FRLS Gross Payment",
"paccType": "X",
"newValue": 60000,
"cur": 10,
"payCalcSetId": 35,
"pacc": "FRLS_PAYROLL",
"rate": 1,
"paccid": 299,
"mpfConDate": "1900-01-01 00:00:00",
"oldValue": 60000,
"transferCode": "ACTPAYROLL"
},
{
"empId": 1128,
"paccDesc": "FRLS Total Working Hours",
"paccType": "X",
"cur": 10,
"payCalcSetId": 35,
"pacc": "FRLS_TWH",
"rate": 1,
"paccid": 361,
"mpfConDate": "1900-01-01 00:00:00",
"transferCode": "ACTPAYROLL"
},
{
"empId": 1128,
"paccDesc": "FRLS Relevant Income of Voluntary Contribution",
"paccType": "X",
"cur": 10,
"payCalcSetId": 35,
"pacc": "FRLS_VCRELINC",
"rate": 1,
"paccid": 321,
"mpfConDate": "1900-01-01 00:00:00",
"transferCode": "ACTPAYROLL"
},
{
"empId": 1128,
"paccDesc": "FRLS Wage for Current Period (SMW Definition)",
"paccType": "X",
"cur": 10,
"payCalcSetId": 35,
"pacc": "FRLS_WCP",
"rate": 1,
"paccid": 396,
"mpfConDate": "1900-01-01 00:00:00",
"transferCode": "ACTPAYROLL"
},
{
"empId": 1128,
"paccType": "X",
"cur": 10,
"payCalcSetId": 35,
"pacc": "MCRELINC",
"rate": 1,
"paccid": 34,
"mpfConDate": "1900-01-01 00:00:00",
"transferCode": "ACTPAYROLL"
},
{
"empId": 1128,
"paccType": "X",
"cur": 10,
"payCalcSetId": 35,
"pacc": "MWCP",
"rate": 1,
"paccid": 36,
"mpfConDate": "1900-01-01 00:00:00",
"transferCode": "ACTPAYROLL"
},
{
"empId": 1128,
"paccType": "X",
"cur": 10,
"payCalcSetId": 35,
"pacc": "MWREM",
"rate": 1,
"paccid": 37,
"mpfConDate": "1900-01-01 00:00:00",
"transferCode": "ACTPAYROLL"
},
{
"empId": 1128,
"paccType": "X",
"cur": 10,
"payCalcSetId": 35,
"pacc": "NWW",
"rate": 1,
"paccid": 38,
"mpfConDate": "1900-01-01 00:00:00",
"transferCode": "ACTPAYROLL"
},
{
"empId": 1128,
"paccType": "X",
"cur": 10,
"payCalcSetId": 35,
"pacc": "TWH",
"rate": 1,
"paccid": 39,
"mpfConDate": "1900-01-01 00:00:00",
"transferCode": "ACTPAYROLL"
},
{
"empId": 1128,
"paccType": "X",
"cur": 10,
"payCalcSetId": 35,
"pacc": "VCRELINC",
"rate": 1,
"paccid": 35,
"mpfConDate": "1900-01-01 00:00:00",
"transferCode": "ACTPAYROLL"
},
{
"empId": 1128,
"paccType": "X",
"cur": 10,
"payCalcSetId": 35,
"pacc": "WCP",
"rate": 1,
"paccid": 40,
"mpfConDate": "1900-01-01 00:00:00",
"transferCode": "ACTPAYROLL"
}
],
"name": "",
"fields": [
{
"fieldClassName": "Long",
"name": "empId",
"fieldClass": "java.lang.Long",
"classType": 10
},
{
"fieldClassName": "Long",
"name": "payCalcSetId",
"fieldClass": "java.lang.Long",
"classType": 10
},
{
"fieldClassName": "Long",
"name": "paccid",
"fieldClass": "java.lang.Long",
"classType": 10
},
{
"fieldClassName": "String",
"name": "pacc",
"fieldClass": "java.lang.String",
"classType": 0
},
{
"fieldClassName": "String",
"name": "paccDesc",
"fieldClass": "java.lang.String",
"classType": 0
},
{
"fieldClassName": "String",
"name": "paccType",
"fieldClass": "java.lang.String",
"classType": 0
},
{
"fieldClassName": "Double",
"name": "oldValue",
"fieldClass": "java.lang.Double",
"classType": 10
},
{
"fieldClassName": "Double",
"name": "newValue",
"fieldClass": "java.lang.Double",
"classType": 10
},
{
"fieldClassName": "Double",
"name": "otsValue",
"fieldClass": "java.lang.Double",
"classType": 10
},
{
"fieldClassName": "Long",
"name": "cur",
"fieldClass": "java.lang.Long",
"classType": 10
},
{
"fieldClassName": "Double",
"name": "rate",
"fieldClass": "java.lang.Double",
"classType": 10
},
{
"fieldClassName": "String",
"name": "formulaDesc",
"fieldClass": "java.lang.String",
"classType": 0
},
{
"fieldClassName": "String",
"name": "mpfTrxNo",
"fieldClass": "java.lang.String",
"classType": 0
},
{
"fieldClassName": "Date",
"name": "mpfConDate",
"fieldClass": "java.util.Date",
"classType": 21
},
{
"fieldClassName": "String",
"name": "transferCode",
"fieldClass": "java.lang.String",
"classType": 0
}
]
},
{
"size": 1,
"values": [
{
"empId": 1128
}
],
"name": "",
"fields": [
{
"fieldClassName": "Long",
"name": "empId",
"fieldClass": "java.lang.Long",
"classType": 10
},
{
"fieldClassName": "String",
"name": "paySlipRemark",
"fieldClass": "java.lang.String",
"classType": 0
},
{
"fieldClassName": "String",
"name": "payCalcRemark",
"fieldClass": "java.lang.String",
"classType": 0
},
{
"fieldClassName": "Double",
"name": "backPayValue",
"fieldClass": "java.lang.Double",
"classType": 10
}
]
}
# Get Employee's Payroll Calculation Result
HTTP Request
GET http://[server]/jsf/rfws/payroll/payCalcSet/getEmpPayrollSummary/{payCalcSetId}/{empId}
Parameters
| Name | Type | Description |
|---|---|---|
| payCalcSetId | int(Path) | Required. The Payroll Calculation Setting ID |
| empId | int(Path) | Required. The Employee ID |
Result (in JSON Array)
| Name | Type | Description |
|---|---|---|
| size | int | Size of JsonArray in values |
| values | string | Data, depends on Table |
Sample request:
OkHttpClient client = new OkHttpClient();
int payCalcSetId = 54;
int empId = 1150;
String url = "http://" + server + "/jsf/rfws/payroll/payCalcSet/getEmpPayrollSummary/payCalcSetId/empId;
Request request = new Request.Builder()
.url(url)
.get()
.addHeader("client_id", clientID)
.addHeader("authorization", "Bearer " + token)
.addHeader("cache-control", "no-cache")
.build();
Response response = client.newCall(request).execute();
Sample response:
{
"size": 48,
"values": [
{
"empId": 1150,
"paccDesc": "Attendance Incentives (Part time)",
"paccType": "X",
"cur": 10,
"pacc": "AIPT",
"paccid": 95,
"mpfConDate": "2017-12-05 11:34:40"
},
{
"empId": 1150,
"paccDesc": "Basic Salary (Hourly)",
"paccType": "X",
"cur": 10,
"pacc": "BSHO",
"paccid": 92,
"mpfConDate": "2017-12-05 11:34:40"
},
{
"empId": 1150,
"paccDesc": "Basic Salary (Monthly)",
"paccType": "X",
"cur": 10,
"pacc": "BSMO",
"paccid": 91,
"mpfConDate": "2017-12-05 11:34:40"
},
{
"empId": 1150,
"paccType": "X",
"cur": 10,
"pacc": "CONSUR",
"paccid": 28,
"mpfConDate": "2017-12-05 11:34:40"
},
{
"empId": 1150,
"paccType": "X",
"cur": 10,
"pacc": "EEMC",
"paccid": 29,
"mpfConDate": "2017-12-05 11:34:40"
},
{
"empId": 1150,
"paccType": "X",
"cur": 10,
"pacc": "EEVC",
"paccid": 30,
"mpfConDate": "2017-12-05 11:34:40"
},
{
"empId": 1150,
"paccType": "X",
"cur": 10,
"pacc": "ERMC",
"paccid": 31,
"mpfConDate": "2017-12-05 11:34:40"
},
{
"empId": 1150,
"paccType": "X",
"cur": 10,
"pacc": "ERVC",
"paccid": 32,
"mpfConDate": "2017-12-05 11:34:40"
},
{
"empId": 1150,
"paccDesc": "FRLS Net Payment",
"paccType": "X",
"cur": 10,
"pacc": "FRLS_ACTPAYROLL",
"paccid": 355,
"mpfConDate": "2017-12-05 11:34:40"
},
{
"empId": 1150,
"paccDesc": "FRLS Contribution Surcharge",
"paccType": "X",
"cur": 10,
"pacc": "FRLS_CONSUR",
"paccid": 313,
"mpfConDate": "2017-12-05 11:34:40"
},
{
"empId": 1150,
"paccDesc": "FRLS Employee Mandatory Contribution (Calculation)",
"paccType": "X",
"cur": 10,
"pacc": "FRLS_EEMC",
"paccid": 380,
"mpfConDate": "2017-12-05 11:34:40"
},
{
"empId": 1150,
"paccDesc": "FRLS Employee Voluntary Contribution (Calculation)",
"paccType": "X",
"cur": 10,
"pacc": "FRLS_EEVC",
"paccid": 383,
"mpfConDate": "2017-12-05 11:34:40"
},
{
"empId": 1150,
"paccDesc": "FRLS Employer Mandatory Contribution (Calculation)",
"paccType": "X",
"cur": 10,
"pacc": "FRLS_ERMC",
"paccid": 279,
"mpfConDate": "2017-12-05 11:34:40"
},
{
"empId": 1150,
"paccDesc": "FRLS Employer Voluntary Contribution (Calculation)",
"paccType": "X",
"cur": 10,
"pacc": "FRLS_ERVC",
"paccid": 402,
"mpfConDate": "2017-12-05 11:34:40"
},
{
"empId": 1150,
"paccDesc": "FRLS Relevant Income of Mandatory Contribution",
"paccType": "X",
"cur": 10,
"pacc": "FRLS_MCRELINC",
"paccid": 373,
"mpfConDate": "2017-12-05 11:34:40"
},
{
"empId": 1150,
"paccDesc": "FRLS Minimum Wage for Current Period",
"paccType": "X",
"cur": 10,
"pacc": "FRLS_MWCP",
"paccid": 256,
"mpfConDate": "2017-12-05 11:34:40"
},
{
"empId": 1150,
"paccDesc": "FRLS Minimum Wage Additional Remuneration",
"paccType": "X",
"cur": 10,
"pacc": "FRLS_MWREM",
"paccid": 394,
"mpfConDate": "2017-12-05 11:34:40"
},
{
"empId": 1150,
"paccDesc": "FRLS Non-Working Wage",
"paccType": "X",
"cur": 10,
"pacc": "FRLS_NWW",
"paccid": 357,
"mpfConDate": "2017-12-05 11:34:40"
},
{
"empId": 1150,
"paccDesc": "FRLS Gross Payment",
"paccType": "X",
"cur": 10,
"pacc": "FRLS_PAYROLL",
"paccid": 299,
"mpfConDate": "2017-12-05 11:34:40"
},
{
"empId": 1150,
"paccDesc": "FRLS Total Working Hours",
"paccType": "X",
"cur": 10,
"pacc": "FRLS_TWH",
"paccid": 361,
"mpfConDate": "2017-12-05 11:34:40"
},
{
"empId": 1150,
"paccDesc": "FRLS Relevant Income of Voluntary Contribution",
"paccType": "X",
"cur": 10,
"pacc": "FRLS_VCRELINC",
"paccid": 321,
"mpfConDate": "2017-12-05 11:34:40"
},
{
"empId": 1150,
"paccDesc": "FRLS Wage for Current Period (SMW Definition)",
"paccType": "X",
"cur": 10,
"pacc": "FRLS_WCP",
"paccid": 396,
"mpfConDate": "2017-12-05 11:34:40"
},
{
"empId": 1150,
"paccType": "X",
"cur": 10,
"pacc": "MCRELINC",
"paccid": 34,
"mpfConDate": "2017-12-05 11:34:40"
},
{
"empId": 1150,
"paccType": "X",
"cur": 10,
"pacc": "MWCP",
"paccid": 36,
"mpfConDate": "2017-12-05 11:34:40"
},
{
"empId": 1150,
"paccType": "X",
"cur": 10,
"pacc": "MWREM",
"paccid": 37,
"mpfConDate": "2017-12-05 11:34:40"
},
{
"empId": 1150,
"paccType": "X",
"cur": 10,
"pacc": "NWW",
"paccid": 38,
"mpfConDate": "2017-12-05 11:34:40"
},
{
"empId": 1150,
"paccDesc": "Traveling Allowance",
"paccType": "X",
"cur": 10,
"pacc": "TRAL",
"paccid": 101,
"mpfConDate": "2017-12-05 11:34:40"
},
{
"empId": 1150,
"paccType": "X",
"cur": 10,
"pacc": "TWH",
"paccid": 39,
"mpfConDate": "2017-12-05 11:34:40"
},
{
"empId": 1150,
"paccType": "X",
"cur": 10,
"pacc": "VCRELINC",
"paccid": 35,
"mpfConDate": "2017-12-05 11:34:40"
},
{
"empId": 1150,
"paccType": "X",
"cur": 10,
"pacc": "WCP",
"paccid": 40,
"mpfConDate": "2017-12-05 11:34:40"
}
],
"name": "",
"fields": [
{
"fieldClassName": "Long",
"name": "empId",
"fieldClass": "java.lang.Long",
"classType": 10
},
{
"fieldClassName": "Long",
"name": "paccid",
"fieldClass": "java.lang.Long",
"classType": 10
},
{
"fieldClassName": "String",
"name": "pacc",
"fieldClass": "java.lang.String",
"classType": 0
},
{
"fieldClassName": "String",
"name": "paccDesc",
"fieldClass": "java.lang.String",
"classType": 0
},
{
"fieldClassName": "String",
"name": "paccType",
"fieldClass": "java.lang.String",
"classType": 0
},
{
"fieldClassName": "Double",
"name": "amt",
"fieldClass": "java.lang.Double",
"classType": 10
},
{
"fieldClassName": "Long",
"name": "cur",
"fieldClass": "java.lang.Long",
"classType": 10
},
{
"fieldClassName": "String",
"name": "formulaDesc",
"fieldClass": "java.lang.String",
"classType": 0
},
{
"fieldClassName": "String",
"name": "mpfTrxNo",
"fieldClass": "java.lang.String",
"classType": 0
},
{
"fieldClassName": "Date",
"name": "mpfConDate",
"fieldClass": "java.util.Date",
"classType": 21
}
]
},
{
"size": 1,
"values": [
{
"empId": 1150
}
],
"name": "",
"fields": [
{
"fieldClassName": "Long",
"name": "empId",
"fieldClass": "java.lang.Long",
"classType": 10
},
{
"fieldClassName": "String",
"name": "paySlipRemark",
"fieldClass": "java.lang.String",
"classType": 0
},
{
"fieldClassName": "String",
"name": "payCalcRemark",
"fieldClass": "java.lang.String",
"classType": 0
}
]
}
# Get Payroll Formula Details with Code Equals "DEFAULT"
HTTP Request
GET http://[server]/jsf/rfws/payroll/payrollFormula/getDefaFormula
Parameters
| Name | Type | Description |
|---|---|---|
| No Parameters needed |
Result (in JSON Array)
| Name | Type | Description |
|---|---|---|
| size | int | Size of JsonArray in values |
| values | string | Data, depends on Table |
Sample request:
OkHttpClient client = new OkHttpClient();
String url = "http://" + server + "/jsf/rfws/payroll/payrollFormula/getDefaFormula;
Request request = new Request.Builder()
.url(url)
.get()
.addHeader("client_id", clientID)
.addHeader("authorization", "Bearer " + token)
.addHeader("cache-control", "no-cache")
.build();
Response response = client.newCall(request).execute();
Sample response:
{
"size": 412,
"values": [
{
"paccType": "X",
"pacc": "ACTPAYROLL",
"paccId": 25,
"formula": "[FP_BS_AMT]+[VP_AI]",
"iRev": 1
},
{
"paccType": "X",
"pacc": "PAYROLL",
"paccId": 26,
"formula": "[FP_BS_AMT]",
"iRev": 1
},
{
"paccType": "X",
"pacc": "PRETAXTTL",
"paccId": 27,
"formula": "0",
"iRev": 1
},
{
"paccType": "X",
"pacc": "CONSUR",
"paccId": 28,
"formula": "0",
"iRev": 1
},
{
"paccType": "X",
"pacc": "EEMC",
"paccId": 29,
"formula": "0",
"iRev": 1
},
{
"paccType": "X",
"pacc": "EEVC",
"paccId": 30,
"formula": "0",
"iRev": 1
},
{
"paccType": "X",
"pacc": "ERMC",
"paccId": 31,
"formula": "0",
"iRev": 1
},
{
"paccType": "X",
"pacc": "ERVC",
"paccId": 32,
"formula": "0",
"iRev": 1
},
{
"paccType": "X",
"pacc": "MCIRRINC",
"paccId": 33,
"formula": "0",
"iRev": 1
},
{
"paccType": "X",
"pacc": "MCRELINC",
"paccId": 34,
"formula": "0",
"iRev": 1
},
{
"paccType": "X",
"pacc": "VCRELINC",
"paccId": 35,
"formula": "0",
"iRev": 1
},
{
"paccType": "X",
"pacc": "MWCP",
"paccId": 36,
"formula": "0",
"iRev": 1
},
{
"paccType": "X",
"pacc": "MWREM",
"paccId": 37,
"formula": "0",
"iRev": 1
},
{
"paccType": "X",
"pacc": "NWW",
"paccId": 38,
"formula": "0",
"iRev": 1
},
{
"paccType": "X",
"pacc": "TWH",
"paccId": 39,
"formula": "0",
"iRev": 1
},
{
"paccType": "X",
"pacc": "WCP",
"paccId": 40,
"formula": "0",
"iRev": 1
},
{
"paccType": "X",
"pacc": "LSP",
"paccId": 41,
"formula": "0",
"iRev": 1
}
],
"name": "",
"fields": [
{
"fieldClassName": "Long",
"name": "hId",
"fieldClass": "java.lang.Long",
"classType": 10
},
{
"fieldClassName": "Long",
"name": "iRev",
"fieldClass": "java.lang.Long",
"classType": 10
},
{
"fieldClassName": "String",
"name": "pacc",
"fieldClass": "java.lang.String",
"classType": 0
},
{
"fieldClassName": "Long",
"name": "paccId",
"fieldClass": "java.lang.Long",
"classType": 10
},
{
"fieldClassName": "String",
"name": "paccType",
"fieldClass": "java.lang.String",
"classType": 0
},
{
"fieldClassName": "String",
"name": "formula",
"fieldClass": "java.lang.String",
"classType": 0
},
{
"fieldClassName": "String",
"name": "formulaDesc",
"fieldClass": "java.lang.String",
"classType": 0
}
]
}
# Get Salary Package List with Effective Date before Employee's Join Date
HTTP Request
GET http://ip:port/jsf/rfws/payroll/salaryPack/getEffSalaryPack/{empId}/{joinDate}
Parameters
| Name | Type | Description |
|---|---|---|
| empId | int(Query) | Required. The Employee ID |
| joinDate | string(Query) | Required. The Employee Join Date |
Result (in JSON Array)
| Name | Type | Description |
|---|---|---|
| size | int | Size of JsonArray in values |
| values | string | Data, depends on Table |
| name | string | Name. Empty |
| fields | string | Field Details |
Sample request:
OkHttpClient client = new OkHttpClient();
long empId = "1150";
String joinDate = '99991231';
String url = "http://" + server + "/jsf/rfws/payroll/payrollGroup/getPayrollGroupEmpList?empId=" + empId & joinDate=" + joinDate;
Request request = new Request.Builder()
.url(url)
.get()
.addHeader("client_id", clientID)
.addHeader("authorization", "Bearer " + token)
.addHeader("cache-control", "no-cache")
.build();
Response response = client.newCall(request).execute();
Sample response:
{
"size": 4,
"values": [
{
"id": 9,
"code": "SAL170004",
"desc": "Basic Salary",
"empFilter": "{\"mode\":\"and\",\"criterias\":[]}"
},
{
"id": 7,
"code": "SAL170002",
"desc": "Basic Salary Combination",
"empFilter": "{\"mode\":\"and\",\"criterias\":[]}"
},
{
"id": 14,
"code": "D1",
"desc": "KD01",
"empFilter": "{\"mode\":\"and\",\"criterias\":[]}"
},
{
"id": 24,
"code": "FRLS_SP0001",
"desc": "FRLS Salary Package 0001",
"empFilter": "{\"mode\":\"and\",\"criterias\":[]}"
}
],
"name": "",
"fields": [
{
"name": "id",
"classType": 10,
"fieldClassName": "Long",
"fieldClass": "java.lang.Long"
},
{
"name": "code",
"classType": 0,
"fieldClassName": "String",
"fieldClass": "java.lang.String"
},
{
"name": "desc",
"classType": 0,
"fieldClassName": "String",
"fieldClass": "java.lang.String"
},
{
"name": "empFilter",
"classType": 0,
"fieldClassName": "String",
"fieldClass": "java.lang.String"
}
]
}