Workstem HK (Preview)
Workstem Hongkong Connector simplifies the data transfer using Workstem API and enables you to leverage your Workstem data for solving business application and integration needs.
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
| Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | Workstem Support |
| URL | https://help.workstem.com/en/ |
| [email protected] |
| Connector Metadata | |
|---|---|
| Publisher | OneJob Group Limited |
| Website | https://www.workstem.com/ |
| Privacy policy | https://www.workstem.com/hk/privacy-policy/ |
| Categories | IT Operations; Human Resources |
Workstem HK
Workstem HK connector allows you to access and operate your data in Workstem. With the power of Power Automate, you can do more analysis and schedule works.
Pre-requisites
First of all, you need to have an account in Workstem.
API documentation
The API documentation can be found here https://developer.workstem.com/
Supported Operations
- Get an item by ID: This action can be used to get an item of selected list by item ID.
- Update an item by ID: This action will update an item in selected list.
- Get fields of a list: This action will get the field definitions of a list.
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
Actions
| List of attendance calculations |
List of attendance calculations |
| List of cost centers |
List of cost centers |
| List of departments |
List of departments |
| List of employees |
List of employees |
| List of external payroll |
List of external payroll |
| List of external payroll items |
List of external payroll items |
| List of fixed Payroll items |
List of fixed Payroll items |
| List of job positions |
List of job positions |
| List of labels |
List of labels |
| List of leave applications |
List of leave applications |
| List of non-fixed salary items |
List of non-fixed salary items |
| List of office locations |
List of office locations |
| List of payroll Items |
List of payroll Items |
| List of payroll plan |
List of payroll plan |
| List of reimbursements |
List of reimbursements |
| List of schedules |
List of schedules |
| List of timesheets |
List of timesheets |
| Query tenant information |
Query tenant information |
| Update check-in info |
Update check-in info |
| Update department |
Update department |
| Update employee info |
Update employee info |
| Update external salary |
Update external salary |
| Update fixed salary items |
Update fixed salary items |
| Update label |
Update label |
| Update leave application |
Update leave application |
| Update non-fixed salary items |
Update non-fixed salary items |
| Update roster item |
Update roster item |
| Update shift template |
Update shift template |
| Update tenant information |
Update tenant information |
| Update the cost center |
Update the cost center |
| Update the expense records |
Update the expense records |
| Update the job position |
Update the job position |
| Update the office location |
Update the office location |
| Update the schedule |
Update the schedule |
| Update the timesheet |
Update the timesheet |
List of attendance calculations
List of attendance calculations
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Fuzzy query parameter
|
q | string |
Fuzzy query parameter |
|
|
Current page number
|
current | integer |
Current page number |
|
|
The number of pages
|
size | integer |
The number of pages |
|
|
Attendance Date filtering
|
attendDay | string |
Attendance Date filtering |
|
|
Employee ID filtering
|
employeeId | string |
Employee ID filtering |
|
|
Attendance status filtering
|
attendStatus | string |
Attendance status filtering |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
code
|
code | integer |
code |
|
message
|
message | string |
message |
|
size
|
data.size | integer |
size |
|
current
|
data.current | integer |
current |
|
records
|
data.records | array of object |
records |
|
id
|
data.records.id | string |
id |
|
attendDay
|
data.records.attendDay | string |
attendDay |
|
employeeId
|
data.records.employeeId | string |
employeeId |
|
shiftLabor
|
data.records.shiftLabor | float |
shiftLabor |
|
actualIn
|
data.records.actualIn | string |
actualIn |
|
actualOff
|
data.records.actualOff | string |
actualOff |
|
actualInText
|
data.records.actualInText | string |
actualInText |
|
actualOffText
|
data.records.actualOffText | string |
actualOffText |
|
attendStatus
|
data.records.attendStatus | string |
attendStatus |
|
laborLength
|
data.records.laborLength | float |
laborLength |
|
earliestCard
|
data.records.earliestCard | string |
earliestCard |
|
lateCard
|
data.records.lateCard | string |
lateCard |
|
confirm
|
data.records.confirm | string |
confirm |
|
afterAdjust
|
data.records.afterAdjust | float |
afterAdjust |
|
adjust
|
data.records.adjust | float |
adjust |
|
beLateLength
|
data.records.beLateLength | float |
beLateLength |
|
leaveEarlyLength
|
data.records.leaveEarlyLength | float |
leaveEarlyLength |
|
beLateTime
|
data.records.beLateTime | float |
beLateTime |
|
leaveEarlyTime
|
data.records.leaveEarlyTime | float |
leaveEarlyTime |
|
workingOvertime
|
data.records.workingOvertime | float |
workingOvertime |
|
holidayOvertime
|
data.records.holidayOvertime | float |
holidayOvertime |
|
dayOffOvertime
|
data.records.dayOffOvertime | float |
dayOffOvertime |
|
paidLeave
|
data.records.paidLeave | float |
paidLeave |
|
statutoryLeave
|
data.records.statutoryLeave | float |
statutoryLeave |
|
annualLeave
|
data.records.annualLeave | float |
annualLeave |
|
sickLeave
|
data.records.sickLeave | float |
sickLeave |
|
unpaidLeave
|
data.records.unpaidLeave | float |
unpaidLeave |
|
unpaidSickLeave
|
data.records.unpaidSickLeave | float |
unpaidSickLeave |
|
adjustmentLeave
|
data.records.adjustmentLeave | float |
adjustmentLeave |
|
type
|
data.records.type | string |
type |
|
leaveTime
|
data.records.leaveTime | float |
leaveTime |
|
shiftIn
|
data.records.shiftIn | string |
shiftIn |
|
shiftOff
|
data.records.shiftOff | string |
shiftOff |
|
absenceLength
|
data.records.absenceLength | float |
absenceLength |
|
definedItem1
|
data.records.definedItem1 | float |
definedItem1 |
|
definedItem2
|
data.records.definedItem2 | float |
definedItem2 |
|
definedItem3
|
data.records.definedItem3 | float |
definedItem3 |
|
definedItem4
|
data.records.definedItem4 | float |
definedItem4 |
|
definedItem5
|
data.records.definedItem5 | float |
definedItem5 |
|
definedItem6
|
data.records.definedItem6 | float |
definedItem6 |
|
definedItem7
|
data.records.definedItem7 | float |
definedItem7 |
|
definedItem8
|
data.records.definedItem8 | float |
definedItem8 |
|
definedItem9
|
data.records.definedItem9 | float |
definedItem9 |
|
definedItem10
|
data.records.definedItem10 | float |
definedItem10 |
|
ordinaryHours
|
data.records.ordinaryHours | float |
ordinaryHours |
|
satHours
|
data.records.satHours | float |
satHours |
|
sunHours
|
data.records.sunHours | float |
sunHours |
|
publicHolidayHours
|
data.records.publicHolidayHours | float |
publicHolidayHours |
|
morningShiftHours
|
data.records.morningShiftHours | float |
morningShiftHours |
|
afternoonShiftHours
|
data.records.afternoonShiftHours | float |
afternoonShiftHours |
|
nightShiftHours
|
data.records.nightShiftHours | float |
nightShiftHours |
|
mealBreakTimes
|
data.records.mealBreakTimes | float |
mealBreakTimes |
|
otBefore
|
data.records.otBefore | float |
otBefore |
|
otAfter
|
data.records.otAfter | float |
otAfter |
|
ordinaryRates
|
data.records.ordinaryRates | float |
ordinaryRates |
|
satRates
|
data.records.satRates | float |
satRates |
|
sunRates
|
data.records.sunRates | float |
sunRates |
|
publicHolidayRates
|
data.records.publicHolidayRates | float |
publicHolidayRates |
|
morningShiftRates
|
data.records.morningShiftRates | float |
morningShiftRates |
|
afternoonShiftRates
|
data.records.afternoonShiftRates | float |
afternoonShiftRates |
|
nightShiftRates
|
data.records.nightShiftRates | float |
nightShiftRates |
|
otBeforeRates
|
data.records.otBeforeRates | float |
otBeforeRates |
|
otAfterRates
|
data.records.otAfterRates | float |
otAfterRates |
|
ordinaryPenalty
|
data.records.ordinaryPenalty | float |
ordinaryPenalty |
|
satPenalty
|
data.records.satPenalty | float |
satPenalty |
|
sunPenalty
|
data.records.sunPenalty | float |
sunPenalty |
|
publicHolidayPenalty
|
data.records.publicHolidayPenalty | float |
publicHolidayPenalty |
|
morningShiftPenalty
|
data.records.morningShiftPenalty | float |
morningShiftPenalty |
|
afternoonShiftPenalty
|
data.records.afternoonShiftPenalty | float |
afternoonShiftPenalty |
|
nightShiftPenalty
|
data.records.nightShiftPenalty | float |
nightShiftPenalty |
|
otBeforePenalty
|
data.records.otBeforePenalty | float |
otBeforePenalty |
|
otAfterPenalty
|
data.records.otAfterPenalty | float |
otAfterPenalty |
|
overtimeSaturdayFirstHours
|
data.records.overtimeSaturdayFirstHours | float |
overtimeSaturdayFirstHours |
|
overtimeSaturdayAfterHours
|
data.records.overtimeSaturdayAfterHours | float |
overtimeSaturdayAfterHours |
|
overtimeSundayFirstHours
|
data.records.overtimeSundayFirstHours | float |
overtimeSundayFirstHours |
|
overtimeSundayAfterHours
|
data.records.overtimeSundayAfterHours | float |
overtimeSundayAfterHours |
|
overtimePublicHolidayFirstHours
|
data.records.overtimePublicHolidayFirstHours | float |
overtimePublicHolidayFirstHours |
|
overtimePublicHolidayAfterHours
|
data.records.overtimePublicHolidayAfterHours | float |
overtimePublicHolidayAfterHours |
|
overtimeSaturdayFirstHourlyRate
|
data.records.overtimeSaturdayFirstHourlyRate | float |
overtimeSaturdayFirstHourlyRate |
|
overtimeSaturdayAfterHourlyRate
|
data.records.overtimeSaturdayAfterHourlyRate | float |
overtimeSaturdayAfterHourlyRate |
|
overtimeSundayFirstHourlyRate
|
data.records.overtimeSundayFirstHourlyRate | float |
overtimeSundayFirstHourlyRate |
|
overtimeSundayAfterHourlyRate
|
data.records.overtimeSundayAfterHourlyRate | float |
overtimeSundayAfterHourlyRate |
|
overtimePublicHolidayFirstHourlyRate
|
data.records.overtimePublicHolidayFirstHourlyRate | float |
overtimePublicHolidayFirstHourlyRate |
|
overtimePublicHolidayAfterHourlyRate
|
data.records.overtimePublicHolidayAfterHourlyRate | float |
overtimePublicHolidayAfterHourlyRate |
|
overtimeSaturdayFirstHoursPay
|
data.records.overtimeSaturdayFirstHoursPay | float |
overtimeSaturdayFirstHoursPay |
|
overtimeSaturdayAfterHoursPay
|
data.records.overtimeSaturdayAfterHoursPay | float |
overtimeSaturdayAfterHoursPay |
|
overtimeSundayFirstHoursPay
|
data.records.overtimeSundayFirstHoursPay | float |
overtimeSundayFirstHoursPay |
|
overtimeSundayAfterHoursPay
|
data.records.overtimeSundayAfterHoursPay | float |
overtimeSundayAfterHoursPay |
|
overtimePublicHolidayFirstHoursPay
|
data.records.overtimePublicHolidayFirstHoursPay | float |
overtimePublicHolidayFirstHoursPay |
|
overtimePublicHolidayAfterHoursPay
|
data.records.overtimePublicHolidayAfterHoursPay | float |
overtimePublicHolidayAfterHoursPay |
|
timeOffInLieu
|
data.records.timeOffInLieu | float |
timeOffInLieu |
|
attendReviewStatus
|
data.records.attendReviewStatus | boolean |
attendReviewStatus |
|
attendReviewer
|
data.records.attendReviewer | string |
attendReviewer |
|
attendReviewTime
|
data.records.attendReviewTime | string |
attendReviewTime |
|
payrollReviewStatus
|
data.records.payrollReviewStatus | boolean |
payrollReviewStatus |
|
payrollReviewer
|
data.records.payrollReviewer | string |
payrollReviewer |
|
payrollReviewTime
|
data.records.payrollReviewTime | string |
payrollReviewTime |
|
attendReviewerName
|
data.records.attendReviewerName | string |
attendReviewerName |
|
payrollReviewerName
|
data.records.payrollReviewerName | string |
payrollReviewerName |
|
standardLaborTime
|
data.records.standardLaborTime | string |
standardLaborTime |
|
dataStatus
|
data.records.dataStatus | string |
dataStatus |
|
englishName
|
data.records.englishName | string |
englishName |
|
pages
|
data.pages | integer |
pages |
|
total
|
data.total | integer |
total |
List of cost centers
List of cost centers
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
fuzzy query parameter
|
q | string |
fuzzy query parameter |
|
|
current
|
current | integer |
current |
|
|
size
|
size | integer |
size |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
code
|
code | integer |
code |
|
message
|
message | string |
message |
|
size
|
data.size | integer |
size |
|
current
|
data.current | integer |
current |
|
records
|
data.records | array of object |
records |
|
id
|
data.records.id | string |
id |
|
name
|
data.records.name | string |
name |
|
deleted
|
data.records.deleted | string |
deleted |
|
costCenterCode
|
data.records.costCenterCode | string |
costCenterCode |
|
status
|
data.records.status | string |
status |
|
pages
|
data.pages | integer |
pages |
|
total
|
data.total | integer |
total |
List of departments
List of departments
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Fuzzy query parameter
|
q | string |
Fuzzy query parameter |
|
|
Current page number
|
current | integer |
Current page number |
|
|
The number of pages
|
size | integer |
The number of pages |
|
|
Department status filtering
|
status | string |
Department status filtering |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
code
|
code | integer |
code |
|
message
|
message | string |
message |
|
size
|
data.size | integer |
size |
|
current
|
data.current | integer |
current |
|
records
|
data.records | array of object |
records |
|
id
|
data.records.id | string |
id |
|
name
|
data.records.name | string |
name |
|
departmentCode
|
data.records.departmentCode | string |
departmentCode |
|
attendCalculationId
|
data.records.attendCalculationId | string |
attendCalculationId |
|
parentId
|
data.records.parentId | string |
parentId |
|
status
|
data.records.status | string |
status |
|
id
|
data.records.officeLocation.id | string |
id |
|
name
|
data.records.officeLocation.name | string |
name |
|
address
|
data.records.officeLocation.address | string |
address |
|
longitude
|
data.records.officeLocation.longitude | float |
longitude |
|
latitude
|
data.records.officeLocation.latitude | float |
latitude |
|
region
|
data.records.officeLocation.region | integer |
region |
|
isEnableGps
|
data.records.officeLocation.isEnableGps | boolean |
isEnableGps |
|
isEnableBluetooth
|
data.records.officeLocation.isEnableBluetooth | boolean |
isEnableBluetooth |
|
tenantId
|
data.records.officeLocation.tenantId | string |
tenantId |
|
deleted
|
data.records.officeLocation.deleted | integer |
deleted |
|
attendanceAddressCode
|
data.records.officeLocation.attendanceAddressCode | string |
attendanceAddressCode |
|
status
|
data.records.officeLocation.status | string |
status |
|
areaType
|
data.records.officeLocation.areaType | string |
areaType |
|
mapType
|
data.records.officeLocation.mapType | string |
mapType |
|
longitudeBaidu
|
data.records.officeLocation.longitudeBaidu | float |
longitudeBaidu |
|
latitudeBaidu
|
data.records.officeLocation.latitudeBaidu | float |
latitudeBaidu |
|
longitudeGaode
|
data.records.officeLocation.longitudeGaode | float |
longitudeGaode |
|
latitudeGaode
|
data.records.officeLocation.latitudeGaode | float |
latitudeGaode |
|
areaCode
|
data.records.officeLocation.areaCode | string |
areaCode |
|
createBy
|
data.records.officeLocation.createBy | string |
createBy |
|
createTime
|
data.records.officeLocation.createTime | string |
createTime |
|
updateBy
|
data.records.officeLocation.updateBy | string |
updateBy |
|
updateTime
|
data.records.officeLocation.updateTime | string |
updateTime |
|
isExists
|
data.records.officeLocation.isExists | string |
isExists |
|
parentName
|
data.records.parentName | string |
parentName |
|
pages
|
data.pages | integer |
pages |
|
total
|
data.total | integer |
total |
List of employees
List of employees
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Fuzzy query parameter
|
q | string |
Fuzzy query parameter |
|
|
Current page number
|
current | integer |
Current page number |
|
|
The number of pages
|
size | integer |
The number of pages |
|
|
Employee status filtering
|
status | string |
Employee status filtering |
|
|
Department ID filtering
|
departmentId | string |
Department ID filtering |
|
|
Position ID filtering
|
positionId | string |
Position ID filtering |
|
|
Work Location ID filtering
|
attendCalculationId | string |
Work Location ID filtering |
|
|
Employment type filtering
|
hireType | string |
Employment type filtering |
|
|
Salary calculation method filtering
|
calculateSalaryType | string |
Salary calculation method filtering |
|
|
Holiday rules ID filtering
|
regularType | string |
Holiday rules ID filtering |
|
|
Cost Center ID filtering
|
costCenterId | string |
Cost Center ID filtering |
|
|
Salary rule ID filtering
|
payrollRegulationId | string |
Salary rule ID filtering |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
code
|
code | integer |
code |
|
message
|
message | string |
message |
|
size
|
data.size | integer |
size |
|
current
|
data.current | integer |
current |
|
records
|
data.records | array of object |
records |
|
id
|
data.records.id | string |
id |
|
englishName
|
data.records.englishName | string |
englishName |
|
chineseName
|
data.records.chineseName | string |
chineseName |
|
email
|
data.records.email | string |
|
|
countryCode
|
data.records.countryCode | string |
countryCode |
|
phone
|
data.records.phone | string |
phone |
|
sex
|
data.records.sex | string |
sex |
|
address
|
data.records.address | string |
address |
|
code
|
data.records.code | string |
code |
|
identityCard
|
data.records.identityCard | string |
identityCard |
|
bankCard
|
data.records.bankCard | string |
bankCard |
|
status
|
data.records.status | integer |
status |
|
flag
|
data.records.flag | integer |
flag |
|
score
|
data.records.score | float |
score |
|
expectedArea
|
data.records.expectedArea | string |
expectedArea |
|
nickName
|
data.records.nickName | string |
nickName |
|
position
|
data.records.position | string |
position |
|
arrivalDate
|
data.records.arrivalDate | string |
arrivalDate |
|
salary
|
data.records.salary | integer |
salary |
|
education
|
data.records.education | string |
education |
|
comApplication
|
data.records.comApplication | string |
comApplication |
|
otherApplication
|
data.records.otherApplication | string |
otherApplication |
|
chineseTyping
|
data.records.chineseTyping | string |
chineseTyping |
|
chineseOther
|
data.records.chineseOther | string |
chineseOther |
|
englishTyping
|
data.records.englishTyping | string |
englishTyping |
|
chineseWpm
|
data.records.chineseWpm | integer |
chineseWpm |
|
englishWpm
|
data.records.englishWpm | integer |
englishWpm |
|
cantonese
|
data.records.cantonese | string |
cantonese |
|
english
|
data.records.english | string |
english |
|
mandarin
|
data.records.mandarin | string |
mandarin |
|
otherLanguage
|
data.records.otherLanguage | string |
otherLanguage |
|
consultantName
|
data.records.consultantName | string |
consultantName |
|
consultantPhone
|
data.records.consultantPhone | string |
consultantPhone |
|
consultantCompany
|
data.records.consultantCompany | string |
consultantCompany |
|
consultantPosition
|
data.records.consultantPosition | string |
consultantPosition |
|
birthday
|
data.records.birthday | string |
birthday |
|
accountNumber
|
data.records.accountNumber | string |
accountNumber |
|
departmentId
|
data.records.departmentId | string |
departmentId |
|
positionId
|
data.records.positionId | string |
positionId |
|
entryDate
|
data.records.entryDate | string |
entryDate |
|
directSupervisorId
|
data.records.directSupervisorId | string |
directSupervisorId |
|
attendCalculationId
|
data.records.attendCalculationId | string |
attendCalculationId |
|
hireType
|
data.records.hireType | string |
hireType |
|
basicPay
|
data.records.basicPay | double |
basicPay |
|
calculateSalaryType
|
data.records.calculateSalaryType | string |
calculateSalaryType |
|
takeEffectDate
|
data.records.takeEffectDate | string |
takeEffectDate |
|
nationality
|
data.records.nationality | string |
nationality |
|
maritalStatus
|
data.records.maritalStatus | string |
maritalStatus |
|
emergencyContactName
|
data.records.emergencyContactName | string |
emergencyContactName |
|
emergencyContactRelation
|
data.records.emergencyContactRelation | string |
emergencyContactRelation |
|
emergencyContactPhone
|
data.records.emergencyContactPhone | string |
emergencyContactPhone |
|
bankName
|
data.records.bankName | string |
bankName |
|
bankBranchNumber
|
data.records.bankBranchNumber | string |
bankBranchNumber |
|
bankAccountNo
|
data.records.bankAccountNo | string |
bankAccountNo |
|
lastWorkingDate
|
data.records.lastWorkingDate | string |
lastWorkingDate |
|
bankCode
|
data.records.bankCode | string |
bankCode |
|
remark
|
data.records.remark | string |
remark |
|
regionCode
|
data.records.regionCode | string |
regionCode |
|
regularType
|
data.records.regularType | string |
regularType |
|
costCenterId
|
data.records.costCenterId | string |
costCenterId |
|
payrollRegulationId
|
data.records.payrollRegulationId | string |
payrollRegulationId |
|
surname
|
data.records.surname | string |
surname |
|
surnameEnglish
|
data.records.surnameEnglish | string |
surnameEnglish |
|
personalName
|
data.records.personalName | string |
personalName |
|
personalNameEnglish
|
data.records.personalNameEnglish | string |
personalNameEnglish |
|
identityCardHk
|
data.records.identityCardHk | string |
identityCardHk |
|
passportNumber
|
data.records.passportNumber | string |
passportNumber |
|
passportIssuingPlace
|
data.records.passportIssuingPlace | string |
passportIssuingPlace |
|
spouseName
|
data.records.spouseName | string |
spouseName |
|
spouseIdentityCardHk
|
data.records.spouseIdentityCardHk | string |
spouseIdentityCardHk |
|
spousePassportNumber
|
data.records.spousePassportNumber | string |
spousePassportNumber |
|
spousePassportIssuingPlace
|
data.records.spousePassportIssuingPlace | string |
spousePassportIssuingPlace |
|
postalAddress
|
data.records.postalAddress | string |
postalAddress |
|
employerName
|
data.records.employerName | string |
employerName |
|
reasonsLeave
|
data.records.reasonsLeave | string |
reasonsLeave |
|
isForDeparture
|
data.records.isForDeparture | string |
isForDeparture |
|
hometown
|
data.records.hometown | string |
hometown |
|
nation
|
data.records.nation | string |
nation |
|
politicalStatus
|
data.records.politicalStatus | string |
politicalStatus |
|
highestEducation
|
data.records.highestEducation | string |
highestEducation |
|
workDate
|
data.records.workDate | string |
workDate |
|
confirmationDate
|
data.records.confirmationDate | string |
confirmationDate |
|
probation
|
data.records.probation | string |
probation |
|
isDisabled
|
data.records.isDisabled | boolean |
isDisabled |
|
isForeignNationality
|
data.records.isForeignNationality | boolean |
isForeignNationality |
|
domicileLocation
|
data.records.domicileLocation | string |
domicileLocation |
|
certificateType
|
data.records.certificateType | string |
certificateType |
|
certificateNumber
|
data.records.certificateNumber | string |
certificateNumber |
|
isMartyrDependents
|
data.records.isMartyrDependents | boolean |
isMartyrDependents |
|
occupationTaxNumber
|
data.records.occupationTaxNumber | string |
occupationTaxNumber |
|
nonLocalBlueCardNumber
|
data.records.nonLocalBlueCardNumber | string |
nonLocalBlueCardNumber |
|
isForeignEmployees
|
data.records.isForeignEmployees | boolean |
isForeignEmployees |
|
weeklyLeaveWorkAgreement
|
data.records.weeklyLeaveWorkAgreement | string |
weeklyLeaveWorkAgreement |
|
employeeType
|
data.records.employeeType | string |
employeeType |
|
jobLevel
|
data.records.jobLevel | string |
jobLevel |
|
post
|
data.records.post | string |
post |
|
salaryScale
|
data.records.salaryScale | string |
salaryScale |
|
jobTitle
|
data.records.jobTitle | string |
jobTitle |
|
recruitmentSource
|
data.records.recruitmentSource | string |
recruitmentSource |
|
graduatedSchool
|
data.records.graduatedSchool | string |
graduatedSchool |
|
profession
|
data.records.profession | string |
profession |
|
termsOfWork
|
data.records.termsOfWork | string |
termsOfWork |
|
totalHours
|
data.records.totalHours | float |
totalHours |
|
payrollPackageFte
|
data.records.payrollPackageFte | float |
payrollPackageFte |
|
payrollPackageProData
|
data.records.payrollPackageProData | float |
payrollPackageProData |
|
hourlyWagePercent
|
data.records.hourlyWagePercent | float |
hourlyWagePercent |
|
terminationCompensationDate
|
data.records.terminationCompensationDate | string |
terminationCompensationDate |
|
terminationEmployedLength
|
data.records.terminationEmployedLength | float |
terminationEmployedLength |
|
ageOfTermination
|
data.records.ageOfTermination | integer |
ageOfTermination |
|
appellation
|
data.records.appellation | string |
appellation |
|
middleName
|
data.records.middleName | string |
middleName |
|
homePhone
|
data.records.homePhone | string |
homePhone |
|
officePhone
|
data.records.officePhone | string |
officePhone |
|
country
|
data.records.country | string |
country |
|
province
|
data.records.province | string |
province |
|
city
|
data.records.city | string |
city |
|
postcode
|
data.records.postcode | string |
postcode |
|
address1
|
data.records.address1 | string |
address1 |
|
address2
|
data.records.address2 | string |
address2 |
|
contractEndDate
|
data.records.contractEndDate | string |
contractEndDate |
|
taxIdentity
|
data.records.taxIdentity | string |
taxIdentity |
|
otherIncomeName
|
data.records.otherIncomeName | string |
otherIncomeName |
|
mobileCardCalType
|
data.records.mobileCardCalType | string |
mobileCardCalType |
|
date1
|
data.records.date1 | string |
date1 |
|
date2
|
data.records.date2 | string |
date2 |
|
date3
|
data.records.date3 | string |
date3 |
|
date4
|
data.records.date4 | string |
date4 |
|
text1
|
data.records.text1 | string |
text1 |
|
text2
|
data.records.text2 | string |
text2 |
|
text3
|
data.records.text3 | string |
text3 |
|
text4
|
data.records.text4 | string |
text4 |
|
text5
|
data.records.text5 | string |
text5 |
|
text6
|
data.records.text6 | string |
text6 |
|
majorWorkLocationId
|
data.records.majorWorkLocationId | string |
majorWorkLocationId |
|
whetherResidence
|
data.records.whetherResidence | string |
whetherResidence |
|
award
|
data.records.award | string |
award |
|
employeeRateType
|
data.records.employeeRateType | string |
employeeRateType |
|
classification
|
data.records.classification | string |
classification |
|
payrollTemplateId
|
data.records.payrollTemplateId | string |
payrollTemplateId |
|
beneficiaryType
|
data.records.beneficiaryType | string |
beneficiaryType |
|
exemptionMedicalInsuranceTax
|
data.records.exemptionMedicalInsuranceTax | string |
exemptionMedicalInsuranceTax |
|
payrollRegulationName
|
data.records.payrollRegulationName | string |
payrollRegulationName |
|
directSupervisorEnglishName
|
data.records.directSupervisorEnglishName | string |
directSupervisorEnglishName |
|
calculateSalaryTypeText
|
data.records.calculateSalaryTypeText | string |
calculateSalaryTypeText |
|
isRequirementsThreshold
|
data.records.isRequirementsThreshold | string |
isRequirementsThreshold |
|
majorWorkLocationName
|
data.records.majorWorkLocationName | string |
majorWorkLocationName |
|
hireTypeText
|
data.records.hireTypeText | string |
hireTypeText |
|
termsOfWorkName
|
data.records.termsOfWorkName | string |
termsOfWorkName |
|
regularTypeName
|
data.records.regularTypeName | string |
regularTypeName |
|
positionName
|
data.records.positionName | string |
positionName |
|
departmentName
|
data.records.departmentName | string |
departmentName |
|
costCenterName
|
data.records.costCenterName | string |
costCenterName |
|
isSupportingAccount
|
data.records.isSupportingAccount | string |
isSupportingAccount |
|
taxpayerStatus
|
data.records.taxpayerStatus | string |
taxpayerStatus |
|
insurePlanName
|
data.records.insurePlanName | string |
insurePlanName |
|
age
|
data.records.age | string |
age |
|
workHours
|
data.records.workHours | float |
workHours |
|
tfnSignDate
|
data.records.tfnSignDate | string |
tfnSignDate |
|
taxNumber
|
data.records.taxNumber | string |
taxNumber |
|
pages
|
data.pages | integer |
pages |
|
total
|
data.total | integer |
total |
List of external payroll
List of external payroll
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
fuzzy query parameter
|
q | string |
fuzzy query parameter |
|
|
current page
|
current | integer |
current page |
|
|
page size
|
size | integer |
page size |
|
|
code
|
code | string |
code |
|
|
employee id
|
employeeId | string |
employee id |
|
|
employee code
|
employeeCode | string |
employee code |
|
|
employee name
|
employeeName | string |
employee name |
|
|
business salary item id
|
businessSalaryItemId | string |
business salary item id |
|
|
occurrence date
|
occurrenceDate | string |
occurrence date |
|
|
expiration date
|
expirationDate | string |
expiration date |
|
|
employee id filter
|
employeeIdFilter | string |
employee id filter |
|
|
business salary item filter
|
businessSalaryItemFilter | string |
business salary item filter |
|
|
money filter
|
moneyFilter | string |
money filter |
|
|
occurrence date filter
|
occurrenceDateFilter | string |
occurrence date filter |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
code
|
code | integer |
code |
|
message
|
message | string |
message |
|
size
|
data.size | integer |
size |
|
current
|
data.current | integer |
current |
|
records
|
data.records | array of object |
records |
|
id
|
data.records.id | string |
id |
|
code
|
data.records.code | string |
code |
|
employeeId
|
data.records.employeeId | string |
employeeId |
|
employeeCode
|
data.records.employeeCode | string |
employeeCode |
|
employeeName
|
data.records.employeeName | string |
employeeName |
|
employeePositionName
|
data.records.employeePositionName | string |
employeePositionName |
|
calculateSalaryType
|
data.records.calculateSalaryType | string |
calculateSalaryType |
|
businessSalaryItemId
|
data.records.businessSalaryItemId | string |
businessSalaryItemId |
|
businessSalaryItemName
|
data.records.businessSalaryItemName | string |
businessSalaryItemName |
|
money
|
data.records.money | double |
money |
|
occurrenceDate
|
data.records.occurrenceDate | string |
occurrenceDate |
|
payType
|
data.records.payType | string |
payType |
|
remark
|
data.records.remark | string |
remark |
|
expirationDate
|
data.records.expirationDate | string |
expirationDate |
|
pages
|
data.pages | integer |
pages |
|
total
|
data.total | integer |
total |
List of external payroll items
List of external payroll items
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
fuzzy query parameter
|
q | string |
fuzzy query parameter |
|
|
current
|
current | integer |
current |
|
|
size
|
size | integer |
size |
|
|
custom item type ids
|
customItemTypeId | string |
custom item type ids |
|
|
name
|
name | string |
name |
|
|
payment type
|
paymentType | string |
payment type |
|
|
status
|
status | string |
status |
|
|
carry rule
|
carryRule | string |
carry rule |
|
|
decimal digits
|
decimalDigits | integer |
decimal digits |
|
|
formula alias
|
formulaAlias | string |
formula alias |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
code
|
code | integer |
code |
|
message
|
message | string |
message |
|
size
|
data.size | integer |
size |
|
current
|
data.current | integer |
current |
|
records
|
data.records | array of object |
records |
|
id
|
data.records.id | string |
id |
|
customItemTypeId
|
data.records.customItemTypeId | string |
customItemTypeId |
|
name
|
data.records.name | string |
name |
|
paymentType
|
data.records.paymentType | string |
paymentType |
|
status
|
data.records.status | string |
status |
|
carryRule
|
data.records.carryRule | string |
carryRule |
|
decimalDigits
|
data.records.decimalDigits | integer |
decimalDigits |
|
formulaAlias
|
data.records.formulaAlias | string |
formulaAlias |
|
pages
|
data.pages | integer |
pages |
|
total
|
data.total | integer |
total |
List of fixed Payroll items
List of fixed Payroll items
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
fuzzy query parameter
|
q | string |
fuzzy query parameter |
|
|
current page
|
current | integer |
current page |
|
|
size
|
size | integer |
size |
|
|
employeeId
|
employeeId | string |
employeeId |
|
|
payrollItemId
|
payrollItemId | string |
payrollItemId |
|
|
start date
|
startDate | string |
start date |
|
|
end date
|
endDate | string |
end date |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
code
|
code | integer |
code |
|
message
|
message | string |
message |
|
size
|
data.size | integer |
size |
|
current
|
data.current | integer |
current |
|
records
|
data.records | array of object |
records |
|
id
|
data.records.id | string |
id |
|
employeeId
|
data.records.employeeId | string |
employeeId |
|
payrollItemId
|
data.records.payrollItemId | string |
payrollItemId |
|
money
|
data.records.money | double |
money |
|
payrollItemName
|
data.records.payrollItemName | string |
payrollItemName |
|
paymentType
|
data.records.paymentType | string |
paymentType |
|
startDate
|
data.records.startDate | string |
startDate |
|
endDate
|
data.records.endDate | string |
endDate |
|
totalLimitAmount
|
data.records.totalLimitAmount | double |
totalLimitAmount |
|
paidAmount
|
data.records.paidAmount | double |
paidAmount |
|
surplusAmount
|
data.records.surplusAmount | double |
surplusAmount |
|
pages
|
data.pages | integer |
pages |
|
total
|
data.total | integer |
total |
List of job positions
List of job positions
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
position fuzzy query parameter
|
q | string |
position fuzzy query parameter |
|
|
current
|
current | integer |
current |
|
|
size
|
size | integer |
size |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
code
|
code | integer |
code |
|
message
|
message | string |
message |
|
size
|
data.size | integer |
size |
|
current
|
data.current | integer |
current |
|
records
|
data.records | array of object |
records |
|
id
|
data.records.id | string |
id |
|
name
|
data.records.name | string |
name |
|
positionCode
|
data.records.positionCode | string |
positionCode |
|
status
|
data.records.status | string |
status |
|
pages
|
data.pages | integer |
pages |
|
total
|
data.total | integer |
total |
List of labels
List of labels
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
fuzzy search
|
q | string |
fuzzy search |
|
|
current page
|
current | integer |
current page |
|
|
page size
|
size | integer |
page size |
|
|
labelCode
|
labelCode | string |
labelCode |
|
|
labelName
|
labelName | string |
labelName |
|
|
labelStatus
|
labelStatus | integer |
labelStatus |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
code
|
code | integer |
code |
|
message
|
message | string |
message |
|
size
|
data.size | integer |
size |
|
current
|
data.current | integer |
current |
|
records
|
data.records | array of object |
records |
|
id
|
data.records.id | string |
id |
|
labelCode
|
data.records.labelCode | string |
labelCode |
|
labelName
|
data.records.labelName | string |
labelName |
|
labelStatus
|
data.records.labelStatus | integer |
labelStatus |
|
pages
|
data.pages | integer |
pages |
|
total
|
data.total | integer |
total |
List of leave applications
List of leave applications
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Fuzzy query parameter
|
q | string |
Fuzzy query parameter |
|
|
Current page number
|
current | integer |
Current page number |
|
|
The number of pages
|
size | integer |
The number of pages |
|
|
Employee ID filtering
|
employeeId | string |
Employee ID filtering |
|
|
Holiday application type filtering
|
holidayType | string |
Holiday application type filtering |
|
|
Holiday application status filtering
|
status | string |
Holiday application status filtering |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
code
|
code | integer |
code |
|
message
|
message | string |
message |
|
size
|
data.size | integer |
size |
|
current
|
data.current | integer |
current |
|
records
|
data.records | array of object |
records |
|
id
|
data.records.id | string |
id |
|
employeeId
|
data.records.employeeId | string |
employeeId |
|
holidayType
|
data.records.holidayType | string |
holidayType |
|
startDate
|
data.records.startDate | string |
startDate |
|
startTime
|
data.records.startTime | string |
startTime |
|
endDate
|
data.records.endDate | string |
endDate |
|
endTime
|
data.records.endTime | string |
endTime |
|
leaveTime
|
data.records.leaveTime | float |
leaveTime |
|
timeType
|
data.records.timeType | string |
timeType |
|
remark
|
data.records.remark | string |
remark |
|
status
|
data.records.status | string |
status |
|
holidayDate
|
data.records.holidayDate | string |
holidayDate |
|
time
|
data.records.time | string |
time |
|
isHrProcessing
|
data.records.isHrProcessing | boolean |
isHrProcessing |
|
finalApprover
|
data.records.finalApprover | string |
finalApprover |
|
finalApprovalTime
|
data.records.finalApprovalTime | string |
finalApprovalTime |
|
finalApproverName
|
data.records.finalApproverName | string |
finalApproverName |
|
holidayTypeName
|
data.records.holidayTypeName | string |
holidayTypeName |
|
englishName
|
data.records.englishName | string |
englishName |
|
pages
|
data.pages | integer |
pages |
|
total
|
data.total | integer |
total |
List of non-fixed salary items
List of non-fixed salary items
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
fuzzy search
|
q | string |
fuzzy search |
|
|
current page
|
current | integer |
current page |
|
|
page size
|
size | integer |
page size |
|
|
employeeId
|
employeeId | string |
employeeId |
|
|
payrollItemId
|
payrollItemId | string |
payrollItemId |
|
|
paymentType
|
paymentType | string |
paymentType |
|
|
payrollDate
|
payrollDate | string |
payrollDate |
|
|
employeeIdFilter
|
employeeIdFilter | string |
employeeIdFilter |
|
|
payrollDateFilter
|
payrollDateFilter | string |
payrollDateFilter |
|
|
moneyFilter
|
moneyFilter | string |
moneyFilter |
|
|
payrollItemIdFilter
|
payrollItemIdFilter | string |
payrollItemIdFilter |
|
|
payrollPlanId
|
payrollPlanId | string |
payrollPlanId |
|
|
dataType
|
dataType | string |
dataType |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
code
|
code | integer |
code |
|
message
|
message | string |
message |
|
size
|
data.size | integer |
size |
|
current
|
data.current | integer |
current |
|
records
|
data.records | array of object |
records |
|
id
|
data.records.id | string |
id |
|
employeeId
|
data.records.employeeId | string |
employeeId |
|
payrollItemId
|
data.records.payrollItemId | string |
payrollItemId |
|
money
|
data.records.money | double |
money |
|
paymentType
|
data.records.paymentType | string |
paymentType |
|
payrollDate
|
data.records.payrollDate | string |
payrollDate |
|
remark
|
data.records.remark | string |
remark |
|
headFile
|
data.records.headFile | string |
headFile |
|
code
|
data.records.code | string |
code |
|
englishName
|
data.records.englishName | string |
englishName |
|
chineseName
|
data.records.chineseName | string |
chineseName |
|
positionName
|
data.records.positionName | string |
positionName |
|
payrollItemName
|
data.records.payrollItemName | string |
payrollItemName |
|
costCenterName
|
data.records.costCenterName | string |
costCenterName |
|
calculateSalaryType
|
data.records.calculateSalaryType | string |
calculateSalaryType |
|
payrollPlanId
|
data.records.payrollPlanId | string |
payrollPlanId |
|
dataType
|
data.records.dataType | string |
dataType |
|
payrollPlanName
|
data.records.payrollPlanName | string |
payrollPlanName |
|
pages
|
data.pages | integer |
pages |
|
total
|
data.total | integer |
total |
List of office locations
List of office locations
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
fuzzy query parameter
|
q | string |
fuzzy query parameter |
|
|
Current page number
|
current | integer |
Current page number |
|
|
The number of pages
|
size | integer |
The number of pages |
|
|
Check in range filtering
|
region | string |
Check in range filtering |
|
|
Work location number filtering
|
attendanceAddressCode | string |
Work location number filtering |
|
|
Work location status filtering
|
status | string |
Work location status filtering |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
code
|
code | integer |
code |
|
message
|
message | string |
message |
|
size
|
data.size | integer |
size |
|
current
|
data.current | integer |
current |
|
records
|
data.records | array of object |
records |
|
id
|
data.records.id | string |
id |
|
name
|
data.records.name | string |
name |
|
address
|
data.records.address | string |
address |
|
longitude
|
data.records.longitude | float |
longitude |
|
latitude
|
data.records.latitude | float |
latitude |
|
region
|
data.records.region | integer |
region |
|
isEnableGps
|
data.records.isEnableGps | boolean |
isEnableGps |
|
isEnableBluetooth
|
data.records.isEnableBluetooth | boolean |
isEnableBluetooth |
|
attendanceAddressCode
|
data.records.attendanceAddressCode | string |
attendanceAddressCode |
|
status
|
data.records.status | string |
status |
|
areaType
|
data.records.areaType | string |
areaType |
|
mapType
|
data.records.mapType | string |
mapType |
|
longitudeBaidu
|
data.records.longitudeBaidu | float |
longitudeBaidu |
|
latitudeBaidu
|
data.records.latitudeBaidu | float |
latitudeBaidu |
|
longitudeGaode
|
data.records.longitudeGaode | float |
longitudeGaode |
|
latitudeGaode
|
data.records.latitudeGaode | float |
latitudeGaode |
|
areaCode
|
data.records.areaCode | string |
areaCode |
|
pages
|
data.pages | integer |
pages |
|
total
|
data.total | integer |
total |
List of payroll Items
List of payroll Items
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
fuzzy query parameter
|
q | string |
fuzzy query parameter |
|
|
current
|
current | integer |
current |
|
|
size
|
size | integer |
size |
|
|
payment type parameter
|
paymentTypeFilter | string |
payment type parameter |
|
|
payment type id parameter
|
payrollItemTypeIdFilter | string |
payment type id parameter |
|
|
pay item status
|
statusFilter | string |
pay item status |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
code
|
code | integer |
code |
|
message
|
message | string |
message |
|
size
|
data.size | integer |
size |
|
current
|
data.current | integer |
current |
|
records
|
data.records | array of object |
records |
|
id
|
data.records.id | string |
id |
|
payrollItemTypeId
|
data.records.payrollItemTypeId | string |
payrollItemTypeId |
|
name
|
data.records.name | string |
name |
|
paymentType
|
data.records.paymentType | string |
paymentType |
|
status
|
data.records.status | string |
status |
|
carryRule
|
data.records.carryRule | string |
carryRule |
|
decimalDigits
|
data.records.decimalDigits | float |
decimalDigits |
|
taxIncomeId
|
data.records.taxIncomeId | string |
taxIncomeId |
|
socialSecurityIncomeId
|
data.records.socialSecurityIncomeId | string |
socialSecurityIncomeId |
|
averagePayrollIncomeId
|
data.records.averagePayrollIncomeId | string |
averagePayrollIncomeId |
|
isBuildIn
|
data.records.isBuildIn | string |
isBuildIn |
|
payrollItemDefaultId
|
data.records.payrollItemDefaultId | string |
payrollItemDefaultId |
|
sequence
|
data.records.sequence | integer |
sequence |
|
isExistRegulationRules
|
data.records.isExistRegulationRules | boolean |
isExistRegulationRules |
|
regulationRules
|
data.records.regulationRules | string |
regulationRules |
|
step
|
data.records.step | integer |
step |
|
payrollRegulationIdSet
|
data.records.payrollRegulationIdSet | string |
payrollRegulationIdSet |
|
calculationOrder
|
data.records.calculationOrder | string |
calculationOrder |
|
regulationRulesAlias
|
data.records.regulationRulesAlias | string |
regulationRulesAlias |
|
limitRules
|
data.records.limitRules | string |
limitRules |
|
salaryElement
|
data.records.salaryElement | string |
salaryElement |
|
hours
|
data.records.hours | string |
hours |
|
ratio
|
data.records.ratio | string |
ratio |
|
payrollItemTypeName
|
data.records.payrollItemTypeName | string |
payrollItemTypeName |
|
pages
|
data.pages | integer |
pages |
|
total
|
data.total | integer |
total |
List of payroll plan
List of payroll plan
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
fuzzy query parameter
|
q | string |
fuzzy query parameter |
|
|
current
|
current | True | integer |
current |
|
size
|
size | integer |
size |
|
|
payroll plan status
|
status | True | string |
payroll plan status |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
code
|
code | string |
code |
|
message
|
message | string |
message |
|
size
|
data.size | integer |
size |
|
current
|
data.current | integer |
current |
|
records
|
data.records | array of object |
records |
|
id
|
data.records.id | string |
id |
|
name
|
data.records.name | string |
name |
|
payrollRegulationId
|
data.records.payrollRegulationId | string |
payrollRegulationId |
|
year
|
data.records.year | string |
year |
|
month
|
data.records.month | string |
month |
|
periodStartDate
|
data.records.periodStartDate | string |
periodStartDate |
|
periodEndDate
|
data.records.periodEndDate | string |
periodEndDate |
|
degree
|
data.records.degree | string |
degree |
|
population
|
data.records.population | integer |
population |
|
actualSalary
|
data.records.actualSalary | float |
actualSalary |
|
payrollDate
|
data.records.payrollDate | string |
payrollDate |
|
type
|
data.records.type | string |
type |
|
remark
|
data.records.remark | string |
remark |
|
attendCalculationStartDate
|
data.records.attendCalculationStartDate | string |
attendCalculationStartDate |
|
attendCalculationEndDate
|
data.records.attendCalculationEndDate | string |
attendCalculationEndDate |
|
timeDefinedFlag
|
data.records.timeDefinedFlag | integer |
timeDefinedFlag |
|
status
|
data.records.status | string |
status |
|
isIncludeBasicSalary
|
data.records.isIncludeBasicSalary | integer |
isIncludeBasicSalary |
|
isIncludeNonFixedSalary
|
data.records.isIncludeNonFixedSalary | integer |
isIncludeNonFixedSalary |
|
isIncludeAttendCalculation
|
data.records.isIncludeAttendCalculation | integer |
isIncludeAttendCalculation |
|
isIncludeLeaveSalary
|
data.records.isIncludeLeaveSalary | integer |
isIncludeLeaveSalary |
|
isIncludeFixedSalary
|
data.records.isIncludeFixedSalary | integer |
isIncludeFixedSalary |
|
paymentType
|
data.records.paymentType | string |
paymentType |
|
period
|
data.records.period | string |
period |
|
step
|
data.records.step | integer |
step |
|
isAutoLoadStaff
|
data.records.isAutoLoadStaff | integer |
isAutoLoadStaff |
|
temporaryOperationName
|
data.records.temporaryOperationName | string |
temporaryOperationName |
|
employeeScopeType
|
data.records.employeeScopeType | string |
employeeScopeType |
|
degreeStr
|
data.records.degreeStr | string |
degreeStr |
|
payrollTimeType
|
data.records.payrollTimeType | string |
payrollTimeType |
|
pages
|
data.pages | integer |
pages |
|
total
|
data.total | integer |
total |
List of reimbursements
List of reimbursements
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
fuzzy query parameter
|
q | string |
fuzzy query parameter |
|
|
current
|
current | integer |
current |
|
|
size
|
size | integer |
size |
|
|
employee ids
|
employeeIdFilter | string |
employee ids |
|
|
date of apply
|
dateFilter | string |
date of apply |
|
|
amount of apply
|
amountFilter | string |
amount of apply |
|
|
reimbursement status
|
reimbursementStatusFilter | string |
reimbursement status |
|
|
reimbursement name
|
reimbursementName | string |
reimbursement name |
|
|
deleted status
|
deleted | string |
deleted status |
|
|
department id
|
departmentFilter | integer |
department id |
|
|
status
|
statusFilter | string |
status |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
code
|
code | string |
code |
|
message
|
message | string |
message |
|
size
|
data.size | integer |
size |
|
current
|
data.current | integer |
current |
|
records
|
data.records | array of object |
records |
|
id
|
data.records.id | string |
id |
|
employeeId
|
data.records.employeeId | string |
employeeId |
|
code
|
data.records.code | string |
code |
|
type
|
data.records.type | string |
type |
|
reimbursementType
|
data.records.reimbursementType | string |
reimbursementType |
|
reimbursementTypeName
|
data.records.reimbursementTypeName | string |
reimbursementTypeName |
|
reimbursementDate
|
data.records.reimbursementDate | string |
reimbursementDate |
|
reimbursementName
|
data.records.reimbursementName | string |
reimbursementName |
|
reimbursementCode
|
data.records.reimbursementCode | string |
reimbursementCode |
|
amount
|
data.records.amount | float |
amount |
|
remark
|
data.records.remark | string |
remark |
|
status
|
data.records.status | string |
status |
|
isHrProcessing
|
data.records.isHrProcessing | boolean |
isHrProcessing |
|
finalApprover
|
data.records.finalApprover | string |
finalApprover |
|
finalApprovalTime
|
data.records.finalApprovalTime | string |
finalApprovalTime |
|
finalApproverName
|
data.records.finalApproverName | string |
finalApproverName |
|
englishName
|
data.records.englishName | string |
englishName |
|
chineseName
|
data.records.chineseName | string |
chineseName |
|
reason
|
data.records.reason | string |
reason |
|
employeeCode
|
data.records.employeeCode | string |
employeeCode |
|
departmentName
|
data.records.departmentName | string |
departmentName |
|
positionName
|
data.records.positionName | string |
positionName |
|
pages
|
data.pages | integer |
pages |
|
total
|
data.total | integer |
total |
List of schedules
List of schedules
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
fuzzy query parameter for employee info
|
q | string |
fuzzy query parameter for employee info |
|
|
current
|
current | integer |
current |
|
|
size
|
size | integer |
size |
|
|
endDate
|
endDate | True | string |
endDate |
|
startDate
|
startDate | True | string |
startDate |
|
departmentId
|
departmentId | string |
departmentId |
|
|
positionId
|
positionId | string |
positionId |
|
|
labelIds
|
bizLabelIds | string |
labelIds |
|
|
attendance address id
|
attendCalculationId | string |
attendance address id |
|
|
employee status
|
statusFilter | string |
employee status |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
code
|
code | integer |
code |
|
message
|
message | string |
message |
|
data
|
data | array of object |
data |
|
id
|
data.id | string |
id |
|
employeeId
|
data.employeeId | string |
employeeId |
|
positionName
|
data.positionName | string |
positionName |
|
departmentName
|
data.departmentName | string |
departmentName |
|
employeeEnglishName
|
data.employeeEnglishName | string |
employeeEnglishName |
|
employeeCode
|
data.employeeCode | string |
employeeCode |
|
attendDay
|
data.attendDay | string |
attendDay |
|
shiftTemplateId
|
data.shiftTemplateId | string |
shiftTemplateId |
|
shiftTemplateName
|
data.shiftTemplateName | string |
shiftTemplateName |
|
shiftIn
|
data.shiftIn | string |
shiftIn |
|
shiftOff
|
data.shiftOff | string |
shiftOff |
|
lateStart
|
data.lateStart | integer |
lateStart |
|
earlyStart
|
data.earlyStart | integer |
earlyStart |
|
earliestCard
|
data.earliestCard | string |
earliestCard |
|
lateCard
|
data.lateCard | string |
lateCard |
|
actualIn
|
data.actualIn | string |
actualIn |
|
actualOff
|
data.actualOff | string |
actualOff |
|
beLateLength
|
data.beLateLength | float |
beLateLength |
|
leaveEarlyLength
|
data.leaveEarlyLength | float |
leaveEarlyLength |
|
shiftLabor
|
data.shiftLabor | float |
shiftLabor |
|
scheduleConflict
|
data.scheduleConflict | string |
scheduleConflict |
|
laborLength
|
data.laborLength | float |
laborLength |
|
attendStatus
|
data.attendStatus | string |
attendStatus |
|
mealTime
|
data.mealTime | integer |
mealTime |
|
shiftStatus
|
data.shiftStatus | string |
shiftStatus |
|
acrossTheNight
|
data.acrossTheNight | string |
acrossTheNight |
|
deleted
|
data.deleted | integer |
deleted |
|
remark
|
data.remark | string |
remark |
|
isLeave
|
data.isLeave | integer |
isLeave |
|
scheduleInfo
|
data.scheduleInfo | string |
scheduleInfo |
|
attendanceItemId
|
data.attendanceItemId | string |
attendanceItemId |
|
attendanceItemName
|
data.attendanceItemName | string |
attendanceItemName |
|
actualDuration
|
data.actualDuration | string |
actualDuration |
|
busyStatus
|
data.busyStatus | string |
busyStatus |
|
dateType
|
data.dateType | string |
dateType |
|
existsTimesheet
|
data.existsTimesheet | boolean |
existsTimesheet |
|
existsLeave
|
data.existsLeave | boolean |
existsLeave |
|
existsStatutoryLeave
|
data.existsStatutoryLeave | boolean |
existsStatutoryLeave |
List of timesheets
List of timesheets
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Fuzzy query parameter
|
q | string |
Fuzzy query parameter |
|
|
Current page number
|
current | integer |
Current page number |
|
|
The number of pages
|
size | integer |
The number of pages |
|
|
Employee ID filtering
|
employeeId | string |
Employee ID filtering |
|
|
Timesheet type filtering
|
type | string |
Timesheet type filtering |
|
|
Application date filtering
|
date | string |
Application date filtering |
|
|
Application status filtering
|
status | string |
Application status filtering |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
code
|
code | integer |
code |
|
message
|
message | string |
message |
|
size
|
data.size | integer |
size |
|
current
|
data.current | integer |
current |
|
records
|
data.records | array of object |
records |
|
id
|
data.records.id | string |
id |
|
employeeId
|
data.records.employeeId | string |
employeeId |
|
type
|
data.records.type | string |
type |
|
date
|
data.records.date | string |
date |
|
isCrossTheSky
|
data.records.isCrossTheSky | boolean |
isCrossTheSky |
|
startTime
|
data.records.startTime | string |
startTime |
|
endTime
|
data.records.endTime | string |
endTime |
|
startTimeText
|
data.records.startTimeText | string |
startTimeText |
|
endTimeText
|
data.records.endTimeText | string |
endTimeText |
|
times
|
data.records.times | integer |
times |
|
status
|
data.records.status | string |
status |
|
remark
|
data.records.remark | string |
remark |
|
mealTime
|
data.records.mealTime | integer |
mealTime |
|
addressCardId
|
data.records.addressCardId | string |
addressCardId |
|
isHrProcessing
|
data.records.isHrProcessing | boolean |
isHrProcessing |
|
finalApprover
|
data.records.finalApprover | string |
finalApprover |
|
finalApprovalTime
|
data.records.finalApprovalTime | string |
finalApprovalTime |
|
attendanceItemId
|
data.records.attendanceItemId | string |
attendanceItemId |
|
workOverTimeType
|
data.records.workOverTimeType | string |
workOverTimeType |
|
auWorkingType
|
data.records.auWorkingType | string |
auWorkingType |
|
finalApproverName
|
data.records.finalApproverName | string |
finalApproverName |
|
attendanceItemName
|
data.records.attendanceItemName | string |
attendanceItemName |
|
addressCardName
|
data.records.addressCardName | string |
addressCardName |
|
englishName
|
data.records.englishName | string |
englishName |
|
recordType
|
data.records.recordType | string |
recordType |
|
pages
|
data.pages | integer |
pages |
|
total
|
data.total | integer |
total |
Query tenant information
Query tenant information
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
code
|
code | integer |
code |
|
message
|
message | string |
message |
|
id
|
data.id | string |
id |
|
name
|
data.name | string |
name |
|
businessRegistrationNumber
|
data.businessRegistrationNumber | string |
businessRegistrationNumber |
|
countryCode
|
data.countryCode | string |
countryCode |
|
phone
|
data.phone | string |
phone |
|
email
|
data.email | string |
|
|
address
|
data.address | string |
address |
|
logo
|
data.logo | string |
logo |
|
region
|
data.region | string |
region |
|
timeZone
|
data.timeZone | string |
timeZone |
|
bankName
|
data.bankName | string |
bankName |
|
bankBranchCode
|
data.bankBranchCode | string |
bankBranchCode |
|
bankAccountNo
|
data.bankAccountNo | string |
bankAccountNo |
|
employerName
|
data.employerName | string |
employerName |
|
employerPosition
|
data.employerPosition | string |
employerPosition |
|
employerFileNumber
|
data.employerFileNumber | string |
employerFileNumber |
|
mainLanguage
|
data.mainLanguage | string |
mainLanguage |
|
currencyCode
|
data.currencyCode | string |
currencyCode |
|
accountType
|
data.accountType | string |
accountType |
|
paymentCode
|
data.paymentCode | string |
paymentCode |
|
paymentReference
|
data.paymentReference | string |
paymentReference |
|
legalNameOfEnterprise
|
data.legalNameOfEnterprise | string |
legalNameOfEnterprise |
|
area
|
data.area | string |
area |
|
is57ACompany
|
data.is57ACompany | string |
is57ACompany |
|
branchNum
|
data.branchNum | string |
branchNum |
|
usedId
|
data.usedId | string |
usedId |
|
postCode
|
data.postCode | string |
postCode |
|
agencyBusinessNum
|
data.agencyBusinessNum | string |
agencyBusinessNum |
|
registeredAgentNum
|
data.registeredAgentNum | string |
registeredAgentNum |
|
agentContactName
|
data.agentContactName | string |
agentContactName |
|
agentEmail
|
data.agentEmail | string |
agentEmail |
|
agentTel
|
data.agentTel | string |
agentTel |
|
hasAgentCompany
|
data.hasAgentCompany | string |
hasAgentCompany |
|
str1
|
data.str1 | string |
str1 |
|
str2
|
data.str2 | string |
str2 |
|
decimal1
|
data.decimal1 | float |
decimal1 |
|
decimal2
|
data.decimal2 | float |
decimal2 |
|
ausAbn
|
data.ausAbn | string |
ausAbn |
|
planTypeName
|
data.planTypeName | string |
planTypeName |
|
realTimeZone
|
data.realTimeZone | string |
realTimeZone |
|
areaCodeList
|
data.areaCodeList | array of string |
areaCodeList |
|
zoneName
|
data.zoneName | string |
zoneName |
|
bmsid
|
data.bmsid | string |
bmsid |
|
planType
|
data.planType | string |
planType |
|
buyCount
|
data.buyCount | integer |
buyCount |
|
usedCount
|
data.usedCount | string |
usedCount |
|
planStatus
|
data.planStatus | string |
planStatus |
|
endTime
|
data.endTime | string |
endTime |
|
startTime
|
data.startTime | string |
startTime |
|
payWay
|
data.payWay | string |
payWay |
Update check-in info
Update check-in info
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Content-Type
|
Content-Type | True | string |
Content-Type |
|
id
|
id | string |
id |
|
|
isInValid
|
isInValid | string |
isInValid |
|
|
remark
|
remark | string |
remark |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
code
|
code | integer |
code |
|
message
|
message | string |
message |
|
data
|
data | boolean |
data |
Update department
Update department
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Content-Type
|
Content-Type | True | string |
Content-Type |
|
id
|
id | string |
id |
|
|
name
|
name | string |
name |
|
|
departmentCode
|
departmentCode | string |
departmentCode |
|
|
attendCalculationId
|
attendCalculationId | string |
attendCalculationId |
|
|
parentId
|
parentId | string |
parentId |
|
|
status
|
status | string |
status |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
code
|
code | integer |
code |
|
message
|
message | string |
message |
|
data
|
data | boolean |
data |
Update employee info
Update employee info
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Content-Type
|
Content-Type | True | string |
Content-Type |
|
id
|
id | string |
id |
|
|
englishName
|
englishName | string |
englishName |
|
|
chineseName
|
chineseName | string |
chineseName |
|
|
email
|
string |
|
||
|
countryCode
|
countryCode | string |
countryCode |
|
|
phone
|
phone | string |
phone |
|
|
sex
|
sex | string |
sex |
|
|
address
|
address | string |
address |
|
|
code
|
code | string |
code |
|
|
identityCard
|
identityCard | string |
identityCard |
|
|
bankCard
|
bankCard | string |
bankCard |
|
|
flag
|
flag | string |
flag |
|
|
score
|
score | string |
score |
|
|
expectedArea
|
expectedArea | string |
expectedArea |
|
|
nickName
|
nickName | string |
nickName |
|
|
position
|
position | string |
position |
|
|
arrivalDate
|
arrivalDate | string |
arrivalDate |
|
|
salary
|
salary | string |
salary |
|
|
education
|
education | string |
education |
|
|
comApplication
|
comApplication | string |
comApplication |
|
|
otherApplication
|
otherApplication | string |
otherApplication |
|
|
chineseTyping
|
chineseTyping | string |
chineseTyping |
|
|
chineseOther
|
chineseOther | string |
chineseOther |
|
|
englishTyping
|
englishTyping | string |
englishTyping |
|
|
chineseWpm
|
chineseWpm | string |
chineseWpm |
|
|
englishWpm
|
englishWpm | string |
englishWpm |
|
|
cantonese
|
cantonese | string |
cantonese |
|
|
english
|
english | string |
english |
|
|
mandarin
|
mandarin | string |
mandarin |
|
|
otherLanguage
|
otherLanguage | string |
otherLanguage |
|
|
consultantName
|
consultantName | string |
consultantName |
|
|
consultantPhone
|
consultantPhone | string |
consultantPhone |
|
|
consultantCompany
|
consultantCompany | string |
consultantCompany |
|
|
consultantPosition
|
consultantPosition | string |
consultantPosition |
|
|
birthday
|
birthday | string |
birthday |
|
|
accountNumber
|
accountNumber | string |
accountNumber |
|
|
nationality
|
nationality | string |
nationality |
|
|
maritalStatus
|
maritalStatus | string |
maritalStatus |
|
|
emergencyContactName
|
emergencyContactName | string |
emergencyContactName |
|
|
emergencyContactRelation
|
emergencyContactRelation | string |
emergencyContactRelation |
|
|
emergencyContactPhone
|
emergencyContactPhone | string |
emergencyContactPhone |
|
|
bankName
|
bankName | string |
bankName |
|
|
bankBranchNumber
|
bankBranchNumber | string |
bankBranchNumber |
|
|
bankAccountNo
|
bankAccountNo | string |
bankAccountNo |
|
|
bankCode
|
bankCode | string |
bankCode |
|
|
remark
|
remark | string |
remark |
|
|
regionCode
|
regionCode | string |
regionCode |
|
|
surname
|
surname | string |
surname |
|
|
surnameEnglish
|
surnameEnglish | string |
surnameEnglish |
|
|
personalName
|
personalName | string |
personalName |
|
|
personalNameEnglish
|
personalNameEnglish | string |
personalNameEnglish |
|
|
identityCardHk
|
identityCardHk | string |
identityCardHk |
|
|
passportNumber
|
passportNumber | string |
passportNumber |
|
|
passportIssuingPlace
|
passportIssuingPlace | string |
passportIssuingPlace |
|
|
spouseName
|
spouseName | string |
spouseName |
|
|
spouseIdentityCardHk
|
spouseIdentityCardHk | string |
spouseIdentityCardHk |
|
|
spousePassportNumber
|
spousePassportNumber | string |
spousePassportNumber |
|
|
spousePassportIssuingPlace
|
spousePassportIssuingPlace | string |
spousePassportIssuingPlace |
|
|
postalAddress
|
postalAddress | string |
postalAddress |
|
|
employerName
|
employerName | string |
employerName |
|
|
hometown
|
hometown | string |
hometown |
|
|
nation
|
nation | string |
nation |
|
|
politicalStatus
|
politicalStatus | string |
politicalStatus |
|
|
highestEducation
|
highestEducation | string |
highestEducation |
|
|
workDate
|
workDate | string |
workDate |
|
|
confirmationDate
|
confirmationDate | string |
confirmationDate |
|
|
probation
|
probation | string |
probation |
|
|
isDisabled
|
isDisabled | string |
isDisabled |
|
|
isForeignNationality
|
isForeignNationality | string |
isForeignNationality |
|
|
domicileLocation
|
domicileLocation | string |
domicileLocation |
|
|
certificateType
|
certificateType | string |
certificateType |
|
|
certificateNumber
|
certificateNumber | string |
certificateNumber |
|
|
isMartyrDependents
|
isMartyrDependents | string |
isMartyrDependents |
|
|
occupationTaxNumber
|
occupationTaxNumber | string |
occupationTaxNumber |
|
|
nonLocalBlueCardNumber
|
nonLocalBlueCardNumber | string |
nonLocalBlueCardNumber |
|
|
isForeignEmployees
|
isForeignEmployees | string |
isForeignEmployees |
|
|
weeklyLeaveWorkAgreement
|
weeklyLeaveWorkAgreement | string |
weeklyLeaveWorkAgreement |
|
|
employeeType
|
employeeType | string |
employeeType |
|
|
jobLevel
|
jobLevel | string |
jobLevel |
|
|
post
|
post | string |
post |
|
|
salaryScale
|
salaryScale | string |
salaryScale |
|
|
jobTitle
|
jobTitle | string |
jobTitle |
|
|
recruitmentSource
|
recruitmentSource | string |
recruitmentSource |
|
|
graduatedSchool
|
graduatedSchool | string |
graduatedSchool |
|
|
profession
|
profession | string |
profession |
|
|
termsOfWork
|
termsOfWork | string |
termsOfWork |
|
|
totalHours
|
totalHours | string |
totalHours |
|
|
payrollPackageFte
|
payrollPackageFte | string |
payrollPackageFte |
|
|
payrollPackageProData
|
payrollPackageProData | string |
payrollPackageProData |
|
|
hourlyWagePercent
|
hourlyWagePercent | string |
hourlyWagePercent |
|
|
terminationCompensationDate
|
terminationCompensationDate | string |
terminationCompensationDate |
|
|
terminationEmployedLength
|
terminationEmployedLength | string |
terminationEmployedLength |
|
|
ageOfTermination
|
ageOfTermination | string |
ageOfTermination |
|
|
appellation
|
appellation | string |
appellation |
|
|
middleName
|
middleName | string |
middleName |
|
|
homePhone
|
homePhone | string |
homePhone |
|
|
officePhone
|
officePhone | string |
officePhone |
|
|
country
|
country | string |
country |
|
|
province
|
province | string |
province |
|
|
city
|
city | string |
city |
|
|
postcode
|
postcode | string |
postcode |
|
|
address1
|
address1 | string |
address1 |
|
|
address2
|
address2 | string |
address2 |
|
|
contractEndDate
|
contractEndDate | string |
contractEndDate |
|
|
taxIdentity
|
taxIdentity | string |
taxIdentity |
|
|
otherIncomeName
|
otherIncomeName | string |
otherIncomeName |
|
|
mobileCardCalType
|
mobileCardCalType | string |
mobileCardCalType |
|
|
date1
|
date1 | string |
date1 |
|
|
date2
|
date2 | string |
date2 |
|
|
date3
|
date3 | string |
date3 |
|
|
date4
|
date4 | string |
date4 |
|
|
text1
|
text1 | string |
text1 |
|
|
text2
|
text2 | string |
text2 |
|
|
text3
|
text3 | string |
text3 |
|
|
text4
|
text4 | string |
text4 |
|
|
text5
|
text5 | string |
text5 |
|
|
text6
|
text6 | string |
text6 |
|
|
whetherResidence
|
whetherResidence | string |
whetherResidence |
|
|
award
|
award | string |
award |
|
|
employeeRateType
|
employeeRateType | string |
employeeRateType |
|
|
classification
|
classification | string |
classification |
|
|
payrollTemplateId
|
payrollTemplateId | string |
payrollTemplateId |
|
|
beneficiaryType
|
beneficiaryType | string |
beneficiaryType |
|
|
exemptionMedicalInsuranceTax
|
exemptionMedicalInsuranceTax | string |
exemptionMedicalInsuranceTax |
|
|
isRequirementsThreshold
|
isRequirementsThreshold | string |
isRequirementsThreshold |
|
|
isSupportingAccount
|
isSupportingAccount | string |
isSupportingAccount |
|
|
taxpayerStatus
|
taxpayerStatus | string |
taxpayerStatus |
|
|
age
|
age | string |
age |
|
|
workHours
|
workHours | string |
workHours |
|
|
tfnSignDate
|
tfnSignDate | string |
tfnSignDate |
|
|
taxNumber
|
taxNumber | string |
taxNumber |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
code
|
code | integer |
code |
|
message
|
message | string |
message |
|
data
|
data | boolean |
data |
Update external salary
Update external salary
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Content-Type
|
Content-Type | True | string |
Content-Type |
|
id
|
id | string |
id |
|
|
code
|
code | string |
code |
|
|
employeeId
|
employeeId | string |
employeeId |
|
|
businessSalaryItemId
|
businessSalaryItemId | string |
businessSalaryItemId |
|
|
money
|
money | double |
money |
|
|
occurrenceDate
|
occurrenceDate | string |
occurrenceDate |
|
|
remark
|
remark | string |
remark |
|
|
expirationDate
|
expirationDate | string |
expirationDate |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
code
|
code | integer |
code |
|
message
|
message | string |
message |
|
data
|
data | string |
data |
Update fixed salary items
Update fixed salary items
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Content-Type
|
Content-Type | True | string |
Content-Type |
|
id
|
id | string |
id |
|
|
payrollItemId
|
payrollItemId | string |
payrollItemId |
|
|
money
|
money | double |
money |
|
|
startDate
|
startDate | string |
startDate |
|
|
endDate
|
endDate | string |
endDate |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
code
|
code | integer |
code |
|
message
|
message | string |
message |
|
data
|
data | string |
data |
Update label
Update label
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Content-Type
|
Content-Type | True | string |
Content-Type |
|
id
|
id | string |
id |
|
|
labelCode
|
labelCode | string |
labelCode |
|
|
labelName
|
labelName | string |
labelName |
|
|
labelStatus
|
labelStatus | integer |
labelStatus |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
code
|
code | integer |
code |
|
message
|
message | string |
message |
|
data
|
data | string |
data |
Update leave application
Update leave application
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Content-Type
|
Content-Type | True | string |
Content-Type |
|
id
|
id | string |
id |
|
|
employeeId
|
employeeId | string |
employeeId |
|
|
holidayType
|
holidayType | string |
holidayType |
|
|
startDate
|
startDate | string |
startDate |
|
|
startTime
|
startTime | string |
startTime |
|
|
endDate
|
endDate | string |
endDate |
|
|
endTime
|
endTime | string |
endTime |
|
|
leaveTime
|
leaveTime | string |
leaveTime |
|
|
timeType
|
timeType | string |
timeType |
|
|
remark
|
remark | string |
remark |
|
|
status
|
status | string |
status |
|
|
holidayDate
|
holidayDate | string |
holidayDate |
|
|
time
|
time | string |
time |
|
|
isHrProcessing
|
isHrProcessing | string |
isHrProcessing |
|
|
finalApprover
|
finalApprover | string |
finalApprover |
|
|
finalApprovalTime
|
finalApprovalTime | string |
finalApprovalTime |
|
|
finalApproverName
|
finalApproverName | string |
finalApproverName |
|
|
holidayTypeName
|
holidayTypeName | string |
holidayTypeName |
|
|
englishName
|
englishName | string |
englishName |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
code
|
code | integer |
code |
|
message
|
message | string |
message |
|
data
|
data | boolean |
data |
Update non-fixed salary items
Update non-fixed salary items
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Content-Type
|
Content-Type | True | string |
Content-Type |
|
id
|
id | string |
id |
|
|
money
|
money | double |
money |
|
|
remark
|
remark | string |
remark |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
code
|
code | integer |
code |
|
message
|
message | string |
message |
|
data
|
data | string |
data |
Update roster item
Update roster item
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Content-Type
|
Content-Type | True | string |
Content-Type |
|
id
|
id | string |
id |
|
|
name
|
name | string |
name |
|
|
code
|
code | string |
code |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
code
|
code | integer |
code |
|
message
|
message | string |
message |
|
data
|
data | string |
data |
Update shift template
Update shift template
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Content-Type
|
Content-Type | True | string |
Content-Type |
|
id
|
id | string |
id |
|
|
name
|
name | string |
name |
|
|
shiftIn
|
shiftIn | string |
shiftIn |
|
|
shiftOff
|
shiftOff | string |
shiftOff |
|
|
mealTime
|
mealTime | integer |
mealTime |
|
|
attendanceAddressId
|
attendanceAddressId | string |
attendanceAddressId |
|
|
dateType
|
dateType | string |
dateType |
|
|
lunchStartTime
|
lunchStartTime | string |
lunchStartTime |
|
|
lunchEndTime
|
lunchEndTime | string |
lunchEndTime |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
code
|
code | integer |
code |
|
message
|
message | string |
message |
|
data
|
data | string |
data |
Update tenant information
Update tenant information
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Content-Type
|
Content-Type | True | string |
Content-Type |
|
id
|
id | string |
id |
|
|
name
|
name | string |
name |
|
|
businessRegistrationNumber
|
businessRegistrationNumber | string |
businessRegistrationNumber |
|
|
countryCode
|
countryCode | string |
countryCode |
|
|
phone
|
phone | string |
phone |
|
|
email
|
string |
|
||
|
address
|
address | string |
address |
|
|
logo
|
logo | string |
logo |
|
|
region
|
region | string |
region |
|
|
timeZone
|
timeZone | string |
timeZone |
|
|
bankName
|
bankName | string |
bankName |
|
|
bankBranchCode
|
bankBranchCode | string |
bankBranchCode |
|
|
bankAccountNo
|
bankAccountNo | string |
bankAccountNo |
|
|
employerName
|
employerName | string |
employerName |
|
|
employerPosition
|
employerPosition | string |
employerPosition |
|
|
employerFileNumber
|
employerFileNumber | string |
employerFileNumber |
|
|
mainLanguage
|
mainLanguage | string |
mainLanguage |
|
|
currencyCode
|
currencyCode | string |
currencyCode |
|
|
accountType
|
accountType | string |
accountType |
|
|
paymentCode
|
paymentCode | string |
paymentCode |
|
|
paymentReference
|
paymentReference | string |
paymentReference |
|
|
legalNameOfEnterprise
|
legalNameOfEnterprise | string |
legalNameOfEnterprise |
|
|
area
|
area | string |
area |
|
|
is57ACompany
|
is57ACompany | string |
is57ACompany |
|
|
branchNum
|
branchNum | string |
branchNum |
|
|
usedId
|
usedId | string |
usedId |
|
|
postCode
|
postCode | string |
postCode |
|
|
agencyBusinessNum
|
agencyBusinessNum | string |
agencyBusinessNum |
|
|
registeredAgentNum
|
registeredAgentNum | string |
registeredAgentNum |
|
|
agentContactName
|
agentContactName | string |
agentContactName |
|
|
agentEmail
|
agentEmail | string |
agentEmail |
|
|
agentTel
|
agentTel | string |
agentTel |
|
|
hasAgentCompany
|
hasAgentCompany | string |
hasAgentCompany |
|
|
str1
|
str1 | string |
str1 |
|
|
str2
|
str2 | string |
str2 |
|
|
decimal1
|
decimal1 | string |
decimal1 |
|
|
decimal2
|
decimal2 | string |
decimal2 |
|
|
ausAbn
|
ausAbn | string |
ausAbn |
|
|
planTypeName
|
planTypeName | string |
planTypeName |
|
|
realTimeZone
|
realTimeZone | string |
realTimeZone |
|
|
zoneName
|
zoneName | string |
zoneName |
|
|
bmsid
|
bmsid | string |
bmsid |
|
|
planType
|
planType | string |
planType |
|
|
buyCount
|
buyCount | string |
buyCount |
|
|
usedCount
|
usedCount | string |
usedCount |
|
|
planStatus
|
planStatus | string |
planStatus |
|
|
endTime
|
endTime | string |
endTime |
|
|
startTime
|
startTime | string |
startTime |
|
|
payWay
|
payWay | string |
payWay |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
code
|
code | integer |
code |
|
message
|
message | string |
message |
|
data
|
data | boolean |
data |
Update the cost center
Update the cost center
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Content-Type
|
Content-Type | True | string |
Content-Type |
|
id
|
id | string |
id |
|
|
name
|
name | string |
name |
|
|
costCenterCode
|
costCenterCode | string |
costCenterCode |
|
|
status
|
status | string |
status |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
code
|
code | string |
code |
|
message
|
message | string |
message |
|
data
|
data | string |
data |
Update the expense records
Update the expense records
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Content-Type
|
Content-Type | True | string |
Content-Type |
|
id
|
id | string |
id |
|
|
employeeId
|
employeeId | string |
employeeId |
|
|
reimbursementType
|
reimbursementType | string |
reimbursementType |
|
|
reimbursementDate
|
reimbursementDate | string |
reimbursementDate |
|
|
reimbursementName
|
reimbursementName | string |
reimbursementName |
|
|
amount
|
amount | float |
amount |
|
|
remark
|
remark | string |
remark |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
code
|
code | string |
code |
|
message
|
message | string |
message |
|
data
|
data | string |
data |
Update the job position
Update the job position
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Content-Type
|
Content-Type | True | string |
Content-Type |
|
id
|
id | string |
id |
|
|
name
|
name | string |
name |
|
|
positionCode
|
positionCode | string |
positionCode |
|
|
status
|
status | string |
status |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
code
|
code | string |
code |
|
message
|
message | string |
message |
|
data
|
data | string |
data |
Update the office location
Update the office location
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Content-Type
|
Content-Type | True | string |
Content-Type |
|
id
|
id | string |
id |
|
|
name
|
name | string |
name |
|
|
address
|
address | string |
address |
|
|
longitude
|
longitude | string |
longitude |
|
|
latitude
|
latitude | string |
latitude |
|
|
region
|
region | string |
region |
|
|
isEnableGps
|
isEnableGps | string |
isEnableGps |
|
|
isEnableBluetooth
|
isEnableBluetooth | string |
isEnableBluetooth |
|
|
attendanceAddressCode
|
attendanceAddressCode | string |
attendanceAddressCode |
|
|
status
|
status | string |
status |
|
|
areaType
|
areaType | string |
areaType |
|
|
mapType
|
mapType | string |
mapType |
|
|
longitudeBaidu
|
longitudeBaidu | string |
longitudeBaidu |
|
|
latitudeBaidu
|
latitudeBaidu | string |
latitudeBaidu |
|
|
longitudeGaode
|
longitudeGaode | string |
longitudeGaode |
|
|
latitudeGaode
|
latitudeGaode | string |
latitudeGaode |
|
|
areaCode
|
areaCode | string |
areaCode |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
code
|
code | integer |
code |
|
message
|
message | string |
message |
|
data
|
data | boolean |
data |
Update the schedule
Update the schedule
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Content-Type
|
Content-Type | True | string |
Content-Type |
|
id
|
id | string |
id |
|
|
shiftTemplateId
|
shiftTemplateId | string |
shiftTemplateId |
|
|
shiftIn
|
shiftIn | string |
shiftIn |
|
|
shiftOff
|
shiftOff | string |
shiftOff |
|
|
mealTime
|
mealTime | integer |
mealTime |
|
|
shiftStatus
|
shiftStatus | string |
shiftStatus |
|
|
addressCardId
|
addressCardId | string |
addressCardId |
|
|
remark
|
remark | string |
remark |
|
|
attendanceItemId
|
attendanceItemId | string |
attendanceItemId |
|
|
dateType
|
dateType | string |
dateType |
|
|
attendDay
|
attendDay | string |
attendDay |
|
|
acrossTheNight
|
acrossTheNight | string |
acrossTheNight |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
code
|
code | string |
code |
|
message
|
message | string |
message |
|
data
|
data | string |
data |
Update the timesheet
Update the timesheet
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Content-Type
|
Content-Type | True | string |
Content-Type |
|
id
|
id | string |
id |
|
|
employeeId
|
employeeId | string |
employeeId |
|
|
type
|
type | string |
type |
|
|
date
|
date | string |
date |
|
|
isCrossTheSky
|
isCrossTheSky | string |
isCrossTheSky |
|
|
startTime
|
startTime | string |
startTime |
|
|
endTime
|
endTime | string |
endTime |
|
|
startTimeText
|
startTimeText | string |
startTimeText |
|
|
endTimeText
|
endTimeText | string |
endTimeText |
|
|
times
|
times | string |
times |
|
|
status
|
status | string |
status |
|
|
remark
|
remark | string |
remark |
|
|
mealTime
|
mealTime | string |
mealTime |
|
|
addressCardId
|
addressCardId | string |
addressCardId |
|
|
isHrProcessing
|
isHrProcessing | string |
isHrProcessing |
|
|
finalApprover
|
finalApprover | string |
finalApprover |
|
|
finalApprovalTime
|
finalApprovalTime | string |
finalApprovalTime |
|
|
attendanceItemId
|
attendanceItemId | string |
attendanceItemId |
|
|
workOverTimeType
|
workOverTimeType | string |
workOverTimeType |
|
|
auWorkingType
|
auWorkingType | string |
auWorkingType |
|
|
finalApproverName
|
finalApproverName | string |
finalApproverName |
|
|
attendanceItemName
|
attendanceItemName | string |
attendanceItemName |
|
|
addressCardName
|
addressCardName | string |
addressCardName |
|
|
englishName
|
englishName | string |
englishName |
|
|
recordType
|
recordType | string |
recordType |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
code
|
code | integer |
code |
|
message
|
message | string |
message |
|
data
|
data | boolean |
data |