Workstem HK (Preview)

Workstem Hong Kong 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	support@workstem.com

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

Add a cost center	Add a cost center
Add a department	Add a department
Add a new calendar remark	Add a new calendar remark
Add a position	Add a position
Add a tag	Add a tag
Add employee history	Add employee history
Add employee information	Add employee information
Add External Salary Data	Add External Salary Data
Add fixed salary data	Add fixed salary data
Add Leave Application	Add Leave Application
Add leave balance adjustment record	Add leave balance adjustment record
Add location info	Add location info
Add mobile card	Add mobile card
Add open shift information	Add open shift information
Add project category information	Add project category information
Add project certificate hours	Add project certificate hours
Add project certificate information	Add project certificate information
Add project information	Add project information
Add Reimbursement Application	Add Reimbursement Application
Add roster information	Add roster information
Add shift template information	Add shift template information
Add timesheet	Add timesheet
Add Variable Salary Data	Add Variable Salary Data
Add Work Pattern Info	Add Work Pattern Info
Batch save roster information	Batch save roster information
Calculate leave balance	Calculate leave balance
Call attendance calculation	Call attendance calculation
Delete a cost center	Delete a cost center
Delete a department	Delete a department
Delete a location	Delete a location
Delete a position	Delete a position
Delete a tag	Delete a tag
Delete calendar remark by ID	Delete calendar remark by ID
Delete employee by ID	Delete employee by ID
Delete employee history by ID	Delete employee history by ID
Delete External Salary Data By Id	Delete External Salary Data By Id
Delete fixed salary data by id	Delete fixed salary data by id
Delete leave application by ID	Delete leave application by ID
Delete leave balance adjustment record by ID	Delete leave balance adjustment record by ID
Delete mobile card by ID	Delete mobile card by ID
Delete open shift by id	Delete open shift by id
Delete project by ID	Delete project by ID
Delete project category by ID	Delete project category by ID
Delete project certificate hours by ID	Delete project certificate hours by ID
Delete reimbursement application by ID	Delete reimbursement application by ID
Delete roster by ID	Delete roster by ID
Delete shift template by ID	Delete shift template by ID
Delete timesheet by ID	Delete timesheet by ID
Delete Variable Salary Data By Id	Delete Variable Salary Data By Id
Delete Work Pattern By Id	Delete Work Pattern By Id
Get a location	Get a location
Get approval process list	Get approval process list
Get cost centers	Get cost centers
Get custom field details by ID	Get custom field details by ID
Get custom field list	Get custom field list
Get data dictionary item details by ID	Get data dictionary item details by ID
Get data dictionary list	Get data dictionary list
Get departments	Get departments
Get Devices	Get Devices
Get employee information	Get employee information
Get employee leave balance details	Get employee leave balance details
Get External Pay Item Info By Id	Get External Pay Item Info By Id
Get External Pay Item List	Get External Pay Item List
Get External Salary Data List	Get External Salary Data List
Get Fixed Salary Data By Employee's Id	Get Fixed Salary Data By Employee's Id
Get leave application approval process by application ID	Get leave application approval process by application ID
Get leave application details by ID	Get leave application details by ID
Get leave application list	Get leave application list
Get leave balance adjustment record list	Get leave balance adjustment record list
Get Leave Balance List	Get Leave Balance List
Get Location Attendance Rules By Id	Get Location Attendance Rules By Id
Get locations list	Get locations list
Get Mobile card details by ID	Get Mobile card details by ID
Get open shift info	Get open shift info
Get Pay Item Info By Id	Get Pay Item Info By Id
Get Pay Item List	Get Pay Item List
Get Payroll Details Info By Id	Get Payroll Details Info By Id
Get Payroll Policy Info By Id	Get Payroll Policy Info By Id
Get Payroll Policy List	Get Payroll Policy List
Get Payroll Run Data List	Get Payroll Run Data List
Get Payroll Run List	Get Payroll Run List
Get positions	Get positions
Get project information	Get project information
Get reimbursement application details by ID	Get reimbursement application details by ID
Get reimbursement application list	Get reimbursement application list
Get Reimbursement Type List	Get Reimbursement Type List
Get roster information	Get roster information
Get tags	Get tags
Get timesheet information by ID	Get timesheet information by ID
Get Variable Salary Data List	Get Variable Salary Data List
Get Work Pattern Info By Id	Get Work Pattern Info By Id
Get Work Pattern List	Get Work Pattern List
Label list	Label list
List of attendance calculation result (example)	List of attendance calculation result (example)
List of attendance detail	List of attendance detail
List of attendance items	List of attendance items
List of attendance summary	List of attendance summary
List of calendar remark	List of calendar remark
List of cost centers	List of cost centers
List of department	List of department
List of employee	List of employee
List of employee	List of employee
List of employee history	List of employee history
List of expense application	List of expense application
List of external payroll item projects	List of external payroll item projects
List of external payroll items data	List of external payroll items data
List of fixed payroll items	List of fixed payroll items
List of leave application	List of leave application
List of leave policies	List of leave policies
List of leave types	List of leave types
List of mobile card	List of mobile card
List of office locations	List of office locations
List of open shift	List of open shift
List of payroll items	List of payroll items
List of payroll plans	List of payroll plans
List of positions	List of positions
List of project	List of project
List of project category	List of project category
List of project certificate	List of project certificate
List of project certificate hours by project certificate ID	List of project certificate hours by project certificate ID
List of roster	List of roster
List of rosters	List of rosters
List of shift template	List of shift template
List of timesheet	List of timesheet
List of timesheet	List of timesheet
List of variable payroll items	List of variable payroll items
Query a user's info	Query a user's info
Query leave policy summary information	Query leave policy summary information
Query list of leave types within a leave policy	Query list of leave types within a leave policy
Query tenant information	Query tenant information
Query tenant information	Query tenant information
Query users' info	Query users' info
Resign	Resign
Update a cost center	Update a cost center
Update a cost center	Update a cost center
Update a department	Update a department
Update a location	Update a location
Update a position by id	Update a position by id
Update a roster	Update a roster
Update a tag	Update a tag
Update calendar remark by ID	Update calendar remark by ID
Update check-in information	Update check-in information
Update Department	Update Department
Update employee	Update employee
Update employee history	Update employee history
Update employee information	Update employee information
Update expense application	Update expense application
Update expense application by ID	Update expense application by ID
Update external payroll item data	Update external payroll item data
Update External Salary Data By Id	Update External Salary Data By Id
Update fixed payroll item	Update fixed payroll item
Update fixed salary data by id	Update fixed salary data by id
Update label	Update label
Update leave application	Update leave application
Update leave application by ID	Update leave application by ID
Update mobile card By ID	Update mobile card By ID
Update office location	Update office location
Update open shift	Update open shift
Update position information	Update position information
Update project category information	Update project category information
Update project certificate information	Update project certificate information
Update project information	Update project information
Update roster information	Update roster information
Update roster item	Update roster item
Update shift template	Update shift template
Update shift template	Update shift template
Update tenant information	Update tenant information
Update timesheet	Update timesheet
Update timesheet by ID	Update timesheet by ID
Update variable payroll item	Update variable payroll item
Update Variable Salary Data By Id	Update Variable Salary Data By Id
Update Work Pattern By Id	Update Work Pattern By Id
View attendance configuration	View attendance configuration

Add a cost center

Operation ID:: 018addCostCenterInfoV3

Add a cost center

Parameters

Name	Key	Required	Type	Description
name	name	True	string	Name
costCenterCode	costCenterCode		string	Cost Center Code
status	status		string	Status, 0:Disabled, 1:Enabled

Returns

Body: ResultBoolean

Add a department

Operation ID:: 010addDepartmentInfoV3

Add a department

Parameters

Name	Key	Required	Type	Description
name	name	True	string	Department Name
departmentCode	departmentCode		string	Department Code
status	status		string	Status, 0:Disabled, 1:Enabled
parentId	parentId		string	Parent Department ID

Returns

Body: ResultBoolean

Add a new calendar remark

Operation ID:: 15addCalendarRemarkInfoV3

Add a new calendar remark

Parameters

Name	Key	Required	Type	Description
employeeId	employeeId	True	string	Employee ID/Name/Code
employeeStatus	employeeStatus	True	string	Employee status (0: Free,1: Be busy)
timeType	timeType	True	string	Time type (0: One day,1: many days)
startDate	startDate		date	Start date
endDate	endDate		date	End date
recordDate	recordDate		date	Record date
expectWorkLocation	expectWorkLocation		string	Expected work location ID/Name/Code
expectWorkTimeTemplate	expectWorkTimeTemplate		string	Expected work template ID/Name/Code
expectWorkStartTime	expectWorkStartTime	True	string	Expected start time
expectWorkEndTime	expectWorkEndTime	True	string	Expected end time
remark	remark		string	Remarks

Returns

Body: ResultV3AddCalendarRemarkInfoResp

Add a position

Operation ID:: 014addPositionInfoV3

Add a position

Parameters

Name	Key	Required	Type	Description
name	name	True	string	Position Name
positionCode	positionCode		string	Position Code
status	status		string	Status, 0:Disabled, 1:Enabled

Returns

Body: ResultBoolean

Add a tag

Operation ID:: 022addTagInfoV3

Add a tag

Parameters

Name	Key	Required	Type	Description
labelCode	labelCode		string	Label Code
labelName	labelName	True	string	Label Name
labelStatus	labelStatus		integer	Label Status, 0:Disabled, 1:Enabled
parentId	parentId		string	Parent Label ID

Returns

Body: ResultBoolean

Add employee history

Operation ID:: 07addEmployeeHistoryV3

Add employee history

Parameters

Name	Key	Required	Type	Description
employeeId	employeeId	True	string	Employee ID/Name/Code
entryDate	entryDate	True	date	Join Date
confirmationDate	confirmationDate		date	Regularization Date
hireType	hireType		string	Employment Type (0: Full Time,1: Temporary, 2: Freelance, 3: Part Time, 4: Contract,5: Internship, 6: Virtual Employee)
positionId	positionId		string	Position ID/Name/Code
departmentId	departmentId		string	Department ID/Name/Code
directSupervisorId	directSupervisorId		string	Manager ID/Name/Code
attendCalculationId	attendCalculationId		string	Location ID/Name/Code
payrollRegulationId	payrollRegulationId		string	Payroll Policy ID/Name/Code
basicPay	basicPay		number	Basic Salary
calculateSalaryType	calculateSalaryType		string	Salary Type (0: Monthly 1: Hourly 2: Yearly 3: Daily 4: Weekly)
costCenterId	costCenterId		string	Cost center ID/Name/Code
workDate	workDate		date	Date of seniority calculation
cause	cause		string	Cause
majorWorkLocationId	majorWorkLocationId		string	Major Location ID/Name/Code
takeEffectType	takeEffectType	True	string	Take effect type (0: Historical Record,1: Effective Immediately,2: Effective in the Future,3: Modify)
takeEffectDate	takeEffectDate	True	date	Take effect date

Returns

Body: ResultV3AddEmployeeHistoryResp

Add employee information

Operation ID:: 01addEmployeeInfoV3

Add employee information

Parameters

Name	Key	Required	Type	Description
entryDate	entryDate	True	date	Join Date
englishName	englishName	True	string	Name (display name)
email	email	True	string	Email Address
employeeStatus	employeeStatus		string	Employment Status (0: Terminated,1: Active)
sex	sex		string	Gender (0: Male,1: Female,2: Unspecified)
nationality	nationality		string	Country / Region
maritalStatus	maritalStatus		string	Marital Status (0: Single 1: Married 2: Divorced 3: Widowed)
countryCode	countryCode		string	Country / Region Code
phone	phone		string	Phone Number
calculateSalaryType	calculateSalaryType		string	Salary Type (0: Monthly 1: Hourly 2: Yearly 3: Daily 4: Weekly)
workDate	workDate		date	Date of seniority calculation
basicPay	basicPay		number	Basic Salary
code	code		string	Staff ID
identityCard	identityCard		string	HKID/Passport No.
chineseName	chineseName		string	Chinese Name
surnameEnglish	surnameEnglish		string	Surname(ID card)
personalNameEnglish	personalNameEnglish		string	Given Name(ID card)
birthday	birthday		string	Birthday
address	address		string	Home Address
emergencyContactName	emergencyContactName		string	Emergency Contact
emergencyContactRelation	emergencyContactRelation		string	Relationship
emergencyContactPhone	emergencyContactPhone		string	Emergency Contact Phone No.
bankCode	bankCode		string	Bank Code
bankBranchNumber	bankBranchNumber		string	Bank Branch Code
bankAccountNo	bankAccountNo		string	Bank Account No.
confirmationDate	confirmationDate		date	Regularization Date
date1	date1		date	Date1
date2	date2		date	Date2
date3	date3		date	Date3
date4	date4		date	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
directSupervisorId	directSupervisorId		string	Manager ID/Name/Code
departmentId	departmentId		string	Department ID/Name/Code
positionId	positionId		string	Position ID/Name/Code
hireType	hireType		string	Employment Type (0: Full Time,1: Temporary, 2: Freelance, 3: Part Time, 4: Contract,5: Internship, 6: Virtual Employee)
payrollRegulationId	payrollRegulationId		string	Payroll Policy ID/Name/Code
costCenterId	costCenterId		string	Cost Center ID/Name/Code
attendCalculationId	attendCalculationId		string	Location ID/Name/Code
mobileCardCalType	mobileCardCalType		string	Field Clocking Calculation Formula (1: Not counting working hours,2: Direct working hours,3: Work hours after approval)
regularType	regularType		string	Leave Policy ID/Name/Code
insurePlanName	insurePlanName		string	MPF Scheme ID/Name/Code
bizLabelIds	bizLabelIds		string	Tag ID/Name/Code

Returns

Body: ResultV3AddEmployeeResp

Add External Salary Data

Operation ID:: 009addExternalSalaryDataV3

Add External Salary Data

Parameters

Name	Key	Required	Type	Description
code	code		string	number
employeeId	employeeId	True	string	employee ID
businessSalaryItemId	businessSalaryItemId	True	string	business payroll item ID, business payroll item name
money	money	True	number	amount
occurrenceDate	occurrenceDate	True	date	occurrence date
remark	remark		string	remark
expirationDate	expirationDate		date	expiration date

Returns

Body: ResultBoolean

Add fixed salary data

Operation ID:: 001addFixedSalaryDataV3

Add fixed salary data

Parameters

Name	Key	Required	Type	Description
employeeId	employeeId	True	string	Employee ID, employee number, employee name
payrollItemId	payrollItemId	True	string	Salary item ID, salary item name
money	money		number	amount
startDate	startDate		date	start date
endDate	endDate		date	end date
totalLimitAmount	totalLimitAmount		number	total limit amount
paidAmount	paidAmount		number	paid amount
surplusAmount	surplusAmount		number	surplus amount

Returns

Body: ResultBoolean

Add Leave Application

Operation ID:: 07addLeaveApplicationInfoV3

Add Leave Application

Parameters

Name	Key	Required	Type	Description
employeeId	employeeId	True	string	Employee ID, Name, Code
holidayType	holidayType	True	string	Holiday Type ID, Name, Short Name
startDate	startDate		date	Start Date
startTime	startTime		string	Start Time am:Morning pm:Afternoon allDay:All Day
endDate	endDate		date	End Date
endTime	endTime		string	End Time am:Morning pm:Afternoon allDay:All Day
leaveTime	leaveTime		number	Leave Duration
timeType	timeType		string	Duration Type 0:One day 1:Multiple days
holidayDate	holidayDate		date	Leave Date for Single Day Leave
time	time		string	Leave Time for Single Day Leave am:Morning pm:Afternoon allDay:All Day
remark	remark		string	Reason

Returns

Body: ResultV3LeaveHolidayInsertResp

Add leave balance adjustment record

Operation ID:: 01addLeaveBalanceAdjustInfoV3

Add leave balance adjustment record

Parameters

Name	Key	Required	Type	Description
employeeId	employeeId	True	string	Employee ID, Name, Code
holidayType	holidayType	True	string	Holiday Type ID, Name, Short Name
occurrenceTime	occurrenceTime	True	date-time	Occurrence Time
cause	cause	True	string	Cause
adjust	adjust	True	string	Adjustment Value

Returns

Body: ResultBoolean

Add location info

Operation ID:: 004addLocationInfoV3

Add location info

Parameters

Name	Key	Required	Type	Description
name	name	True	string	Address Abbreviation
address	address	True	string	Detailed Address
longitude	longitude	True	number	Longitude
latitude	latitude	True	number	Latitude
region	region		integer	Check In Range
isEnableGps	isEnableGps		boolean	Is GPS Enabled, 0:Disabled, 1:Enabled
isEnableBluetooth	isEnableBluetooth		boolean	Is Bluetooth Enabled, 0:Disabled, 1:Enabled
attendanceAddressCode	attendanceAddressCode		string	Attendance Address Code
status	status		string	Status, 0:Disabled, 1:Enabled
mapType	mapType		string	Map Type, 0:Baidu Map; 1:Google Map; 2:Gaode Map
areaCode	areaCode	True	string	Region Code (e.g., HK for Hong Kong, AU for Australia, MO for Macau, TW for Taiwan)

Returns

Body: ResultBoolean

Add mobile card

Operation ID:: 04addAttendanceDataInfoV3

Add mobile card

Parameters

Name	Key	Required	Type	Description
employeeId	employeeId	True	string	Employee ID/Name/Code
date	date	True	date-time	Mobile card date
mode	mode	True	string	Check in method (0: GPS,1: Bluetooth,2: Wifi,3: QR code,4: Field check-in,5: Face recognition)
cardType	cardType		string	Mobile card type (1: Clock-in,2: Clock-out)
actualLongitude	actualLongitude		number	Longitude
actualLatitude	actualLatitude		number	Latitude
deviceName	deviceName		string	Equipment name
codeSource	codeSource		string	QR code source
locationName	locationName		string	Field location name
workLocationId	workLocationId		string	Work location ID/Name/Code
deviceId	deviceId		string	Bind device ID

Returns

Body: ResultV3AddMobileCardResp

Add open shift information

Operation ID:: 11addOpenShiftInfoV3

Add open shift information

Parameters

Name	Key	Required	Type	Description
code	code		string	Code
projectId	projectId	True	string	Project ID/Name/Code
locationId	locationId		string	Work location ID/Name/Code
shiftType	shiftType		string	Shift Type (0: weekdays, 1: rest days, 2: statutory holidays)
date	date	True	date	Date
mealTime	mealTime		integer	Meal duration
startTime	startTime	True	time	Start Time
endTime	endTime	True	time	End Time
hourlyRate	hourlyRate	True	number	Hourly rate
empPlanNo	empPlanNo	True	integer	Planned number of employees
costCenterId	costCenterId		string	Cost center ID/Name/Code
remark	remark		string	Remarks

Returns

Body: ResultBoolean

Add project category information

Operation ID:: 16addProjectCategoryInfoV3

Add project category information

Parameters

Name	Key	Required	Type	Description
name	name	True	string	Name
code	code		string	Code
parentId	parentId		string	Parent category ID/Name/Code

Returns

Body: ResultBoolean

Add project certificate hours

Operation ID:: 28addProjectCertificateHoursV3

Add project certificate hours

Parameters

Name	Key	Required	Type	Description
projectCertificateId	projectCertificateId	True	string	Project certificate ID
occurrenceTime	occurrenceTime	True	date-time	Occurrence time
balance	balance	True	number	Adjust the limit
reason	reason	True	string	Reason

Returns

Body: ResultBoolean

Add project certificate information

Operation ID:: 25addProjectCertificateInfoV3

Add project certificate information

Parameters

Name	Key	Required	Type	Description
employeeId	employeeId	True	string	Employee ID/Name/Code
projectId	projectId	True	string	Project ID/Name/Code
tier	tier		string	Tier
tierRate	tierRate		number	Tier rate
shiftHours	shiftHours	True	number	Schedule hours
workedHours	workedHours	True	number	Worked hours
reason	reason		string	Reason

Returns

Body: ResultBoolean

Add project information

Operation ID:: 20addProjectInfoV3

Add project information

Parameters

Name	Key	Required	Type	Description
code	code	True	string	Code
categoryId	categoryId		string	Category ID/Name/Code
name	name	True	string	Name
hourlyRate	hourlyRate	True	number	Hourly rate
minRate	minRate		number	Min hourly rate
maxRate	maxRate		number	Max hourly rate

Returns

Body: ResultBoolean

Add Reimbursement Application

Operation ID:: 02addExpenseApplicationInfoV3

Add Reimbursement Application

Parameters

Name	Key	Required	Type	Description
employeeId	employeeId	True	string	Employee ID, Name, Code
reimbursementType	reimbursementType	True	string	Reimbursement type ID, name
reimbursementDate	reimbursementDate	True	date	Reimbursement Date
reimbursementName	reimbursementName	True	string	Reimbursement Name
amount	amount	True	number	Reimbursement Amount
remark	remark		string	Reason

Returns

Body: ResultV3BizReimbursementInsertResp

Add roster information

Operation ID:: 01addRosterInfoV3

Add roster information

Parameters

Name	Key	Required	Type	Description
employeeId	employeeId	True	string	Employee ID/Name/Code
attendDay	attendDay	True	date	Attendance Date
shiftTemplateId	shiftTemplateId		string	Shift Template ID/Name/Code
addressCardId	addressCardId		string	Work Location ID/Name/Code
shiftIn	shiftIn	True	time	Start Time
shiftOff	shiftOff	True	time	End Time
mealTime	mealTime		integer	Meal duration
shiftStatus	shiftStatus		string	Shift Status (0: Published, 1: Unpublished)
dateType	dateType		string	Shift Type (0: weekdays, 1: rest days, 2: statutory holidays)
attendanceItemId	attendanceItemId		string	Project ID/Name/Code
hourlyRate	hourlyRate		number	Hourly Rate
costCenterId	costCenterId		string	Cost Center ID/Name/Code
tierRate	tierRate		number	Tier Rate
scheduledAmount	scheduledAmount		number	Scheduled Amount
remark	remark		string	Remarks

Returns

Body: ResultBoolean

Add shift template information

Operation ID:: 07addShitTemplateInfoV3

Add shift template information

Parameters

Name	Key	Required	Type	Description
name	name	True	string	Name
shiftIn	shiftIn	True	time	Start Time
shiftOff	shiftOff	True	time	End Time
dateType	dateType		string	Shift Type (0: weekdays, 1: rest days, 2: statutory holidays)
attendanceAddressId	attendanceAddressId		string	Work location ID/Name/Code
mealTime	mealTime		integer	Meal duration

Returns

Body: ResultBoolean

Add timesheet

Operation ID:: 10addTimesheetInfoV3

Add timesheet

Parameters

Name	Key	Required	Type	Description
employeeId	employeeId	True	string	Employee ID/Name/Code
type	type	True	string	Application type (0: Overtime,1: Normal Hours,2: Break)
workOverTimeType	workOverTimeType		string	Overtime type (0: Working Overtime On Weekdays,1: Working Overtime On Rest Days,2: Working Overtime On Statutory Holidays)
date	date	True	date	Application date
startTime	startTime	True	date-time	Start time
endTime	endTime	True	date-time	End time
mealTime	mealTime		integer	Meal time
addressCardId	addressCardId		string	Work location ID/Name/Code
attendanceItemId	attendanceItemId		string	Item ID/Name/Code
costCenterId	costCenterId		string	Cost center ID/Name/Code
remark	remark		string	Remarks

Returns

Body: ResultV3AddTimesheetResp

Add Variable Salary Data

Operation ID:: 005addVariableSalaryDataV3

Add Variable Salary Data

Parameters

Name	Key	Required	Type	Description
employeeId	employeeId	True	string	Employee ID, employee number, employee name
payrollItemId	payrollItemId	True	string	Salary item ID, salary item name
money	money	True	number	amount
payrollDate	payrollDate	True	date	payroll date
remark	remark		string	reason
dataType	dataType		string	data type

Returns

Body: ResultBoolean

Add Work Pattern Info

Operation ID:: 022addWorkPatternInfoV3

Add Work Pattern Info

Parameters

Name	Key	Required	Type	Description
advancedSetting	advancedSetting		string	advanced settings,0:No,1:Yes
number	number		string	number
name	name	True	string	name
workHoursForDay	workHoursForDay	True	number	working hours per day
workHoursForWeek	workHoursForWeek	True	number	working hours per week
workHoursForYear	workHoursForYear	True	number	working hours per year
totalHours	totalHours	True	number	total working hours
cycleType	cycleType	True	string	cycle type 0: Once a month, 1: Multiple times a month, 2: Weekly salary, 3: New every two weeks, 4: Half a month
fte	fte		string	FTE
status	status		string	status, 0:enabled,1:disabled
salaryCalculationStyle	salaryCalculationStyle		integer	Salary calculation method 0: by time, 1: by office location, 2: by project
workTime	workTime		integer	working time
doubleWeekBaseDate	doubleWeekBaseDate		date-time	base date for biweekly cycle
weekSalaryType	weekSalaryType		string	weekly salary type
isThisWeek	isThisWeek		integer	whether current week is single week
amount	amount		number	payroll amount
workHours	workHours		number	working hours
shiftTemplateId	shiftTemplateId		string	shift template id
daySign	daySign		string	day sign. Monday to Sunday are (1, 2, 3, 4, 5, 6, 7), biweekly is (8, 9, 10, 11, 12, 13, 14), and public holidays are 15

Returns

Body: ResultBoolean

Batch save roster information

Operation ID:: 02batchSaveRosterInfoV3

Batch save roster information

Parameters

Name	Key	Required	Type	Description
employeeIds	employeeIds	True	array of string	Employee ID List
dates	dates	True	array of date	Attendance Date List
shiftTemplateId	shiftTemplateId		string	Shift Template ID/Name/Code
addressCardId	addressCardId		string	Work Location ID/Name/Code
shiftIn	shiftIn	True	time	Start Time
shiftOff	shiftOff	True	time	End Time
mealTime	mealTime		integer	Meal duration
shiftStatus	shiftStatus		string	Shift Status (0: Published, 1: Unpublished)
dateType	dateType		string	Shift Type (0: weekdays, 1: rest days, 2: statutory holidays)
attendanceItemId	attendanceItemId		string	Project ID/Name/Code
hourlyRate	hourlyRate		number	Hourly Rate
costCenterId	costCenterId		string	Cost Center ID/Name/Code
replaceOriginal	replaceOriginal		boolean	Replace exists data (1: Yes, 0: No)

Returns

Body: ResultBoolean

Calculate leave balance

Operation ID:: 04calculationLeaveBalanceV3

Calculate leave balance

Parameters

Name	Key	Type	Description
date	date	date	Calculation date
isForceCal	isForceCal	boolean	Is force calculation
employeeIdsList	employeeIdsList	array of string	Employee ID list
position	position	array of string	Position list
dept	dept	array of string	Department list

Returns

Body: ResultBoolean

Call attendance calculation

Operation ID:: 01attendanceSummaryCalculateV3

Call attendance calculation

Parameters

Name	Key	Required	Type	Description
startDate	startDate	True	date	Start date
endDate	endDate	True	date	End date
employeeIds	employeeIds		array of string	Employee ID
departmentIds	departmentIds		array of string	Department ID
positionIds	positionIds		array of string	Position ID

Returns

Body: ResultV3CalAttendanceResp

Delete a cost center

Operation ID:: 019deleteCostCenterByIdV3

Delete a cost center

Parameters

Name	Key	Required	Type	Description
id	id	True	string	id

Returns

Body: ResultBoolean

Delete a department

Operation ID:: 011deleteDepartmentByIdV3

Delete a department

Parameters

Name	Key	Required	Type	Description
id	id	True	string	id

Returns

Body: ResultBoolean

Delete a location

Operation ID:: 005deleteLocationByIdV3

Delete a location

Parameters

Name	Key	Required	Type	Description
id	id	True	string	id

Returns

Body: ResultBoolean

Delete a position

Operation ID:: 015deletePositionByIdV3

Delete a position

Parameters

Name	Key	Required	Type	Description
id	id	True	string	id

Returns

Body: ResultBoolean

Delete a tag

Operation ID:: 023deleteTagByIdV3

Delete a tag

Parameters

Name	Key	Required	Type	Description
id	id	True	string	id

Returns

Body: ResultBoolean

Delete calendar remark by ID

Operation ID:: 16deleteCalendarRemarkByIdV3

Delete calendar remark by ID

Parameters

Name	Key	Required	Type	Description
Calendar remark ID	id	True	string	Calendar remark ID

Returns

Body: ResultBoolean

Delete employee by ID

Operation ID:: 02deleteEmployeeByIdV3

Delete employee by ID

Parameters

Name	Key	Required	Type	Description
Employee ID	id	True	string	Employee ID

Returns

Body: ResultBoolean

Delete employee history by ID

Operation ID:: 08deleteEmployeeHistoryByIdV3

Delete employee history by ID

Parameters

Name	Key	Required	Type	Description
Employee history ID	id	True	string	Employee history ID

Returns

Body: ResultBoolean

Delete External Salary Data By Id

Operation ID:: 010deleteExternalSalaryDataByIdV3

Delete External Salary Data By Id

Parameters

Name	Key	Required	Type	Description
id	id	True	string	id

Returns

Body: ResultBoolean

Delete fixed salary data by id

Operation ID:: 002deleteFixedSalaryDataByIdV3

Delete fixed salary data by id

Parameters

Name	Key	Required	Type	Description
id	id	True	string	id

Returns

Body: ResultBoolean

Delete leave application by ID

Operation ID:: 08deleteLeaveApplicationByIdV3

Delete leave application by ID

Parameters

Name	Key	Required	Type	Description
Leave application ID	id	True	string	Leave application ID

Returns

Body: ResultBoolean

Delete leave balance adjustment record by ID

Operation ID:: 02deleteLeaveBalanceAdjustmentByIdV3

Delete leave balance adjustment record by ID

Parameters

Name	Key	Required	Type	Description
Balance adjustment record ID	id	True	string	Balance adjustment record ID

Returns

Body: ResultBoolean

Delete mobile card by ID

Operation ID:: 05deleteAttendanceDataByIdV3

Delete mobile card by ID

Parameters

Name	Key	Required	Type	Description
Deleted ID	ids	True	string	Deleted ID

Returns

Body: ResultBoolean

Delete open shift by id

Operation ID:: 12deleteOpenShiftByIdV3

Delete open shift by id

Parameters

Name	Key	Required	Type	Description
Open shift ID	id	True	string	Open shift ID

Returns

Body: ResultBoolean

Delete project by ID

Operation ID:: 21deleteProjectByIdV3

Delete project by ID

Parameters

Name	Key	Required	Type	Description
Project ID	id	True	string	Project ID

Returns

Body: ResultBoolean

Delete project category by ID

Operation ID:: 17deleteProjectCategoryByIdV3

Delete project category by ID

Parameters

Name	Key	Required	Type	Description
Project category ID	id	True	string	Project category ID

Returns

Body: ResultBoolean

Delete project certificate hours by ID

Operation ID:: 29deleteProjectCertificateHoursByIdV3

Delete project certificate hours by ID

Parameters

Name	Key	Required	Type	Description
Project certificate hours ID	id	True	string	Project certificate hours ID

Returns

Body: ResultBoolean

Delete reimbursement application by ID

Operation ID:: 03deleteExpenseApplicationByIdV3

Delete reimbursement application by ID

Parameters

Name	Key	Required	Type	Description
Reimbursement application ID	id	True	string	Reimbursement application ID

Returns

Body: ResultBoolean

Delete roster by ID

Operation ID:: 03deleteRosterByIdV3

Delete roster by ID

Parameters

Name	Key	Required	Type	Description
Roster ID	id	True	string	Roster ID

Returns

Body: ResultBoolean

Delete shift template by ID

Operation ID:: 08deleteShiftTemplateByIdV3

Delete shift template by ID

Parameters

Name	Key	Required	Type	Description
Shift template ID	id	True	string	Shift template ID

Returns

Body: ResultBoolean

Delete timesheet by ID

Operation ID:: 11deleteTimesheetByIdV3

Delete timesheet by ID

Parameters

Name	Key	Required	Type	Description
Timesheet ID	id	True	string	Timesheet ID

Returns

Body: ResultBoolean

Delete Variable Salary Data By Id

Operation ID:: 006deleteVariableSalaryDataByIdV3

Delete Variable Salary Data By Id

Parameters

Name	Key	Required	Type	Description
id	id	True	string	id

Returns

Body: ResultBoolean

Delete Work Pattern By Id

Operation ID:: 024deleteWorkPatternByIdV3

Delete Work Pattern By Id

Parameters

Name	Key	Required	Type	Description
id	id	True	string	id

Returns

Body: ResultBoolean

Get a location

Operation ID:: 008getLocationInfoByIdV3

Get a location

Parameters

Name	Key	Required	Type	Description
id	id	True	string	id

Returns

Body: ResultV3AttAddressResp

Get approval process list

Operation ID:: 06getApproveProcessListV3

Get approval process list

Parameters

Name	Key	Type	Description
Fuzzy query parameter: name	q	string	Fuzzy query parameter: name
Page number	current	integer	Page number
Number of items per page	size	integer	Number of items per page

Returns

Body: ResultIPageV3LeaveWorkFlowDefinitionResp

Get cost centers

Operation ID:: 021getCostCenterListV3

Get cost centers

Parameters

Name	Key	Type	Description
Get cost centers	q	string	Get cost centers
Page number	current	integer	Page number
Number of items per page	size	integer	Number of items per page

Returns

Body: ResultIPageV3CostCenterResp

Get custom field details by ID

Operation ID:: 05getCustomizeUserFieldInfoByIdV3

Get custom field details by ID

Parameters

Name	Key	Required	Type	Description
Custom field ID	id	True	string	Custom field ID

Returns

Body: ResultV3BizEmployeeCustomizationResp

Get custom field list

Operation ID:: 04getCustomizeUserFieldListV3

Get custom field list

Parameters

Name	Key	Required	Type	Description
Page number	current		integer	Page number
Number of items per page	size		integer	Number of items per page

Returns

Body: ResultIPageV3BizEmployeeCustomizationResp

Get data dictionary item details by ID

Operation ID:: 03GetDataDictionaryDetailsInfoByIdV3

Get data dictionary item details by ID

Parameters

Name	Key	Required	Type	Description
Data dictionary ID	id	True	string	Data dictionary ID

Returns

Body: ResultListV3BizCustomizeDictionaryItemResp

Get data dictionary list

Operation ID:: 02getDataDictionaryListV3

Get data dictionary list

Returns

Body: ResultListV3BizCustomizeDictionaryResp

Get departments

Operation ID:: 013getDepartmentListV3

Get departments

Parameters

Name	Key	Type	Description
fuzzy query param for: name, code	q	string	fuzzy query param for: name, code
Page number	current	integer	Page number
Number of items per page	size	integer	Number of items per page

Returns

Body: ResultIPageV3DepartmentResp

Get Devices

Operation ID:: 026getDeviceListV3

Get Devices

Parameters

Name	Key	Type	Description
fuzzy query param for: name	q	string	fuzzy query param for: name
Page number	current	integer	Page number
Number of items per page	size	integer	Number of items per page

Returns

Body: ResultIPageV3DeviceResp

Get employee information

Operation ID:: 05getEmployeeInfoByIdV3

Get employee information

Parameters

Name	Key	Required	Type	Description
Employee ID	id	True	string	Employee ID

Returns

Body: ResultV3EmployeeInfoResp

Get employee leave balance details

Operation ID:: 06GetLeaveBalanceInfoByIdV3

Get employee leave balance details

Parameters

Name	Key	Required	Type	Description
Employee ID	employeeId	True	string	Employee ID
Holiday Type ID	holidayType	True	string	Holiday Type ID

Returns

Body: ResultV3LeaveBalanceDetailResp

Get External Pay Item Info By Id

Operation ID:: 021getExternalPayItemInfoByIdV3

Get External Pay Item Info By Id

Parameters

Name	Key	Required	Type	Description
id	id	True	string	id

Returns

Body: ResultV3ExternalPayItemResp

Get External Pay Item List

Operation ID:: 020getExternalPayItemListV3

Get External Pay Item List

Parameters

Name	Key	Type	Description
fuzzy query param for: name, formula alias	q	string	fuzzy query param for: name, formula alias
Page number	current	integer	Page number
Number of items per page	size	integer	Number of items per page

Returns

Body: ResultIPageV3ExternalPayItemResp

Get External Salary Data List

Operation ID:: 012getExternalSalaryDataListV3

Get External Salary Data List

Parameters

Name	Key	Type	Description
fuzzy query param for: external payroll's code, employee's code, name	q	string	fuzzy query param for: external payroll's code, employee's code, name
Page number	current	integer	Page number
Number of items per page	size	integer	Number of items per page
employee id filter	employeeIdFilter	string	employee id filter
employee status filter	statusFilter	string	employee status filter
employee hire type filter	hireTypeFilter	string	employee hire type filter
business payroll item id filter	businessSalaryItemFilter	string	business payroll item id filter
occurrence date filter	occurrenceDateFilter	string	occurrence date filter
amount filter	moneyFilter	string	amount filter
employee salary calculation type filter	calculateSalaryTypeFilter	string	employee salary calculation type filter
employee label id filter	labelFilter	string	employee label id filter

Returns

Body: ResultIPageV3ExternalPayrollResp

Get Fixed Salary Data By Employee's Id

Operation ID:: 004getFixedSalaryDataByEmployeeIdV3

Get Fixed Salary Data By Employee's Id

Parameters

Name	Key	Required	Type	Description
Employee's Id	employeeId	True	string	Employee's Id

Returns

Body: ResultListV3PayrollFixedResp

Get leave application approval process by application ID

Operation ID:: 12getLeaveApplicationApproveProcessByIdV3

Get leave application approval process by application ID

Parameters

Name	Key	Required	Type	Description
Application ID	recordId	True	string	Application ID

Returns

Body: ResultListV3LeaveProcessResp

Get leave application details by ID

Operation ID:: 11getLeaveApplicationInfoByIdV3

Get leave application details by ID

Parameters

Name	Key	Required	Type	Description
Leave Application ID	id	True	string	Leave Application ID

Returns

Body: ResultV3LeaveHolidayDetailResp

Get leave application list

Operation ID:: 10getLeaveApplicationListV3

Get leave application list

Parameters

Name	Key	Type	Description
Fuzzy query parameters: employee name, employee code	q	string	Fuzzy query parameters: employee name, employee code
Page number	current	integer	Page number
Number of items per page	size	integer	Number of items per page
Department filter, comma separated	departmentFilter	string	Department filter, comma separated
Employee filter, comma separated	employeeFilter	string	Employee filter, comma separated
Employee status filter, comma separated 0: Resigned 1: Active	statusFilter	string	Employee status filter, comma separated 0: Resigned 1: Active
Holiday type filter, comma separated	holidayTypeFilter	string	Holiday type filter, comma separated
Salary calculation type filter, comma separated 0: Monthly salary 1: Hourly wage	calculateSalaryTypeFilter	string	Salary calculation type filter, comma separated 0: Monthly salary 1: Hourly wage 2: Annual salary 3: Daily wage 4: Weekly wage
Leave record status filter, comma separated 0: Pending approval 1: Rejected 2: A	recordStatusFilter	string	Leave record status filter, comma separated 0: Pending approval 1: Rejected 2: Approved
Work location filter, comma separated	attendCalculationId	string	Work location filter, comma separated
Tag filter, comma separated	bizLabelIds	string	Tag filter, comma separated
Start date filter, comma separated	startDateFilter	string	Start date filter, comma separated

Returns

Body: ResultIPageV3LeaveHolidayResp

Get leave balance adjustment record list

Operation ID:: 03getLeaveBalanceAdjustmentListV3

Get leave balance adjustment record list

Parameters

Name	Key	Required	Type	Description
Employee ID	employeeId	True	string	Employee ID
Holiday Type ID	holidayType	True	string	Holiday Type ID
Page number	current		integer	Page number
Number of items per page	size		integer	Number of items per page

Returns

Body: ResultIPageV3LeaveHolidayBalanceResp

Get Leave Balance List

Operation ID:: 05getLeaveBalanceListV3

Get Leave Balance List

Parameters

Name	Key	Required	Type	Description
Fuzzy query parameters: Employee Name, Employee Code	q		string	Fuzzy query parameters: Employee Name, Employee Code
Page number	current		integer	Page number
Number of items per page	size		integer	Number of items per page
Holiday Type ID	holidayType	True	string	Holiday Type ID
Holiday Rule Filter, comma separated	regularTypeFilter		string	Holiday Rule Filter, comma separated
Department Filter, comma separated	departmentFilter		string	Department Filter, comma separated
Position Filter, comma separated	positionFilter		string	Position Filter, comma separated
Employee Status Filter, comma separated 0: Resigned 1: Active	statusFilter		string	Employee Status Filter, comma separated 0: Resigned 1: Active
Gender Filter, comma separated male: Male female: Female unspecified: Unspecifie	sexFilter		string	Gender Filter, comma separated male: Male female: Female unspecified: Unspecified
Leave Balance Status Filter, comma separated 0: Effective 1: Planned	leaveHolidayBalanceStatusFilter		string	Leave Balance Status Filter, comma separated 0: Effective 1: Planned
Salary Calculation Type Filter, comma separated 0: Monthly Salary 1: Hourly Rate	calculateSalaryTypeFilter		string	Salary Calculation Type Filter, comma separated 0: Monthly Salary 1: Hourly Rate 2: Annual Salary 3: Daily Rate 4: Weekly Rate
Employment Type Filter, comma separated 0: Full-time 1: Temporary 2: Freelancer	hireTypeFilter		string	Employment Type Filter, comma separated 0: Full-time 1: Temporary 2: Freelancer 3: Part-time 4: Contractual 5: Internship 6: Virtual Employee
Tag Filter, comma separated	bizLabelIds		string	Tag Filter, comma separated

Returns

Body: ResultIPageV3LeaveBalanceResp

Get Location Attendance Rules By Id

Operation ID:: 009getLocationAttendanceRulesByIdV3

Get Location Attendance Rules By Id

Parameters

Name	Key	Required	Type	Description
Work Location Id	workLocationId	True	string	Work Location Id

Returns

Body: ResultV3AttRuleResp

Get locations list

Operation ID:: 007getLocationListV3

Get locations list

Parameters

Name	Key	Type	Description
fuzzy query param for: name, address, code	q	string	fuzzy query param for: name, address, code
Page number	current	integer	Page number
Number of items per page	size	integer	Number of items per page

Returns

Body: ResultIPageV3AttAddressResp

Get Mobile card details by ID

Operation ID:: 08getAttendanceDataInfoByIdV3

Get Mobile card details by ID

Parameters

Name	Key	Required	Type	Description
Mobile card data ID	id	True	string	Mobile card data ID

Returns

Body: ResultV3MobileCardInfoResp

Get open shift info

Operation ID:: 15getOpenShiftInfoByIdV3

Get open shift info

Parameters

Name	Key	Required	Type	Description
Open shift ID	id	True	string	Open shift ID

Returns

Body: ResultV3OpenShiftInfoResp

Get Pay Item Info By Id

Operation ID:: 019getPayItemInfoByIdV3

Get Pay Item Info By Id

Parameters

Name	Key	Required	Type	Description
id	id	True	string	id

Returns

Body: ResultV3PayrollItemResp

Get Pay Item List

Operation ID:: 018getPayItemListV3

Get Pay Item List

Parameters

Name	Key	Type	Description
fuzzy query param for: name, formula, formula alias	q	string	fuzzy query param for: name, formula, formula alias
Page number	current	integer	Page number
Number of items per page	size	integer	Number of items per page
payroll item name filter	nameFilter	string	payroll item name filter
payment type filter 0: Income, 1 expenditure, 2 not suitable	paymentTypeFilter	string	payment type filter 0: Income, 1 expenditure, 2 not suitable
payroll item category id	payrollItemTypeId	string	payroll item category id
status filter 0: disabled, 1: enabled, 2: deleted	statusFilter	string	status filter 0: disabled, 1: enabled, 2: deleted

Returns

Body: ResultIPageV3PayrollItemResp

Get Payroll Details Info By Id

Operation ID:: 015getPayrollDetailsInfoByIdV3

Get Payroll Details Info By Id

Parameters

Name	Key	Required	Type	Description
id	id	True	string	id

Returns

Body: ResultListV3PayrollPlanDetailResp

Get Payroll Policy Info By Id

Operation ID:: 017getPayrollPolicyInfoByIdV3

Get Payroll Policy Info By Id

Parameters

Name	Key	Required	Type	Description
id	id	True	string	id

Returns

Body: ResultV3PayrollRegResp

Get Payroll Policy List

Operation ID:: 016getPayrollPolicyListV3

Get Payroll Policy List

Parameters

Name	Key	Type	Description
Page number	current	integer	Page number
Number of items per page	size	integer	Number of items per page
fuzzy query param for: name	q	string	fuzzy query param for: name

Returns

Body: ResultIPageV3PayrollRegResp

Get Payroll Run Data List

Operation ID:: 014getPayrollRunDataListV3

Get Payroll Run Data List

Parameters

Name	Key	Required	Type	Description
payroll plan id	planId	True	string	payroll plan id
Page number	current		integer	Page number
Number of items per page	size		integer	Number of items per page

Returns

Body: ResultIPageV3PayrollPlanDetailResp

Get Payroll Run List

Operation ID:: 013getPayrollRunListV3

Get Payroll Run List

Parameters

Name	Key	Required	Type	Description
fuzzy query param for: name	q		string	fuzzy query param for: name
payroll plan's status, Status 0: Draft pending review; 1: Review pending payment	status	True	string	payroll plan's status, Status 0: Draft pending review; 1: Review pending payment; 2: Paid already; 3: Closed
Page number	current		integer	Page number
Number of items per page	size		integer	Number of items per page

Returns

Body: ResultIPageV3PayrollPlanResp

Get positions

Operation ID:: 017getPositionListV3

Get positions

Parameters

Name	Key	Type	Description
fuzzy query param for: name, code	q	string	fuzzy query param for: name, code
Page number	current	integer	Page number
Number of items per page	size	integer	Number of items per page

Returns

Body: ResultIPageV3PositionResp

Get project information

Operation ID:: 24getProjectInfoByIdV3

Get project information

Parameters

Name	Key	Required	Type	Description
Project ID	id	True	string	Project ID

Returns

Body: ResultV3ProjectInfoResp

Get reimbursement application details by ID

Operation ID:: 06GetExpenseApplicationByIdV3

Get reimbursement application details by ID

Parameters

Name	Key	Required	Type	Description
Reimbursement application ID	id	True	string	Reimbursement application ID

Returns

Body: ResultV3BizReimbursementDetailResp

Get reimbursement application list

Operation ID:: 05GetExpenseApplicationListV3

Get reimbursement application list

Parameters

Name	Key	Type	Description
Fuzzy query parameters: reimbursement name, employee name, employee email, emplo	q	string	Fuzzy query parameters: reimbursement name, employee name, employee email, employee phone number
Department ID filter	departmentFilter	string	Department ID filter
Employee ID filter	employeeIdFilter	string	Employee ID filter
Employee status filter 0: Resigned 1: Active	statusFilter	string	Employee status filter 0: Resigned 1: Active
Date range filter	dateFilter	string	Date range filter
Reimbursement status filter 0-Pending 1-Rejected 2-Approved 3-Cancelled 4-Delete	reimbursementStatusFilter	string	Reimbursement status filter 0-Pending 1-Rejected 2-Approved 3-Cancelled 4-Deleted
Page number	current	integer	Page number
Number of items per page	size	integer	Number of items per page

Returns

Body: ResultIPageV3BizReimbursementResp

Get Reimbursement Type List

Operation ID:: 01getExpenseTypeListV3

Get Reimbursement Type List

Parameters

Name	Key	Type	Description
Fuzzy query parameter: name	q	string	Fuzzy query parameter: name
Page number	current	integer	Page number
Number of items per page	size	integer	Number of items per page

Returns

Body: ResultIPageV3BizReimbursementTypeResp

Get roster information

Operation ID:: 06getRosterInfoByIdV3

Get roster information

Parameters

Name	Key	Required	Type	Description
Roster ID	id	True	string	Roster ID

Returns

Body: ResultV3RosterInfoResp

Get tags

Operation ID:: 025getTagListV3

Get tags

Parameters

Name	Key	Type	Description
Get tags	q	string	Get tags
Page number	current	integer	Page number
Number of items per page	size	integer	Number of items per page

Returns

Body: ResultIPageV3LabelResp

Get timesheet information by ID

Operation ID:: 14getTimesheetInfoByIdV3

Get timesheet information by ID

Parameters

Name	Key	Required	Type	Description
Timesheet ID	id	True	string	Timesheet ID

Returns

Body: ResultV3TimesheetInfoResp

Get Variable Salary Data List

Operation ID:: 008getVariableSalaryDataListV3

Get Variable Salary Data List

Parameters

Name	Key	Type	Description
fuzzy query param for: employees' name, code	q	string	fuzzy query param for: employees' name, code
Page number	current	integer	Page number
Number of items per page	size	integer	Number of items per page
employee id filter	employeeIdFilter	string	employee id filter
employee status filter	statusFilter	string	employee status filter
employee hire type filter	hireTypeFilter	string	employee hire type filter
payroll date filter	payrollDateFilter	string	payroll date filter
amount filter	moneyFilter	string	amount filter
payroll item filter	payrollItemIdFilter	string	payroll item filter
employee salary calculation type filter	calculateSalaryTypeFilter	string	employee salary calculation type filter
employee label id filter	bizLabelIds	string	employee label id filter

Returns

Body: ResultIPageV3PayrollNonFixedResp

Get Work Pattern Info By Id

Operation ID:: 026getWorkPatternInfoByIdV3

Get Work Pattern Info By Id

Parameters

Name	Key	Required	Type	Description
id	id	True	string	id

Returns

Body: ResultV3WorkPatternResp

Get Work Pattern List

Operation ID:: 025getWorkPatternListV3

Get Work Pattern List

Parameters

Name	Key	Type	Description
fuzzy query param for: number, name	q	string	fuzzy query param for: number, name
Page number	current	integer	Page number
Number of items per page	size	integer	Number of items per page

Returns

Body: ResultIPageV3WorkPatternSummaryResp

Label list

Operation ID:: getLabelListV2

Label list

Parameters

Name	Key	Type	Description
Fuzzy query param for: name, code	q	string	Fuzzy query param for: name, code
Page number	current	integer	Page number
Number of items per page	size	integer	Number of items per page
Label code	labelCode	string	Label code
Label name	labelName	string	Label name
Label status: 0. Disabled, 1. Enabled	labelStatus	integer	Label status: 0. Disabled, 1. Enabled

Returns

Body: ResultIPageV2LabelResp

List of attendance calculation result (example)

Operation ID:: getAttendCalculationListV2

List of attendance calculation result (example)

Parameters

Name	Key	Type	Description
Search keywords	q	string	Search keywords
Page number	current	integer	Page number
Number of items per page	size	integer	Number of items per page
Attendance Date	attendDay	date	Attendance Date
Employee Id	employeeId	string	Employee Id
Attendance Status (0: Normal, 1: Late, 2: Overtime, 3: Early Departure, 4: Absen	attendStatus	string	Attendance Status (0: Normal, 1: Late, 2: Overtime, 3: Early Departure, 4: Absenteeism)
Date Type (0: Working Day,1: Rest Day,2: Legal Holiday)	type	string	Date Type (0: Working Day,1: Rest Day,2: Legal Holiday)

Returns

Body: ResultIPageV2AttendanceResp

List of attendance detail

Operation ID:: 03getEmployeeDailyAttendanceListV3

List of attendance detail

Parameters

Name	Key	Required	Type	Description
Employee ID	employeeId	True	string	Employee ID
Start date	startDate	True	date	Start date
End date	endDate	True	date	End date
Attendance Status (0: Normal,1: Late,2: Overtime,3: Early Departure,4: Absenteei	attendStatusFilter		string	Attendance Status (0: Normal,1: Late,2: Overtime,3: Early Departure,4: Absenteeism,5: Unverified Clock-in,6: Other)

Returns

Body: ResultListV3AttendanceDetailListResp

List of attendance items

Operation ID:: 09getAttendanceItemListV3

List of attendance items

Parameters

Name	Key	Type	Description
Search keywords (name,Regulation Rules Alias)	q	string	Search keywords (name,Regulation Rules Alias)
Page number	current	integer	Page number
Number of items per page	size	integer	Number of items per page

Returns

Body: ResultIPageV3AttendanceItemListResp

List of attendance summary

Operation ID:: 02getAttendanceSummaryListV3

List of attendance summary

Parameters

Name	Key	Required	Type	Description
Search keywords(Employee name,Employee code,Employee email,Employee phone)	q		string	Search keywords(Employee name,Employee code,Employee email,Employee phone)
Page number	current		integer	Page number
Number of items per page	size		integer	Number of items per page
Start date	startDate	True	date	Start date
End date	endDate	True	date	End date
Unit (0: hours,1: day)	unit	True	string	Unit (0: hours,1: day)
Department ID	departmentFilter		string	Department ID
Position ID	positionFilter		string	Position ID
Work location ID	attendCalculationFilter		string	Work location ID
Employee ID	employeeFilter		string	Employee ID
Label ID	labelFilter		string	Label ID
Payroll policy ID	payrollRegulationFilter		string	Payroll policy ID
Employee status (0: Resignation, 1: Employment)	statusFilter		string	Employee status (0: Resignation, 1: Employment)
Employment Form (0: Full Time,1: Temporary, 2: Freelance, 3: Part Time, 4: Contr	hireTypeFilter		string	Employment Form (0: Full Time,1: Temporary, 2: Freelance, 3: Part Time, 4: Contract,5: Internship, 6: Virtual Employee)
Salary Calculation Method (0: Monthly 1: Hourly 2: Yearly 3: Daily 4: Weekly)	calculateSalaryTypeFilter		string	Salary Calculation Method (0: Monthly 1: Hourly 2: Yearly 3: Daily 4: Weekly)
Attendance Status (0: Normal,1: Late,2: Overtime,3: Early Departure,4: Absenteei	attendanceTypeFilter		string	Attendance Status (0: Normal,1: Late,2: Overtime,3: Early Departure,4: Absenteeism,5: Unverified Clock-in,6: Other)
Shift Type (0: All,1: Already scheduled,2: Unplanned schedule)	shiftTypeFilter		string	Shift Type (0: All,1: Already scheduled,2: Unplanned schedule)

Returns

Body: ResultIPageV3AttendanceListResp

List of calendar remark

Operation ID:: 18getCalendarRemarkListV3

List of calendar remark

Parameters

Name	Key	Type	Description
Page number	current	integer	Page number
Number of items per page	size	integer	Number of items per page
Employee ID	employeeIds	string	Employee ID
Start date	startDate	date	Start date
End date	endDate	date	End date

Returns

Body: ResultIPageV3StatusFlagListResp

List of cost centers

Operation ID:: getCostCenterListV2

List of cost centers

Parameters

Name	Key	Type	Description
Fuzzy query param for: name, code	q	string	Fuzzy query param for: name, code
Page number	current	integer	Page number
Number of items per page	size	integer	Number of items per page
Name	name	string	Name
Code	costCenterCode	string	Code

Returns

Body: ResultIPageV2CostCenterResp

List of department

Operation ID:: getDepartmentListV2

List of department

Parameters

Name	Key	Type	Description
Search keywords	q	string	Search keywords
Page number	current	integer	Page number
Number of items per page	size	integer	Number of items per page
Department Name	name	string	Department Name
Code	departmentCode	string	Code
Parent department Id	parentId	string	Parent department Id
Status (0: Disabled, 1: Enabled)	status	string	Status (0: Disabled, 1: Enabled)

Returns

Body: ResultIPageV2DepartmentResp

List of employee

Operation ID:: 04getEmployeeListV3

List of employee

Parameters

Name	Key	Type	Description
Search keywords(Name,Email,Phone,Code,IdentityCard)	q	string	Search keywords(Name,Email,Phone,Code,IdentityCard)
Page number	current	integer	Page number
Number of items per page	size	integer	Number of items per page
ID	id	string	ID
Department ID	departmentId	string	Department ID
Position ID	positionId	string	Position ID
Gender (0: Male,1: Female,2: Unspecified)	sex	string	Gender (0: Male,1: Female,2: Unspecified)
Status (0: Terminated,1: Active)	status	integer	Status (0: Terminated,1: Active)
Employment Form (0: Full Time,1: Temporary, 2: Freelance, 3: Part Time, 4: Contr	hireType	string	Employment Form (0: Full Time,1: Temporary, 2: Freelance, 3: Part Time, 4: Contract,5: Internship, 6: Virtual Employee)
Salary Calculation Method (0: Monthly 1: Hourly 2: Yearly 3: Daily 4: Weekly)	calculateSalaryType	string	Salary Calculation Method (0: Monthly 1: Hourly 2: Yearly 3: Daily 4: Weekly)
Cost Center ID	costCenterId	string	Cost Center ID
Payroll Rule ID	payrollRegulationId	string	Payroll Rule ID
Holiday Rule ID	regularType	string	Holiday Rule ID

Returns

Body: ResultIPageV3EmployeeListResp

List of employee

Operation ID:: getEmployeeListV2

List of employee

Parameters

Name	Key	Type	Description
Search keywords	q	string	Search keywords
Page number	current	integer	Page number
Number of items per page	size	integer	Number of items per page
English Name	englishName	string	English Name
Chinese Name	chineseName	string	Chinese Name
Email	email	string	Email
Phone Region Code	countryCode	string	Phone Region Code
Phone	phone	string	Phone
Code	code	string	Code
Status (0 Resignation, 1 Employment)	status	integer	Status (0 Resignation, 1 Employment)
Education Level (0: Form 3/Certificate, 1: Form 5/Certificate, 2: Hong Kong Dipl	education	string	Education Level (0: Form 3/Certificate, 1: Form 5/Certificate, 2: Hong Kong Diploma Of Secondary Education/Form 7/Diploma, 3: Associate Degree/Advanced Diploma, 4: Bachelor's Degree, 5: Master's Degree, 6: Doctoral Degree)
Department Id	departmentId	string	Department Id
Job Id	positionId	string	Job Id
Employment Form (0: Full Time,1: Temporary, 2: Freelance, 3: Part Time, 4: Contr	hireType	string	Employment Form (0: Full Time,1: Temporary, 2: Freelance, 3: Part Time, 4: Contract,5: Internship, 6: Virtual Employee)
Bank Number	bankCode	string	Bank Number
Cost Center Id	costCenterId	string	Cost Center Id
Salary Rule Id	payrollRegulationId	string	Salary Rule Id
Date Of Employment (specified Seniority Calculation Date)	workDate	date	Date Of Employment (specified Seniority Calculation Date)

Returns

Body: ResultIPageV2EmployeeResp

List of employee history

Operation ID:: 10getEmployeeHistoryListV3

List of employee history

Parameters

Name	Key	Required	Type	Description
Employee ID	employeeId	True	string	Employee ID
Page number	current		integer	Page number
Number of items per page	size		integer	Number of items per page

Returns

Body: ResultIPageV3EmployeeHistoryListResp

List of expense application

Operation ID:: getExpenseApplicationListV2

List of expense application

Parameters

Name	Key	Type	Description
Fuzzy query param for: Reimbursement name	q	string	Fuzzy query param for: Reimbursement name
Page number	current	integer	Page number
Number of items per page	size	integer	Number of items per page
Ids of employees	employeeIdFilter	string	Ids of employees
Approval status filter, 0:Pending approval, 1:Rejected, 2: Approved, 3:Cancelled	reimbursementStatusFilter	string	Approval status filter, 0:Pending approval, 1:Rejected, 2: Approved, 3:Cancelled, 4:Deleted
Reimbursement name	reimbursementName	string	Reimbursement name
Ids of departments	departmentFilter	string	Ids of departments

Returns

Body: ResultIPageV2ExpenseResp

List of external payroll item projects

Operation ID:: getExtPayItemListV2

List of external payroll item projects

Parameters

Name	Key	Type	Description
Fuzzy query param for: name, code	q	string	Fuzzy query param for: name, code
Page number	current	integer	Page number
Number of items per page	size	integer	Number of items per page
Payment type: 0: Income, 1: Deduction, 2: Others	paymentType	string	Payment type: 0: Income, 1: Deduction, 2: Others
Status: 0: Disabled, 1: Enabled	status	string	Status: 0: Disabled, 1: Enabled

Returns

Body: ResultIPageV2ExtPayItemResp

List of external payroll items data

Operation ID:: getExtPayItemDataV2

List of external payroll items data

Parameters

Name	Key	Type	Description
Fuzzy query param for: name, code	q	string	Fuzzy query param for: name, code
Page number	current	integer	Page number
Number of items per page	size	integer	Number of items per page
Employee ID	employeeId	string	Employee ID
Employee code	employeeCode	string	Employee code
Business payroll item ID	businessSalaryItemId	string	Business payroll item ID
Employee filter condition	employeeIdFilter	string	Employee filter condition
Business payroll item filter condition	businessSalaryItemFilter	string	Business payroll item filter condition

Returns

Body: ResultIPageV2ExternalPayItemResp

List of fixed payroll items

Operation ID:: getFixedPayItemDataV2

List of fixed payroll items

Parameters

Name	Key	Type	Description
Fuzzy query param for: name, code	q	string	Fuzzy query param for: name, code
Page number	current	integer	Page number
Number of items per page	size	integer	Number of items per page
Employee ID	employeeId	string	Employee ID
Payroll item ID	payrollItemId	string	Payroll item ID

Returns

Body: ResultIPageV2FixedPayItemResp

List of leave application

Operation ID:: getLeaveApplicationListV2

List of leave application

Parameters

Name	Key	Type	Description
Search keywords	q	string	Search keywords
Page number	current	integer	Page number
Number of items per page	size	integer	Number of items per page
Employee Id	employeeId	string	Employee Id
Holiday Type ID	holidayType	string	Holiday Type ID
Approval Status (0: Under Approval, 1: Rejected, 2: Passed)	status	string	Approval Status (0: Under Approval, 1: Rejected, 2: Passed)
Leave Date	holidayDate	date	Leave Date

Returns

Body: ResultIPageV2LeaveApplicationResp

List of leave policies

Operation ID:: 14getLeavePolicyListV3

List of leave policies

Parameters

Name	Key	Type	Description
Fuzzy query param for: name	q	string	Fuzzy query param for: name
Page number	current	integer	Page number
Number of items per page	size	integer	Number of items per page
Name	name	string	Name

Returns

Body: ResultIPageV3LeavePolicyResp

List of leave types

Operation ID:: 13getLeaveTypeListV3

List of leave types

Parameters

Name	Key	Type	Description
Fuzzy query param for: name, shortName	q	string	Fuzzy query param for: name, shortName
Page number	current	integer	Page number
Number of items per page	size	integer	Number of items per page
Name	name	string	Name
Short name	shortName	string	Short name

Returns

Body: ResultIPageV3LeaveTypeResp

List of mobile card

Operation ID:: 07getAttendanceDataListV3

List of mobile card

Parameters

Name	Key	Type	Description
Search keywords (Employee name,Employee code,Employee email,Employee phone)	q	string	Search keywords (Employee name,Employee code,Employee email,Employee phone)
Page number	current	integer	Page number
Number of items per page	size	integer	Number of items per page
Department ID	departmentFilter	string	Department ID
Position ID	positionFilter	string	Position ID
Employee ID	employeeIdFilter	string	Employee ID
Work location ID	attendCalculationId	string	Work location ID
Label ID	bizLabelIds	string	Label ID
Employment Form (0: Full Time,1: Temporary, 2: Freelance, 3: Part Time, 4: Contr	hireTypeFilter	string	Employment Form (0: Full Time,1: Temporary, 2: Freelance, 3: Part Time, 4: Contract,5: Internship, 6: Virtual Employee)
Salary Calculation Method (0: Monthly 1: Hourly 2: Yearly 3: Daily 4: Weekly)	calculateSalaryTypeFilter	string	Salary Calculation Method (0: Monthly 1: Hourly 2: Yearly 3: Daily 4: Weekly)
Start date	startDate	date	Start date
End date	endDate	date	End date

Returns

Body: ResultIPageV3MobileCardListResp

List of office locations

Operation ID:: getWorkLocationListV2

List of office locations

Parameters

Name	Key	Type	Description
Search keywords	q	string	Search keywords
Page number	current	integer	Page number
Number of items per page	size	integer	Number of items per page
Address abbreviation	name	string	Address abbreviation
Code	attendanceAddressCode	string	Code
Status (0: Disabled, 1: Enabled)	status	string	Status (0: Disabled, 1: Enabled)

Returns

Body: ResultIPageV2WorkLocationResp

List of open shift

Operation ID:: 14getOpenShiftListV3

List of open shift

Parameters

Name	Key	Type	Description
Search keywords(Code,Remark,Project Name,Category Name,Cost center Name,Cost cen	q	string	Search keywords(Code,Remark,Project Name,Category Name,Cost center Name,Cost center code)
Page number	current	integer	Page number
Number of items per page	size	integer	Number of items per page
Project ID	projectId	string	Project ID
Work location ID	locationId	string	Work location ID
Cost center ID	costCenterId	string	Cost center ID
Date	date	date	Date

Returns

Body: ResultIPageV3OpenShiftListResp

List of payroll items

Operation ID:: getPayItemListV2

List of payroll items

Parameters

Name	Key	Type	Description
Fuzzy query param for: name	q	string	Fuzzy query param for: name
Page number	current	integer	Page number
Number of items per page	size	integer	Number of items per page
name	name	string	name
Status,0: disabled, 1:enabled, 2:deleted	status	string	Status,0: disabled, 1:enabled, 2:deleted

Returns

Body: ResultIPageV2PayItemResp

List of payroll plans

Operation ID:: getPayrunListV2

List of payroll plans

Parameters

Name	Key	Required	Type	Description
Page number	current		integer	Page number
Number of items per page	size		integer	Number of items per page
Payroll plan status, 0:Pending approval, 1:Verified � Pending Payment, 2:Paid	status	True	string	Payroll plan status, 0:Pending approval, 1:Verified � Pending Payment, 2:Paid

Returns

Body: ResultIPageV2PayrollPlanResp

List of positions

Operation ID:: getPositionListV2

List of positions

Parameters

Name	Key	Type	Description
Fuzzy query param for: name code	q	string	Fuzzy query param for: name code
Page number	current	integer	Page number
Number of items per page	size	integer	Number of items per page
Position name	name	string	Position name
Position code	positionCode	string	Position code

Returns

Body: ResultIPageV2PositionResp

List of project

Operation ID:: 23getProjectListV3

List of project

Parameters

Name	Key	Type	Description
Search keywords(Category name)	q	string	Search keywords(Category name)
Page number	current	integer	Page number
Number of items per page	size	integer	Number of items per page

Returns

Body: ResultIPageV3ProjectListResp

List of project category

Operation ID:: 19getProjectCategoryListV3

List of project category

Parameters

Name	Key	Type	Description
Search keywords(Name,Code)	q	string	Search keywords(Name,Code)
Page number	current	integer	Page number
Number of items per page	size	integer	Number of items per page

Returns

Body: ResultIPageV3ScheduleProjectCategoryListResp

List of project certificate

Operation ID:: 27getProjectCertificateListV3

List of project certificate

Parameters

Name	Key	Type	Description
Search keywords(Name,Email,Phone,Code,IdentityCard)	q	string	Search keywords(Name,Email,Phone,Code,IdentityCard)
Page number	current	integer	Page number
Number of items per page	size	integer	Number of items per page
Employee ID	employeeId	string	Employee ID
Department ID	departmentId	string	Department ID
Position ID	positionId	string	Position ID
Status (0 Resignation, 1 Employment)	status	integer	Status (0 Resignation, 1 Employment)
Employment Form (0: Full Time,1: Temporary, 2: Freelance, 3: Part Time, 4: Contr	hireType	string	Employment Form (0: Full Time,1: Temporary, 2: Freelance, 3: Part Time, 4: Contract,5: Internship, 6: Virtual Employee)
Project ID	projectId	string	Project ID

Returns

Body: ResultIPageV3ProjectCertificateListResp

List of project certificate hours by project certificate ID

Operation ID:: 30getProjectCertificateHourListV3

List of project certificate hours by project certificate ID

Parameters

Name	Key	Required	Type	Description
Project certificate ID	projectCertificateId	True	string	Project certificate ID
Page number	current		integer	Page number
Number of items per page	size		integer	Number of items per page

Returns

Body: ResultIPageV3ProjectCertificateHoursListResp

List of roster

Operation ID:: 05getRosterListV3

List of roster

Parameters

Name	Key	Type	Description
Search keywords	q	string	Search keywords
Page number	current	integer	Page number
Number of items per page	size	integer	Number of items per page
Attendance Date	attendDay	date	Attendance Date
Employee ID	employeeId	string	Employee ID
Attendance status (0: normal, 1: late, 2: overtime, 3: early leave, 4: absenteei	attendStatus	string	Attendance status (0: normal, 1: late, 2: overtime, 3: early leave, 4: absenteeism)
Shift Type (0: weekdays, 1: rest days, 2: statutory holidays)	dateType	string	Shift Type (0: weekdays, 1: rest days, 2: statutory holidays)

Returns

Body: ResultIPageV3RosterListResp

List of rosters

Operation ID:: getRosterDataListV2

List of rosters

Parameters

Name	Key	Required	Type	Description
Fuzzy query param for: name code	q		string	Fuzzy query param for: name code
Page number	current		integer	Page number
Number of items per page	size		integer	Number of items per page
Attend address id	attendCalculationId		string	Attend address id
Start date	startDate	True	date	Start date
End date	endDate	True	date	End date
Department id	departmentId		string	Department id
Position id	positionId		string	Position id
Employees' status filter, 1:on the job, 0: leave office	statusFilter		string	Employees' status filter, 1:on the job, 0: leave office
Employee's name	englishName		string	Employee's name
Employee's code	code		string	Employee's code
Employee's surname	surnameEnglish		string	Employee's surname
Employee's personal name	personalNameEnglish		string	Employee's personal name

Returns

Body: ResultListV2RosterResp

List of shift template

Operation ID:: 10getShiftTemplateListV3

List of shift template

Parameters

Name	Key	Type	Description
Search keywords(Name)	q	string	Search keywords(Name)
Page number	current	integer	Page number
Number of items per page	size	integer	Number of items per page
Work location ID	attendanceAddressId	string	Work location ID
Shift Type (0: weekdays, 1: rest days, 2: statutory holidays)	dateType	string	Shift Type (0: weekdays, 1: rest days, 2: statutory holidays)
Status (0: Disabled, 1: Enabled)	status	string	Status (0: Disabled, 1: Enabled)

Returns

Body: ResultIPageV3ShiftTemplateListResp

List of timesheet

Operation ID:: 13getTimesheetListV3

List of timesheet

Parameters

Name	Key	Type	Description
Search keywords (Employee name,Employee code,Employee email,Employee phone)	q	string	Search keywords (Employee name,Employee code,Employee email,Employee phone)
Page number	current	integer	Page number
Number of items per page	size	integer	Number of items per page
Department ID	departmentFilter	string	Department ID
Position ID	positionFilter	string	Position ID
Employee ID	employeeIdFilter	string	Employee ID
Label ID	bizLabelIds	string	Label ID
Employee status (0: Resignation,1: Employment)	statusFilter	string	Employee status (0: Resignation,1: Employment)
Salary Calculation Method (0: Monthly 1: Hourly 2: Yearly 3: Daily 4: Weekly)	calculateSalaryTypeFilter	string	Salary Calculation Method (0: Monthly 1: Hourly 2: Yearly 3: Daily 4: Weekly)
Start date	startDate	date	Start date
End date	endDate	date	End date
Work location ID	addressCardId	string	Work location ID
Application type (0: Overtime,1: Normal Hours,2: Break)	typeFilter	string	Application type (0: Overtime,1: Normal Hours,2: Break)

Returns

Body: ResultIPageV3TimesheetListResp

List of timesheet

Operation ID:: getTimesheetListV2

List of timesheet

Parameters

Name	Key	Type	Description
Search keywords	q	string	Search keywords
Page number	current	integer	Page number
Number of items per page	size	integer	Number of items per page
Employee Id	employeeId	string	Employee Id
Application Type (0: Overtime, 1: Normal Hours, 2: Break)	type	string	Application Type (0: Overtime, 1: Normal Hours, 2: Break)
Application Date	date	date	Application Date
Status (0: Under Approval, 1: Rejected, 2: Passed)	status	string	Status (0: Under Approval, 1: Rejected, 2: Passed)

Returns

Body: ResultIPageV2TimesheetResp

List of variable payroll items

Operation ID:: getVarPayItemDataV2

List of variable payroll items

Parameters

Name	Key	Type	Description
Fuzzy query param for: name, code	q	string	Fuzzy query param for: name, code
Page number	current	integer	Page number
Number of items per page	size	integer	Number of items per page
Employee ID	employeeId	string	Employee ID
Payroll item ID	payrollItemId	string	Payroll item ID
Employee ID filter condition	employeeIdFilter	string	Employee ID filter condition
Payroll item ID filter condition	payrollItemIdFilter	string	Payroll item ID filter condition
Payroll plan	payrollPlanId	string	Payroll plan

Returns

Body: ResultIPageV2VarPayItemResp

Query a user's info

Operation ID:: 003getUserInfoByIdV3

Query a user's info

Parameters

Name	Key	Required	Type	Description
user's id	id	True	string	user's id

Returns

Body: ResultV3SysEnterpriseUserResp

Query leave policy summary information

Operation ID:: 15getLeavePolicyInfoByIdV3

Query leave policy summary information

Parameters

Name	Key	Required	Type	Description
Leave policy id	id	True	string	Leave policy id

Returns

Body: ResultV3LeavePolicyDetailResp

Query list of leave types within a leave policy

Operation ID:: 16getLeavePolicyTypeListV3

Query list of leave types within a leave policy

Parameters

Name	Key	Required	Type	Description
Fuzzy search parameter: Name, Short Name	q		string	Fuzzy search parameter: Name, Short Name
Page number	current		integer	Page number
Number of items per page	size		integer	Number of items per page
id	id		string	id
Leave Policy ID (required)	regulationId	True	string	Leave Policy ID (required)
Leave Type ID	holidayId		string	Leave Type ID
Generation frequency: 0 - Monthly calculation, 1 - Annual calculation	generationFrequency		string	Generation frequency: 0 - Monthly calculation, 1 - Annual calculation

Returns

Body: ResultIPageV3LeavePolicyTypeResp

Query tenant information

Operation ID:: getTenantInfoV2

Query tenant information

Returns

Body: ResultV2TenantResp

Query tenant information

Operation ID:: 001getCompanyInfoV3

Query tenant information

Returns

Body: ResultV3TenantResp

Query users' info

Operation ID:: 002getUserListV3

Query users' info

Returns

Body: ResultListV3SysEnterpriseUserResp

Resign

Operation ID:: 06resignV3

Resign

Parameters

Name	Key	Required	Type	Description
id	id	True	string	Employee ID
lastWorkingDate	lastWorkingDate	True	date	Termination Date
reasonsLeave	reasonsLeave	True	string	Reason for leaving
remark	remark		string	Remarks

Returns

Body: ResultBoolean

Update a cost center

Operation ID:: updateCostCenterInfoV2

Update a cost center

Parameters

Name	Key	Required	Type	Description
id	id	True	string	Id
name	name		string	Name
costCenterCode	costCenterCode		string	Code
status	status		string	Status, 0:disabled, 1: enabled

Returns

Body: ResultBoolean

Update a cost center

Operation ID:: 020updateCostCenterByIdV3

Update a cost center

Parameters

Name	Key	Required	Type	Description
id	id	True	string	ID
name	name		string	Name
costCenterCode	costCenterCode		string	Cost Center Code
status	status		string	Status, 0:Disabled, 1:Enabled

Returns

Body: ResultBoolean

Update a department

Operation ID:: 012updateDepartmentByIdV3

Update a department

Parameters

Name	Key	Required	Type	Description
id	id	True	string	ID
name	name		string	Department Name
departmentCode	departmentCode		string	Department Code
status	status		string	Status, 0:Disabled, 1:Enabled
parentId	parentId		string	Parent Department ID

Returns

Body: ResultBoolean

Update a location

Operation ID:: 006updateLocationByIdV3

Update a location

Parameters

Name	Key	Required	Type	Description
id	id	True	string	ID
name	name		string	Address Abbreviation
address	address		string	Detailed Address
longitude	longitude		number	Longitude
latitude	latitude		number	Latitude
region	region		integer	Check In Range
isEnableGps	isEnableGps		boolean	Is GPS Enabled, 0:Disabled, 1:Enabled
isEnableBluetooth	isEnableBluetooth		boolean	Is Bluetooth Enabled, 0:Disabled, 1:Enabled
attendanceAddressCode	attendanceAddressCode		string	Attendance Address Code
status	status		string	Status, 0:Disabled, 1:Enabled
mapType	mapType		string	Map Type, 0:Baidu Map; 1:Google Map; 2:Gaode Map
areaCode	areaCode		string	Region Code (e.g., HK for Hong Kong, AU for Australia, MO for Macau, TW for Taiwan)

Returns

Body: ResultBoolean

Update a position by id

Operation ID:: 016updatePositionByIdV3

Update a position by id

Parameters

Name	Key	Required	Type	Description
id	id	True	string	ID
name	name		string	Position Name
positionCode	positionCode		string	Position Code
status	status		string	Status, 0:Disabled, 1:Enabled

Returns

Body: ResultBoolean

Update a roster

Operation ID:: updateRosterDataV2

Update a roster

Parameters

Name	Key	Required	Type	Description
id	id	True	string	Id
shiftIn	shiftIn		string	Shift in
shiftOff	shiftOff		string	Shift off
mealTime	mealTime		integer	Meal time
shiftStatus	shiftStatus		string	Shift status
addressCardId	addressCardId		string	Address card id
remark	remark		string	Remark
dateType	dateType		string	Date type
acrossTheNight	acrossTheNight		string	Across the night

Returns

Body: ResultBoolean

Update a tag

Operation ID:: 024updateTagByIdV3

Update a tag

Parameters

Name	Key	Required	Type	Description
id	id	True	string	ID
labelCode	labelCode		string	Label Code
labelName	labelName		string	Label Name
labelStatus	labelStatus		integer	Label Status, 0:Disabled, 1:Enabled
parentId	parentId		string	Parent Label ID

Returns

Body: ResultBoolean

Update calendar remark by ID

Operation ID:: 17updateCalendarRemarkByIdV3

Update calendar remark by ID

Parameters

Name	Key	Required	Type	Description
id	id	True	string	ID
employeeId	employeeId	True	string	Employee ID/Name/Code
employeeStatus	employeeStatus	True	string	Employee status (0: Free,1: Be busy)
timeType	timeType	True	string	Time type (0: One day,1: many days)
startDate	startDate		date	Start date
endDate	endDate		date	End date
recordDate	recordDate		date	Record date
expectWorkLocation	expectWorkLocation		string	Expected work location ID/Name/Code
expectWorkTimeTemplate	expectWorkTimeTemplate		string	Expected work template ID/Name/Code
expectWorkStartTime	expectWorkStartTime	True	string	Expected start time
expectWorkEndTime	expectWorkEndTime	True	string	Expected end time
remark	remark		string	Remarks

Returns

Body: ResultBoolean

Update check-in information

Operation ID:: updateCardByIdV2

Update check-in information

Parameters

Name	Key	Required	Type	Description
id	id	True	string	Id
isInValid	isInValid		boolean	Is It Invalid
remark	remark		string	Remarks

Returns

Body: ResultBoolean

Update Department

Operation ID:: updateDepartmentInfoV2

Update Department

Parameters

Name	Key	Required	Type	Description
id	id	True	string	id
name	name		string	Department Name
departmentCode	departmentCode		string	code
parentId	parentId		string	Parent department Id
status	status		string	Status (0: Disabled, 1: Enabled)

Returns

Body: ResultBoolean

Update employee

Operation ID:: updateEmployeeInfoV2

Update employee

Parameters

Name	Key	Required	Type	Description
id	id	True	string	Id
englishName	englishName		string	English Name
chineseName	chineseName		string	Chinese Name
sex	sex		string	Sex
address	address		string	Residential Area
code	code		string	Code
identityCard	identityCard		string	Identity Card
bankCard	bankCard		string	Bank Card
nickName	nickName		string	Nickname
education	education		string	Education Level (0: Form 3/Certificate, 1: Form 5/Certificate, 2: Hong Kong Diploma Of Secondary Education/Form 7/Diploma, 3: Associate Degree/Advanced Diploma, 4: Bachelor's Degree, 5: Master's Degree, 6: Doctoral Degree)
nationality	nationality		string	Nationality
maritalStatus	maritalStatus		string	Marital Status (0: Single 1: Married 2: Divorced 3: Widowed)
emergencyContactName	emergencyContactName		string	Emergency Contact Name
emergencyContactRelation	emergencyContactRelation		string	Relationship
emergencyContactPhone	emergencyContactPhone		string	Emergency Contact Phone
bankName	bankName		string	Bank Name
bankBranchNumber	bankBranchNumber		string	Bank Branch Number
bankAccountNo	bankAccountNo		string	Bank Account
bankCode	bankCode		string	Bank Number
remark	remark		string	Notes
regionCode	regionCode		string	Area Code
identityCardHk	identityCardHk		string	Hong Kong Identity Card No
passportNumber	passportNumber		string	Passport Number
passportIssuingPlace	passportIssuingPlace		string	Passport Issuance Location
spouseName	spouseName		string	Name Of Spouse
spouseIdentityCardHk	spouseIdentityCardHk		string	Spouse's Hong Kong Identity Card No
spousePassportNumber	spousePassportNumber		string	Spouse Passport Number
spousePassportIssuingPlace	spousePassportIssuingPlace		string	Spouse's Passport Issuance Location
postalAddress	postalAddress		string	Mail Address
employerName	employerName		string	Employer Name
hometown	hometown		string	Native Place
nation	nation		string	Nationality
politicalStatus	politicalStatus		string	Political Status
highestEducation	highestEducation		string	Highest Education Level
workDate	workDate		date	Date Of Employment (specified Seniority Calculation Date)
confirmationDate	confirmationDate		date	Date Of Confirmation
probation	probation		string	Trial Period
isDisabled	isDisabled		boolean	Are You A Person With Disabilities
isForeignNationality	isForeignNationality		boolean	Are You A Foreigner
domicileLocation	domicileLocation		string	Registered Residence
certificateType	certificateType		string	Id Type
certificateNumber	certificateNumber		string	Id No
isMartyrDependents	isMartyrDependents		boolean	Is It A Martyr's Family
occupationTaxNumber	occupationTaxNumber		string	Occupational Tax Number
nonLocalBlueCardNumber	nonLocalBlueCardNumber		string	Non Local Employee Id Card (blue Card) Number
isForeignEmployees	isForeignEmployees		boolean	Are You A Non Local Employee
weeklyLeaveWorkAgreement	weeklyLeaveWorkAgreement		string	Weekly Leave Work Agreement
employeeType	employeeType		string	Employee Classification
jobLevel	jobLevel		string	Job Grade
post	post		string	Position
salaryScale	salaryScale		string	Salary Scale
jobTitle	jobTitle		string	Job Title
recruitmentSource	recruitmentSource		string	Recruitment Source
graduatedSchool	graduatedSchool		string	Alma Mater
profession	profession		string	Major
appellation	appellation		string	Appellation
middleName	middleName		string	Middle Name
homePhone	homePhone		string	Home Phone
officePhone	officePhone		string	Office Phone
country	country		string	Country
province	province		string	Province
city	city		string	City
postcode	postcode		string	Postal Code
contractEndDate	contractEndDate		date	Contract End Date
taxIdentity	taxIdentity		string	Tax Identity
otherIncomeName	otherIncomeName		string	Naming Of Other Types Of Income

Returns

Body: ResultBoolean

Update employee history

Operation ID:: 09updateEmployeeHistoryByIdV3

Update employee history

Parameters

Name	Key	Required	Type	Description
id	id	True	string	ID
employeeId	employeeId	True	string	Employee ID/Name/Code
entryDate	entryDate	True	date	Join Date
confirmationDate	confirmationDate		date	Regularization Date
hireType	hireType		string	Employment Type (0: Full Time,1: Temporary, 2: Freelance, 3: Part Time, 4: Contract,5: Internship, 6: Virtual Employee)
positionId	positionId		string	Position ID/Name/Code
departmentId	departmentId		string	Department ID/Name/Code
directSupervisorId	directSupervisorId		string	Manager ID/Name/Code
attendCalculationId	attendCalculationId		string	Location ID/Name/Code
payrollRegulationId	payrollRegulationId		string	Payroll Policy ID/Name/Code
basicPay	basicPay		number	Basic Salary
calculateSalaryType	calculateSalaryType		string	Salary Type (0: Monthly 1: Hourly 2: Yearly 3: Daily 4: Weekly)
costCenterId	costCenterId		string	Cost center ID/Name/Code
workDate	workDate		date	Date of seniority calculation
cause	cause		string	Cause
majorWorkLocationId	majorWorkLocationId		string	Major Location ID/Name/Code

Returns

Body: ResultBoolean

Update employee information

Operation ID:: 03updateEmployeeByIdV3

Update employee information

Parameters

Name	Key	Required	Type	Description
entryDate	entryDate	True	date	Join Date
englishName	englishName	True	string	Name (display name)
email	email	True	string	Email Address
employeeStatus	employeeStatus		string	Employment Status (0: Terminated,1: Active)
sex	sex		string	Gender (0: Male,1: Female,2: Unspecified)
nationality	nationality		string	Country / Region
maritalStatus	maritalStatus		string	Marital Status (0: Single 1: Married 2: Divorced 3: Widowed)
countryCode	countryCode		string	Country / Region Code
phone	phone		string	Phone Number
calculateSalaryType	calculateSalaryType		string	Salary Type (0: Monthly 1: Hourly 2: Yearly 3: Daily 4: Weekly)
workDate	workDate		date	Date of seniority calculation
basicPay	basicPay		number	Basic Salary
code	code		string	Staff ID
identityCard	identityCard		string	HKID/Passport No.
chineseName	chineseName		string	Chinese Name
surnameEnglish	surnameEnglish		string	Surname(ID card)
personalNameEnglish	personalNameEnglish		string	Given Name(ID card)
birthday	birthday		string	Birthday
address	address		string	Home Address
emergencyContactName	emergencyContactName		string	Emergency Contact
emergencyContactRelation	emergencyContactRelation		string	Relationship
emergencyContactPhone	emergencyContactPhone		string	Emergency Contact Phone No.
bankCode	bankCode		string	Bank Code
bankBranchNumber	bankBranchNumber		string	Bank Branch Code
bankAccountNo	bankAccountNo		string	Bank Account No.
confirmationDate	confirmationDate		date	Regularization Date
date1	date1		date	Date1
date2	date2		date	Date2
date3	date3		date	Date3
date4	date4		date	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
directSupervisorId	directSupervisorId		string	Manager ID/Name/Code
departmentId	departmentId		string	Department ID/Name/Code
positionId	positionId		string	Position ID/Name/Code
hireType	hireType		string	Employment Type (0: Full Time,1: Temporary, 2: Freelance, 3: Part Time, 4: Contract,5: Internship, 6: Virtual Employee)
payrollRegulationId	payrollRegulationId		string	Payroll Policy ID/Name/Code
costCenterId	costCenterId		string	Cost Center ID/Name/Code
attendCalculationId	attendCalculationId		string	Location ID/Name/Code
mobileCardCalType	mobileCardCalType		string	Field Clocking Calculation Formula (1: Not counting working hours,2: Direct working hours,3: Work hours after approval)
regularType	regularType		string	Leave Policy ID/Name/Code
insurePlanName	insurePlanName		string	MPF Scheme ID/Name/Code
bizLabelIds	bizLabelIds		string	Tag ID/Name/Code

Returns

Body: ResultBoolean

Update expense application

Operation ID:: updateExpenseApplicationV2

Update expense application

Parameters

Name	Key	Type	Description
id	id	string	Id
reimbursementName	reimbursementName	string	Reimbursement name
amount	amount	number	Reimbursement amount
remark	remark	string	Reimbursement reason

Returns

Body: ResultBoolean

Update expense application by ID

Operation ID:: 04updateExpenseApplicationByIdV3

Update expense application by ID

Parameters

Name	Key	Required	Type	Description
id	id	True	string	ID
reimbursementType	reimbursementType		string	Reimbursement type ID, name
reimbursementDate	reimbursementDate		date	Reimbursement Date
reimbursementName	reimbursementName		string	Reimbursement Name
amount	amount		number	Reimbursement Amount
remark	remark		string	Reason

Returns

Body: ResultBoolean

Update external payroll item data

Operation ID:: updateExternalSalaryV2

Update external payroll item data

Parameters

Name	Key	Type	Description
id	id	string	ID
code	code	string	Code
money	money	number	Amount
occurrenceDate	occurrenceDate	date	Occurrence date
remark	remark	string	Remarks
expirationDate	expirationDate	date	Expiration date

Returns

Body: ResultBoolean

Update External Salary Data By Id

Operation ID:: 011updateExternalSalaryDataByIdV3

Update External Salary Data By Id

Parameters

Name	Key	Required	Type	Description
id	id	True	string	id
code	code		string	number
employeeId	employeeId		string	employee ID, employee name
businessSalaryItemId	businessSalaryItemId		string	business payroll item ID, business payroll item name
money	money		number	amount
occurrenceDate	occurrenceDate		date	occurrence date
remark	remark		string	remark
expirationDate	expirationDate		date	expiration date

Returns

Body: ResultBoolean

Update fixed payroll item

Operation ID:: updateFixedSalaryV2

Update fixed payroll item

Parameters

Name	Key	Required	Type	Description
id	id	True	string	ID
payrollItemId	payrollItemId		string	Payroll item ID
money	money		number	Amount
startDate	startDate		date	Start date
endDate	endDate		date	End date

Returns

Body: ResultBoolean

Update fixed salary data by id

Operation ID:: 003updateFixedSalaryDataByIdV3

Update fixed salary data by id

Parameters

Name	Key	Required	Type	Description
id	id	True	string	id
payrollItemId	payrollItemId		string	Salary item ID, salary item name
money	money		number	amount
startDate	startDate		date	start date
endDate	endDate		date	end date
totalLimitAmount	totalLimitAmount		number	total limit amount
paidAmount	paidAmount		number	paid amount
surplusAmount	surplusAmount		number	surplus amount

Returns

Body: ResultBoolean

Update label

Operation ID:: updateLabelInfoV2

Update label

Parameters

Name	Key	Required	Type	Description
id	id	True	string	ID
labelCode	labelCode		string	Label code
labelName	labelName		string	Label name
labelStatus	labelStatus		integer	Label status: 0 Disabled, 1 Enabled

Returns

Body: ResultBoolean

Update leave application

Operation ID:: updateLeaveApplicationV2

Update leave application

Parameters

Name	Key	Required	Type	Description
id	id	True	string	Id
holidayType	holidayType		string	Holiday Type ID
startDate	startDate		date	Start Date
startTime	startTime		string	Start Time
endDate	endDate		date	End Date
endTime	endTime		string	End Time
leaveTime	leaveTime		number	Leave Duration
timeType	timeType		string	Duration Type (0: One Day 1: Multiple Days)
remark	remark		string	Reason
holidayDate	holidayDate		date	Leave Date
time	time		string	Leave Time

Returns

Body: ResultBoolean

Update leave application by ID

Operation ID:: 09updateLeaveApplicationByIdV3

Update leave application by ID

Parameters

Name	Key	Required	Type	Description
id	id	True	string	Leave ID
holidayType	holidayType		string	Holiday Type ID, Name, Short Name
startDate	startDate		date	Start Date
startTime	startTime		string	Start Time am:Morning pm:Afternoon allDay:All Day
endDate	endDate		date	End Date
endTime	endTime		string	End Time am:Morning pm:Afternoon allDay:All Day
leaveTime	leaveTime		number	Leave Duration
timeType	timeType		string	Duration Type 0:One day 1:Multiple days
holidayDate	holidayDate		date	Date for single-day leave
time	time		string	Time for single-day leave am:Morning pm:Afternoon allDay:All Day
remark	remark		string	Reason

Returns

Body: ResultBoolean

Update mobile card By ID

Operation ID:: 06updateAttendanceDataByIdV3

Update mobile card By ID

Parameters

Name	Key	Required	Type	Description
id	id	True	string	ID
date	date		date-time	Mobile card date
mode	mode		string	Check in method (0: GPS,1: Bluetooth,2: Wifi,3: QR code,4: Field check-in,5: Face recognition)
cardType	cardType		string	Mobile card type (1: Clock-in,2: Clock-out)
actualLongitude	actualLongitude		number	Longitude
actualLatitude	actualLatitude		number	Latitude
deviceName	deviceName		string	Equipment name
codeSource	codeSource		string	QR code source
locationName	locationName		string	Field location name
workLocationId	workLocationId		string	Work location ID/Name/Code
deviceId	deviceId		string	Bind device ID

Returns

Body: ResultBoolean

Update office location

Operation ID:: updateWorkLocationV2

Update office location

Parameters

Name	Key	Required	Type	Description
id	id	True	string	Id
name	name		string	Address Abbreviation
region	region		integer	Check In Range
attendanceAddressCode	attendanceAddressCode		string	Code
status	status		string	Status (0: Disabled, 1: Enabled)
areaCode	areaCode		string	Region Code

Returns

Body: ResultBoolean

Update open shift

Operation ID:: 13updateOpenShiftByIdV3

Update open shift

Parameters

Name	Key	Required	Type	Description
id	id	True	string	ID
code	code		string	Code
projectId	projectId	True	string	Project ID/Name/Code
locationId	locationId		string	Work location ID/Name/Code
shiftType	shiftType		string	Shift Type (0: weekdays, 1: rest days, 2: statutory holidays)
mealTime	mealTime		integer	Meal duration
startTime	startTime	True	time	Start Time
endTime	endTime	True	time	End Time
hourlyRate	hourlyRate	True	number	Hourly rate
empPlanNo	empPlanNo	True	integer	Planned number of employees
costCenterId	costCenterId		string	Cost center ID/Name/Code
remark	remark		string	Remarks

Returns

Body: ResultBoolean

Update position information

Operation ID:: updatePositionInfoV2

Update position information

Parameters

Name	Key	Required	Type	Description
id	id	True	string	Id
name	name		string	Name
positionCode	positionCode		string	Code
status	status		string	Status, 0:disabled, 1:enabled

Returns

Body: ResultBoolean

Update project category information

Operation ID:: 18updateProjectCategoryByIdV3

Update project category information

Parameters

Name	Key	Required	Type	Description
id	id	True	string	ID
name	name	True	string	Name
code	code		string	Code
parentId	parentId		string	Parent category ID/Name/Code

Returns

Body: ResultBoolean

Update project certificate information

Operation ID:: 26updateProjectCertificateByIdV3

Update project certificate information

Parameters

Name	Key	Required	Type	Description
id	id	True	string	ID
tier	tier		string	Tier
tierRate	tierRate		number	Tier rate

Returns

Body: ResultBoolean

Update project information

Operation ID:: 22updateProjectByIdV3

Update project information

Parameters

Name	Key	Required	Type	Description
id	id	True	string	ID
code	code	True	string	Code
categoryId	categoryId		string	Category ID/Name/Code
name	name	True	string	Name
hourlyRate	hourlyRate	True	number	Hourly rate
minRate	minRate		number	Min hourly rate
maxRate	maxRate		number	Max hourly rate

Returns

Body: ResultBoolean

Update roster information

Operation ID:: 04updateRosterInfoByIdV3

Update roster information

Parameters

Name	Key	Required	Type	Description
id	id	True	string	ID
shiftTemplateId	shiftTemplateId		string	Shift Template ID/Name/Code
addressCardId	addressCardId		string	Work Location ID/Name/Code
shiftIn	shiftIn	True	time	Start Time
shiftOff	shiftOff	True	time	End Time
mealTime	mealTime		integer	Meal duration
shiftStatus	shiftStatus		string	Shift Status (0: Published, 1: Unpublished)
dateType	dateType		string	Shift Type (0: weekdays, 1: rest days, 2: statutory holidays)
attendanceItemId	attendanceItemId		string	Project ID/Name/Code
hourlyRate	hourlyRate		number	Hourly Rate
costCenterId	costCenterId		string	Cost Center ID/Name/Code
tierRate	tierRate		number	Tier Rate
scheduledAmount	scheduledAmount		number	Scheduled Amount
remark	remark		string	Remarks

Returns

Body: ResultBoolean

Update roster item

Operation ID:: updateRosterItemV2

Update roster item

Parameters

Name	Key	Required	Type	Description
id	id	True	string	ID
name	name		string	Item name
code	code		string	Item code

Returns

Body: ResultBoolean

Update shift template

Operation ID:: updateShiftTemplateV2

Update shift template

Parameters

Name	Key	Required	Type	Description
id	id	True	string	Shift ID
name	name		string	Shift name
shiftIn	shiftIn		string	Start time
shiftOff	shiftOff		string	End time
mealTime	mealTime		integer	Meal duration (minutes)
attendanceAddressId	attendanceAddressId		string	Attendance location ID
dateType	dateType		string	Date type: 0: Weekdays, 1: Rest Days, 2: Statutory Holiday
lunchStartTime	lunchStartTime		string	Lunch start time
lunchEndTime	lunchEndTime		string	Lunch end time

Returns

Body: ResultBoolean

Update shift template

Operation ID:: 09updateShiftTemplateByIdV3

Update shift template

Parameters

Name	Key	Required	Type	Description
id	id	True	string	ID
name	name	True	string	Name
shiftIn	shiftIn	True	time	Start Time
shiftOff	shiftOff	True	time	End Time
dateType	dateType		string	Shift Type (0: weekdays, 1: rest days, 2: statutory holidays)
attendanceAddressId	attendanceAddressId		string	Work location ID/Name/Code
mealTime	mealTime		integer	Meal duration
remark	remark		string	Remark

Returns

Body: ResultBoolean

Update tenant information

Operation ID:: updateTenantInfoV2

Update tenant information

Parameters

Name	Key	Type	Description
name	name	string	Name
businessRegistrationNumber	businessRegistrationNumber	string	Business registration number
address	address	string	Address
bankName	bankName	string	Bank name
bankBranchCode	bankBranchCode	string	Bank branch number
bankAccountNo	bankAccountNo	string	Bank Account

Returns

Body: ResultBoolean

Update timesheet

Operation ID:: updateTimesheetV2

Update timesheet

Parameters

Name	Key	Required	Type	Description
id	id	True	string	Id
date	date		date	Application Date
isCrossTheSky	isCrossTheSky		boolean	Whether To Cross The Night (0: No, 1:Yes)
startTime	startTime		date-time	Start Time
endTime	endTime		date-time	End Time
mealTime	mealTime		integer	Meal Duration

Returns

Body: ResultBoolean

Update timesheet by ID

Operation ID:: 12updateTimesheetByIdV3

Update timesheet by ID

Parameters

Name	Key	Required	Type	Description
id	id	True	string	ID
type	type	True	string	Application type (0: Overtime,1: Normal Hours,2: Break)
workOverTimeType	workOverTimeType		string	Overtime type (0: Working Overtime On Weekdays,1: Working Overtime On Rest Days,2: Working Overtime On Statutory Holidays)
date	date	True	date	Application date
startTime	startTime	True	date-time	Start time
endTime	endTime	True	date-time	End time
mealTime	mealTime		integer	Meal time
addressCardId	addressCardId		string	Work location ID/Name/Code
attendanceItemId	attendanceItemId		string	Item ID/Name/Code
costCenterId	costCenterId		string	Cost center ID/Name/Code
remark	remark		string	Remarks

Returns

Body: ResultBoolean

Update variable payroll item

Operation ID:: updateVarSalaryV2

Update variable payroll item

Parameters

Name	Key	Required	Type	Description
id	id	True	string	ID
money	money		number	Amount
remark	remark		string	Reason

Returns

Body: ResultBoolean

Update Variable Salary Data By Id

Operation ID:: 007updateVariableSalaryDataByIdV3

Update Variable Salary Data By Id

Parameters

Name	Key	Required	Type	Description
id	id	True	string	id
money	money		number	amount
remark	remark		string	reason

Returns

Body: ResultBoolean

Update Work Pattern By Id

Operation ID:: 023updateWorkPatternByIdV3

Update Work Pattern By Id

Parameters

Name	Key	Required	Type	Description
id	id	True	string	id
advancedSetting	advancedSetting		string	advanced settings
number	number		string	number
name	name		string	name
workHoursForDay	workHoursForDay		number	working hours per day
workHoursForWeek	workHoursForWeek		number	working hours per week
workHoursForYear	workHoursForYear		number	working hours per year
totalHours	totalHours		number	total working hours
cycleType	cycleType		string	cycle type 0: Once a month, 1: Multiple times a month, 2: Weekly salary, 3: New every two weeks, 4: Half a month
fte	fte		string	FTE
status	status		string	status 0 effective 1 disabled
salaryCalculationStyle	salaryCalculationStyle		integer	Salary calculation method 0: by time, 1: by office location, 2: by project
workTime	workTime		integer	working time
doubleWeekBaseDate	doubleWeekBaseDate		date-time	base date for biweekly cycle
weekSalaryType	weekSalaryType		string	weekly salary type
isThisWeek	isThisWeek		integer	whether current week is single week, 0: It's next week; 1: It's this week
termsWorkDefaultId	termsWorkDefaultId		string	default work terms id
id	id	True	string	id
amount	amount		number	payroll amount
workHours	workHours		number	working hours
shiftTemplateId	shiftTemplateId		string	shift template id
daySign	daySign		string	day sign. Monday to Sunday are (1, 2, 3, 4, 5, 6, 7), biweekly is (8, 9, 10, 11, 12, 13, 14), and public holidays are 15

Returns

Body: ResultBoolean

View attendance configuration

Operation ID:: 01getAttendanceConfigurationListV3

View attendance configuration

Returns

Body: ResultV3BizAttendanceConfigureResp

Definitions

ResultBoolean

Name	Path	Type
code	code	integer
message	message	string
data	data	boolean

IPageV2WorkLocationResp

Name	Path	Type
size	size	integer
current	current	integer
pages	pages	integer
total	total	integer
records	records	array of V2WorkLocationResp

ResultIPageV2WorkLocationResp

Name	Path	Type
code	code	integer
message	message	string
data	data	IPageV2WorkLocationResp

V2WorkLocationResp

Office location

Name	Path	Type	Description
id	id	string	Id
name	name	string	Address Abbreviation
address	address	string	Detailed Address
longitude	longitude	number	Longitude
latitude	latitude	number	Latitude
region	region	integer	Check In Range
isEnableGps	isEnableGps	boolean	Is Gps Enabled (0: Disabled, 1: Enabled)
isEnableBluetooth	isEnableBluetooth	boolean	Is Bluetooth Enabled (0: Disabled, 1: Enabled)
attendanceAddressCode	attendanceAddressCode	string	Code
status	status	string	Status (0: Disabled, 1: Enabled)
areaType	areaType	string	Regional Type (1: Domestic; 0: Overseas)

IPageV2TimesheetResp

Name	Path	Type
size	size	integer
current	current	integer
pages	pages	integer
total	total	integer
records	records	array of V2TimesheetResp

ResultIPageV2TimesheetResp

Name	Path	Type
code	code	integer
message	message	string
data	data	IPageV2TimesheetResp

V2TimesheetResp

Time sheet

Name	Path	Type	Description
id	id	string	Id
employeeId	employeeId	string	Employee Id
englishName	englishName	string	Employee Name
type	type	string	Application Type (0: Overtime, 1: Normal Hours, 2: Break)
date	date	date	Application Date
isCrossTheSky	isCrossTheSky	boolean	Whether To Cross The Night (0: No, 1:Yes)
startTime	startTime	date-time	Start Time
endTime	endTime	date-time	End Time
times	times	number	Times
status	status	string	Status (0: Under Approval, 1: Rejected, 2: Passed)
remark	remark	string	Reason
mealTime	mealTime	integer	Meal Duration
addressCardId	addressCardId	string	Office Check-In Location Id
addressCardName	addressCardName	string	Name Of Office Check-In Location

ResultListV2RosterResp

Name	Path	Type
code	code	integer
message	message	string
data	data	array of V2RosterResp

V2RosterResp

Rosters

Name	Path	Type	Description
id	id	string	Id
employeeId	employeeId	string	Employee id
positionName	positionName	string	Employee's position name
departmentName	departmentName	string	Employee's department name
employeeEnglishName	employeeEnglishName	string	Employee name
employeeCode	employeeCode	string	Employee code
attendDay	attendDay	date	Attend day
shiftTemplateId	shiftTemplateId	string	Shift template id
shiftTemplateName	shiftTemplateName	string	Shift template name
shiftIn	shiftIn	string	Shift in
shiftOff	shiftOff	string	Shift off
lateStart	lateStart	integer	Late start
earlyStart	earlyStart	integer	Early start
earliestCard	earliestCard	date-time	Earliest card
lateCard	lateCard	date-time	Late card
actualIn	actualIn	date-time	Actual in
actualOff	actualOff	date-time	Actual off
beLateLength	beLateLength	number	BeLate length
leaveEarlyLength	leaveEarlyLength	number	Leave early length
shiftLabor	shiftLabor	number	Shift labor
laborLength	laborLength	number	Labor length
attendStatus	attendStatus	string	AttendStatus, 0:normal,1: be late, 2: overtime, 3:leave early, 4:absentee
mealTime	mealTime	integer	Meal time
shiftStatus	shiftStatus	string	Shift status, 0: published, 1:not published
acrossTheNight	acrossTheNight	string	Across the night, 1:yes, 0: no
remark	remark	string	Remark
isLeave	isLeave	integer	Include leave
scheduleInfo	scheduleInfo	string	Schedule info
attendanceItemId	attendanceItemId	string	Attendance item id
attendanceItemName	attendanceItemName	string	Attendance item name
actualDuration	actualDuration	string	Actual working hours
dateType	dateType	string	Date type, 0: working day, 1: rest day, 2: legal holiday
existsTimesheet	existsTimesheet	boolean	Exists time sheets
existsLeave	existsLeave	boolean	Exists leave
existsStatutoryLeave	existsStatutoryLeave	boolean	Exists statutory leave

IPageV2PositionResp

Name	Path	Type
size	size	integer
current	current	integer
pages	pages	integer
total	total	integer
records	records	array of V2PositionResp

ResultIPageV2PositionResp

Name	Path	Type
code	code	integer
message	message	string
data	data	IPageV2PositionResp

V2PositionResp

Positions

Name	Path	Type	Description
id	id	string	id
name	name	string	name
positionCode	positionCode	string	code
status	status	string	status, 0:disabled, 1:enabled

IPageV2ExpenseResp

Name	Path	Type
size	size	integer
current	current	integer
pages	pages	integer
total	total	integer
records	records	array of V2ExpenseResp

ResultIPageV2ExpenseResp

Name	Path	Type
code	code	integer
message	message	string
data	data	IPageV2ExpenseResp

V2ExpenseResp

Reimbursements

Name	Path	Type	Description
id	id	string	Id
employeeId	employeeId	string	Employee id
code	code	string	Employee code
reimbursementType	reimbursementType	string	Reimbursement type
reimbursementTypeName	reimbursementTypeName	string	Reimbursement type name
reimbursementDate	reimbursementDate	date	Reimbursement date
reimbursementName	reimbursementName	string	Reimbursement name
reimbursementCode	reimbursementCode	string	Reimbursement code
amount	amount	number	amount
remark	remark	string	remark
status	status	string	Approval status, 0: pending, 1: refused, 2: approved
englishName	englishName	string	English name
chineseName	chineseName	string	Chinese name
reason	reason	string	Refuse reason
employeeCode	employeeCode	string	Employee code
departmentName	departmentName	string	Department name
positionName	positionName	string	Position name

IPageV2CostCenterResp

Name	Path	Type
size	size	integer
current	current	integer
pages	pages	integer
total	total	integer
records	records	array of V2CostCenterResp

ResultIPageV2CostCenterResp

Name	Path	Type
code	code	integer
message	message	string
data	data	IPageV2CostCenterResp

V2CostCenterResp

Cost centers

Name	Path	Type	Description
id	id	string	Id
name	name	string	Name
costCenterCode	costCenterCode	string	Code
status	status	string	Status, 0:disabled, 1: enabled

ResultV2TenantResp

Name	Path	Type	Description
code	code	integer
message	message	string
data	data	V2TenantResp	Tenant information

V2TenantResp

Tenant information

Name	Path	Type	Description
id	id	string	Id
name	name	string	Name
businessRegistrationNumber	businessRegistrationNumber	string	Business registration number
countryCode	countryCode	string	Country/Region Code
phone	phone	string	Phone
email	email	string	Email
address	address	string	Address
logo	logo	string	Logo
region	region	string	Preset region
timeZone	timeZone	string	Time zone Id
realTimeZone	realTimeZone	string	Time zone
zoneName	zoneName	string	Time zone name
bankName	bankName	string	Bank name
bankBranchCode	bankBranchCode	string	Bank branch number
bankAccountNo	bankAccountNo	string	Bank Account
employerName	employerName	string	Employer's Name
employerPosition	employerPosition	string	Employer Position
employerFileNumber	employerFileNumber	string	Employer file number
mainLanguage	mainLanguage	string	Pre set data master language field
currencyCode	currencyCode	string	Currency
accountType	accountType	string	Account Type
paymentCode	paymentCode	string	Payment code
paymentReference	paymentReference	string	Payment reference
legalNameOfEnterprise	legalNameOfEnterprise	string	Legal name of the enterprise
area	area	string	Legal name of the enterprise
is57ACompany	is57ACompany	string	Is it a 57A enterprise (0: No, 1: Yes)
branchNum	branchNum	string	Branch Office Number
postCode	postCode	string	Postal Code
agencyBusinessNum	agencyBusinessNum	string	Proxy company business number
registeredAgentNum	registeredAgentNum	string	Registration agent number
agentContactName	agentContactName	string	Name of proxy contact person
agentEmail	agentEmail	string	Agent email
agentTel	agentTel	string	Agent's phone number
hasAgentCompany	hasAgentCompany	string	Is there a proxy company (0: No, 1: Yes)
ausAbn	ausAbn	string	Tax Id (Australia Region)

IPageV2VarPayItemResp

Name	Path	Type
size	size	integer
current	current	integer
pages	pages	integer
total	total	integer
records	records	array of V2VarPayItemResp

ResultIPageV2VarPayItemResp

Name	Path	Type
code	code	integer
message	message	string
data	data	IPageV2VarPayItemResp

V2VarPayItemResp

Variable payroll item

Name	Path	Type	Description
id	id	string	ID
employeeId	employeeId	string	Employee ID
payrollItemId	payrollItemId	string	Payroll item ID
money	money	number	Amount
paymentType	paymentType	string	Payment type: 0: Income, 1: Deduction, 2: Others
payrollDate	payrollDate	date	Payroll date
remark	remark	string	Remarks
code	code	string	Employee code
englishName	englishName	string	Employee English name
chineseName	chineseName	string	Employee Chinese name
positionName	positionName	string	Position name
payrollItemName	payrollItemName	string	Payroll item name
costCenterName	costCenterName	string	Cost center name
calculateSalaryType	calculateSalaryType	string	Salary calculation type: 0: Monthly, 1: Hourly, 2: Yearly, 3: Daily, 4: Weekly
payrollPlanId	payrollPlanId	string	Payroll plan ID
payrollPlanName	payrollPlanName	string	Payroll calculation name

IPageV2PayrollPlanResp

Name	Path	Type
size	size	integer
current	current	integer
pages	pages	integer
total	total	integer
records	records	array of V2PayrollPlanResp

ResultIPageV2PayrollPlanResp

Name	Path	Type
code	code	integer
message	message	string
data	data	IPageV2PayrollPlanResp

V2PayrollPlanResp

Payroll Plan

Name	Path	Type	Description
id	id	string	ID
name	name	string	Name
payrollRegulationId	payrollRegulationId	string	Payroll Rule ID
year	year	string	Year
month	month	string	Month
periodStartDate	periodStartDate	date	Period Start Date
periodEndDate	periodEndDate	date	Period End Date
degree	degree	string	Number of Times
population	population	integer	Population
actualSalary	actualSalary	number	Actual Salary
payrollDate	payrollDate	date	Payroll Date
type	type	string	Type, 0: Normal, 1: Temporary
remark	remark	string	Remark
attendCalculationStartDate	attendCalculationStartDate	date	Attend Calculation Start Date
attendCalculationEndDate	attendCalculationEndDate	date	Attend Calculation End Date
status	status	string	Payroll Plan Status, 0: Pending Approval, 1: Verified � Pending Payment, 2: Paid
paymentType	paymentType	string	Payment Type, 0: Bank Transfer, 1: Checks, 2: Cash
period	period	string	Period
temporaryOperationName	temporaryOperationName	string	Temporary Operation Name
employeeScopeType	employeeScopeType	string	Employee Scope in Temporary Operation, 0: Paid Employees Under This Compensation Rule, 1: Resignation of Employees Under This Salary Rule, 2: Manually Add Employees
payrollTimeType	payrollTimeType	string	Payroll Time Type, 0: Once a Month, 1: Multiple Times a Month, 2: Weekly Pay, 3: Biweekly Salary, 4: Once Every Two Weeks

IPageV2PayItemResp

Name	Path	Type
size	size	integer
current	current	integer
pages	pages	integer
total	total	integer
records	records	array of V2PayItemResp

ResultIPageV2PayItemResp

Name	Path	Type
code	code	integer
message	message	string
data	data	IPageV2PayItemResp

V2PayItemResp

Payroll Items

Name	Path	Type	Description
id	id	string	ID
name	name	string	Name
paymentType	paymentType	string	Payment Type: 0: Income, 1: Deduction, 2: Not Applicable
status	status	string	Status: 0: Disabled, 1: Enabled
payrollItemTypeName	payrollItemTypeName	string	Payroll Item Type Name
calculationOrder	calculationOrder	string	Calculation Order
regulationRulesAlias	regulationRulesAlias	string	Formula Alias
salaryElement	salaryElement	string	Salary Element: a: salary elements, b: allowances and deductions, c: social security benefits, d: tax, e: resignation salary calculation, f: others
hours	hours	string	Hours
ratio	ratio	string	Ratio

IPageV2FixedPayItemResp

Name	Path	Type
size	size	integer
current	current	integer
pages	pages	integer
total	total	integer
records	records	array of V2FixedPayItemResp

ResultIPageV2FixedPayItemResp

Name	Path	Type
code	code	integer
message	message	string
data	data	IPageV2FixedPayItemResp

V2FixedPayItemResp

Fixed payroll item

Name	Path	Type	Description
id	id	string	ID
employeeId	employeeId	string	Employee ID
employeeName	employeeName	string	Employee Name
payrollItemId	payrollItemId	string	Payroll item ID
money	money	number	Amount
payrollItemName	payrollItemName	string	Payroll item name
paymentType	paymentType	string	Payment type: 0: Income, 1: Deduction, 2: Others
startDate	startDate	date	Start date
endDate	endDate	date	End date

IPageV2ExtPayItemResp

Name	Path	Type
size	size	integer
current	current	integer
pages	pages	integer
total	total	integer
records	records	array of V2ExtPayItemResp

ResultIPageV2ExtPayItemResp

Name	Path	Type
code	code	integer
message	message	string
data	data	IPageV2ExtPayItemResp

V2ExtPayItemResp

Business payroll item project

Name	Path	Type	Description
id	id	string	ID
name	name	string	Payroll item name
paymentType	paymentType	string	Payment type: 0: Income, 1: Deduction, 2: Others
status	status	string	Status: 0: Disabled, 1: Enabled
carryRule	carryRule	string	Rounding rule: 0: Round Up, 1: Round Off, 2: Round Down
decimalDigits	decimalDigits	integer	Number of decimal places to retain
formulaAlias	formulaAlias	string	Formula alias

IPageV2ExternalPayItemResp

Name	Path	Type
size	size	integer
current	current	integer
pages	pages	integer
total	total	integer
records	records	array of V2ExternalPayItemResp

ResultIPageV2ExternalPayItemResp

Name	Path	Type
code	code	integer
message	message	string
data	data	IPageV2ExternalPayItemResp

V2ExternalPayItemResp

Business payroll item

Name	Path	Type	Description
id	id	string	ID
code	code	string	Code
employeeId	employeeId	string	Employee ID
employeeCode	employeeCode	string	Employee code
employeeName	employeeName	string	Employee name
calculateSalaryType	calculateSalaryType	string	Salary calculation type: 0: Monthly, 1: Hourly, 2: Yearly, 3: Daily, 4: Weekly
businessSalaryItemId	businessSalaryItemId	string	Business payroll item ID
businessSalaryItemName	businessSalaryItemName	string	Business payroll item name
money	money	number	Amount
occurrenceDate	occurrenceDate	date	Occurrence date
payType	payType	string	Payment type: 0: Income, 1: Deduction, 2: Others
remark	remark	string	Remarks
expirationDate	expirationDate	date	Expiration date

IPageV2LeaveApplicationResp

Name	Path	Type
size	size	integer
current	current	integer
pages	pages	integer
total	total	integer
records	records	array of V2LeaveApplicationResp

ResultIPageV2LeaveApplicationResp

Name	Path	Type
code	code	integer
message	message	string
data	data	IPageV2LeaveApplicationResp

V2LeaveApplicationResp

Holiday application

Name	Path	Type	Description
id	id	string	Id
employeeId	employeeId	string	Employee Id
englishName	englishName	string	Employee Name
holidayType	holidayType	string	Holiday Type ID
holidayTypeName	holidayTypeName	string	Holiday Type Name
startDate	startDate	date	Start Date
startTime	startTime	string	Start Time
endDate	endDate	date	End Date
endTime	endTime	string	End Time
leaveTime	leaveTime	number	Leave Duration
timeType	timeType	string	Duration Type (0: One Day 1: Multiple Days)
remark	remark	string	Reason
status	status	string	Approval Status (0: Under Approval, 1: Rejected, 2: Passed)
holidayDate	holidayDate	date	Leave Date
time	time	string	Leave Time

IPageV2LabelResp

Name	Path	Type
size	size	integer
current	current	integer
pages	pages	integer
total	total	integer
records	records	array of V2LabelResp

ResultIPageV2LabelResp

Name	Path	Type
code	code	integer
message	message	string
data	data	IPageV2LabelResp

V2LabelResp

Label

Name	Path	Type	Description
id	id	string	ID
labelCode	labelCode	string	Label code
labelName	labelName	string	Label name
labelStatus	labelStatus	integer	Label status: 0 Disabled, 1 Enabled

IPageV2EmployeeResp

Name	Path	Type
size	size	integer
current	current	integer
pages	pages	integer
total	total	integer
records	records	array of V2EmployeeResp

ResultIPageV2EmployeeResp

Name	Path	Type
code	code	integer
message	message	string
data	data	IPageV2EmployeeResp

V2EmployeeResp

Employee

Name	Path	Type	Description
id	id	string	Id
englishName	englishName	string	English Name
chineseName	chineseName	string	Chinese Name
email	email	string	Email
countryCode	countryCode	string	Region Code
phone	phone	string	Phone
sex	sex	string	Sex
age	age	integer	Age
address	address	string	Residential Area
code	code	string	Code
identityCard	identityCard	string	Identity Card
bankCard	bankCard	string	Bank Card
status	status	integer	Status (0 Resignation, 1 Employment)
flag	flag	integer	Tag (0: Add To Preferred, 1: Add To Blacklist)
score	score	number	Score
expectedArea	expectedArea	string	Expected Region
nickName	nickName	string	Nickname
position	position	string	Apply For A Position
arrivalDate	arrivalDate	date-time	Date Of Availability
salary	salary	integer	Expected Salary
education	education	string	Education Level (0: Form 3/Certificate, 1: Form 5/Certificate, 2: Hong Kong Diploma Of Secondary Education/Form 7/Diploma, 3: Associate Degree/Advanced Diploma, 4: Bachelor's Degree, 5: Master's Degree, 6: Doctoral Degree)
comApplication	comApplication	string	Computer Applications
otherApplication	otherApplication	string	Other Applications
chineseTyping	chineseTyping	string	Chinese Typing
chineseOther	chineseOther	string	Chinese Typing Other
englishTyping	englishTyping	string	Typing
chineseWpm	chineseWpm	integer	Chinese Typing/Minute
englishWpm	englishWpm	integer	English Typing/Minute
cantonese	cantonese	string	Cantonese
english	english	string	English
mandarin	mandarin	string	Mandarin
otherLanguage	otherLanguage	string	Other Languages
birthday	birthday	string	Date Of Birth:
accountNumber	accountNumber	string	Account No
departmentId	departmentId	string	Department Id
departmentName	departmentName	string	Department Name
positionId	positionId	string	Job Id
positionName	positionName	string	Job Name
entryDate	entryDate	date	Entry Date
directSupervisorId	directSupervisorId	string	Manager ID
directSupervisorEnglishName	directSupervisorEnglishName	string	Manager Name
attendCalculationId	attendCalculationId	string	Office Location Id
hireType	hireType	string	Employment Form (0: Full Time,1: Temporary, 2: Freelance, 3: Part Time, 4: Contract,5: Internship, 6: Virtual Employee)
basicPay	basicPay	number	Basic Pay
calculateSalaryType	calculateSalaryType	string	Salary Calculation Method (0: Monthly 1: Hourly 2: Yearly 3: Daily 4: Weekly)
takeEffectDate	takeEffectDate	date	Effective Date
nationality	nationality	string	Nationality
maritalStatus	maritalStatus	string	Marital Status (0: Single 1: Married 2: Divorced 3: Widowed)
emergencyContactName	emergencyContactName	string	Emergency Contact Name
emergencyContactRelation	emergencyContactRelation	string	Relationship
emergencyContactPhone	emergencyContactPhone	string	Emergency Contact Phone
bankName	bankName	string	Bank Name
bankBranchNumber	bankBranchNumber	string	Bank Branch Number
bankAccountNo	bankAccountNo	string	Bank Account
lastWorkingDate	lastWorkingDate	date	Last Working Date
bankCode	bankCode	string	Bank Number
remark	remark	string	Notes
regionCode	regionCode	string	Area Code
regularType	regularType	string	Holiday Rule Id
regularTypeName	regularTypeName	string	Holiday Rule Name
costCenterId	costCenterId	string	Cost Center Id
costCenterName	costCenterName	string	Cost Center Name
payrollRegulationId	payrollRegulationId	string	Salary Rule Id
payrollRegulationName	payrollRegulationName	string	Salary Rule Name
personalNameEnglish	personalNameEnglish	string	Name (written In English)
identityCardHk	identityCardHk	string	Hong Kong Identity Card No
passportNumber	passportNumber	string	Passport Number
passportIssuingPlace	passportIssuingPlace	string	Passport Issuance Location
spouseName	spouseName	string	Name Of Spouse
spouseIdentityCardHk	spouseIdentityCardHk	string	Spouse's Hong Kong Identity Card No
spousePassportNumber	spousePassportNumber	string	Spouse Passport Number
spousePassportIssuingPlace	spousePassportIssuingPlace	string	Spouse's Passport Issuance Location
postalAddress	postalAddress	string	Mail Address
employerName	employerName	string	Employer Name
reasonsLeave	reasonsLeave	string	Reason For Leaving (0: Death, 1: Redundancy, 2: Early Retirement Schemes, 3: Invalidity, 4: Dismiss, 5: Resignation, 6: Retirement, 7: Abandonment Of Employment, 8: Probation Period Not Completed Satisfactorily (legally Dismiss), 9: Fixed Term Contract Expire (legally As Dismiss))
isForDeparture	isForDeparture	string	Is The Resignation Process Underway (0: No 1:Yes)
hometown	hometown	string	Native Place
nation	nation	string	Nationality
politicalStatus	politicalStatus	string	Political Status
highestEducation	highestEducation	string	Highest Education Level
workDate	workDate	date	Date Of Employment (specified Seniority Calculation Date)
confirmationDate	confirmationDate	date	Date Of Confirmation
probation	probation	string	Trial Period
isDisabled	isDisabled	boolean	Are You A Person With Disabilities (0: No 1:Yes)
isForeignNationality	isForeignNationality	boolean	Are You A Foreigner (0: No 1:Yes)
domicileLocation	domicileLocation	string	Registered Residence
certificateType	certificateType	string	Id Type (0: Identity Card, 1: Other)
certificateNumber	certificateNumber	string	Id No
isMartyrDependents	isMartyrDependents	boolean	Is It A Martyr's Family (0: No 1:Yes)
occupationTaxNumber	occupationTaxNumber	string	Occupational Tax Number
nonLocalBlueCardNumber	nonLocalBlueCardNumber	string	Non Local Employee Id Card (blue Card) Number
isForeignEmployees	isForeignEmployees	boolean	Are You A Non Local Employee (0: No 1:Yes)
weeklyLeaveWorkAgreement	weeklyLeaveWorkAgreement	string	Weekly Leave Work Agreement
workHours	workHours	number	Daily Hours Of Operation
employeeType	employeeType	string	Employee Classification
jobLevel	jobLevel	string	Job Grade
post	post	string	Position
salaryScale	salaryScale	string	Salary Scale
jobTitle	jobTitle	string	Job Title
recruitmentSource	recruitmentSource	string	Recruitment Source
graduatedSchool	graduatedSchool	string	Alma Mater
profession	profession	string	Major
calculateSalaryTypeText	calculateSalaryTypeText	string	Salary Calculation Form Value
hireTypeText	hireTypeText	string	Employment Form Value
termsOfWork	termsOfWork	string	Work Clause
totalHours	totalHours	number	Total Working Hours
payrollPackageFte	payrollPackageFte	number	Salary Package Fte
payrollPackageProData	payrollPackageProData	number	Compensation Package - pro_data
hourlyWagePercent	hourlyWagePercent	number	Hourly Wage Ratio
terminationCompensationDate	terminationCompensationDate	date	Calculation Date Of Severance Compensation
terminationEmployedLength	terminationEmployedLength	number	Resignation Length Of Service
ageOfTermination	ageOfTermination	integer	Resignation Age
appellation	appellation	string	Appellation
middleName	middleName	string	Middle Name
homePhone	homePhone	string	Home Phone
officePhone	officePhone	string	Office Phone
country	country	string	Country
province	province	string	Province
city	city	string	City
postcode	postcode	string	Postal Code
contractEndDate	contractEndDate	date	Contract End Date
taxNumber	taxNumber	string	Tax Id
taxpayerStatus	taxpayerStatus	string	Taxpayer Identity
isRequirementsThreshold	isRequirementsThreshold	string	Is A Threshold Required
isSupportingAccount	isSupportingAccount	string	Does It Support Accounting
exemptionMedicalInsuranceTax	exemptionMedicalInsuranceTax	string	Exemption From Medical Insurance Taxation 0: No Exemption, 1: Half Exemption, 2: All Exemption
tfnSignDate	tfnSignDate	date	Tfn Declaration Signing Date
taxIdentity	taxIdentity	string	Tax Identity
otherIncomeName	otherIncomeName	string	Naming Of Other Types Of Income
mobileCardCalType	mobileCardCalType	string	Calculation Method For Field Clock In (1: Not Counting Working Hours，2: Direct Working Hours，3: Work Hours After Approval)
termsOfWorkName	termsOfWorkName	string	Name Of Work Terms
insurePlanName	insurePlanName	string	Insurance Plan Name
majorWorkLocationId	majorWorkLocationId	string	Main Office Location
majorWorkLocationName	majorWorkLocationName	string	Main Office Location Name
whetherResidence	whetherResidence	string	Do You Provide A Place Of Residence
award	award	string	Labor Management Adjudication Agreement
employeeRateType	employeeRateType	string	Award Employment Type
classification	classification	string	Classification Level
payrollTemplateId	payrollTemplateId	string	Payroll Template
beneficiaryType	beneficiaryType	string	Beneficiary
attendCalculationName	attendCalculationName	string	Office Location Name

IPageV2DepartmentResp

Name	Path	Type
size	size	integer
current	current	integer
pages	pages	integer
total	total	integer
records	records	array of V2DepartmentResp

ResultIPageV2DepartmentResp

Name	Path	Type
code	code	integer
message	message	string
data	data	IPageV2DepartmentResp

V2DepartmentResp

department

Name	Path	Type	Description
id	id	string	Id
name	name	string	Department Name
departmentCode	departmentCode	string	Code
parentId	parentId	string	Parent department Id
parentName	parentName	string	Parent department name
status	status	string	Status (0: Disabled, 1: Enabled)

IPageV2AttendanceResp

Name	Path	Type
size	size	integer
current	current	integer
pages	pages	integer
total	total	integer
records	records	array of V2AttendanceResp

ResultIPageV2AttendanceResp

Name	Path	Type
code	code	integer
message	message	string
data	data	IPageV2AttendanceResp

V2AttendanceResp

Attendance calculation results

Name	Path	Type	Description
id	id	string	Id
attendDay	attendDay	date	Attendance Date
employeeId	employeeId	string	Employee Id
englishName	englishName	string	Employee Name
shiftLabor	shiftLabor	number	Attendance Hours Required
actualIn	actualIn	date-time	Actual Go To Work Time
actualOff	actualOff	date-time	Actual Go Off Work Time
attendStatus	attendStatus	string	Attendance Status (0: Normal, 1: Late, 2: Overtime, 3: Early Departure, 4: Absenteeism)
standardLaborTime	standardLaborTime	string	Standard Working Hours
laborLength	laborLength	number	Total Attendance Hours
earliestCard	earliestCard	date-time	The Earliest Card Pick-Up
lateCard	lateCard	date-time	Latest Card Pick-Up
confirm	confirm	string	Check In Confirmation (1: Confirm, 2: Refuse)
afterAdjust	afterAdjust	number	Adjusted Hours
adjust	adjust	number	Adjust Hours
beLateLength	beLateLength	double	Minutes Of Late
leaveEarlyLength	leaveEarlyLength	double	Minutes Of Early Departure
beLateTime	beLateTime	double	Number Of Latencies
leaveEarlyTime	leaveEarlyTime	double	Number Of Early Departures
workingOvertime	workingOvertime	number	Overtime On Weekdays
holidayOvertime	holidayOvertime	number	Overtime On Statutory Holidays
dayOffOvertime	dayOffOvertime	number	Overtime On Rest Days
paidLeave	paidLeave	number	Paid Leave
statutoryLeave	statutoryLeave	number	Statutory Leave
annualLeave	annualLeave	number	Annual Leave
sickLeave	sickLeave	number	Sick Leave
unpaidLeave	unpaidLeave	number	Unpaid Leave
unpaidSickLeave	unpaidSickLeave	number	No-Pay Sick Leave
adjustmentLeave	adjustmentLeave	number	Compensatory Leave
type	type	string	Type
leaveTime	leaveTime	number	Leave Duration
shiftIn	shiftIn	string	The Time When One Should Be At Work
shiftOff	shiftOff	string	The Time When One Should Get Off Work
absenceLength	absenceLength	number	Duration Of Absence
ordinaryHours	ordinaryHours	number	Ordinary Working Hours
satHours	satHours	number	Saturday Working Hours
sunHours	sunHours	number	Sunday Working Hours
publicHolidayHours	publicHolidayHours	number	Working Hours On Statutory Holidays
morningShiftHours	morningShiftHours	number	Morning Shift Working Hours
afternoonShiftHours	afternoonShiftHours	number	Afternoon Shift Working Hours
nightShiftHours	nightShiftHours	number	Night Shift Working Hours
mealBreakTimes	mealBreakTimes	number	Meal And Rest Hours
otBefore	otBefore	number	Overtime Hours Within The Time Limit
otAfter	otAfter	number	Overtime Hours Exceeding The Limit
ordinaryRates	ordinaryRates	number	Ordinary Salary Rate
satRates	satRates	number	Saturday Salary Rate
sunRates	sunRates	number	Sunday Salary Rate
publicHolidayRates	publicHolidayRates	number	Statutory Holiday Salary Rate
morningShiftRates	morningShiftRates	number	Early Shift Salary Rate
afternoonShiftRates	afternoonShiftRates	number	Afternoon Shift Salary Rate
nightShiftRates	nightShiftRates	number	Night Shift Salary Rate
otBeforeRates	otBeforeRates	number	Overtime Pay Rate Within The Time Limit
otAfterRates	otAfterRates	number	Overtime Pay Rate Beyond The Limit
ordinaryPenalty	ordinaryPenalty	number	Ordinary Allowance
satPenalty	satPenalty	number	Saturday Allowance
sunPenalty	sunPenalty	number	Sunday Allowance
publicHolidayPenalty	publicHolidayPenalty	number	Statutory Holiday Allowance
morningShiftPenalty	morningShiftPenalty	number	Early Shift Allowance
afternoonShiftPenalty	afternoonShiftPenalty	number	Afternoon Shift Allowance
nightShiftPenalty	nightShiftPenalty	number	Night Shift Allowance
otBeforePenalty	otBeforePenalty	number	Overtime Allowance Within A Time Limit
otAfterPenalty	otAfterPenalty	number	Overtime Allowance Beyond The Limit
overtimeSaturdayFirstHours	overtimeSaturdayFirstHours	number	Overtime saturday first hours
overtimeSaturdayAfterHours	overtimeSaturdayAfterHours	number	Overtime saturday after hours
overtimeSundayFirstHours	overtimeSundayFirstHours	number	Overtime sunday first hours
overtimeSundayAfterHours	overtimeSundayAfterHours	number	Overtime sunday after hours
overtimePublicHolidayFirstHours	overtimePublicHolidayFirstHours	number	Overtime public holiday first hours
overtimePublicHolidayAfterHours	overtimePublicHolidayAfterHours	number	Overtime public holiday after hours
overtimeSaturdayFirstHourlyRate	overtimeSaturdayFirstHourlyRate	number	Overtime saturday first hourly rate
overtimeSaturdayAfterHourlyRate	overtimeSaturdayAfterHourlyRate	number	Overtime saturday after hourly rate
overtimeSundayFirstHourlyRate	overtimeSundayFirstHourlyRate	number	Overtime sunday first hourly rate
overtimeSundayAfterHourlyRate	overtimeSundayAfterHourlyRate	number	Overtime sunday after hourly rate
overtimePublicHolidayFirstHourlyRate	overtimePublicHolidayFirstHourlyRate	number	Overtime public holiday first hourly rate
overtimePublicHolidayAfterHourlyRate	overtimePublicHolidayAfterHourlyRate	number	Overtime public holiday after hourly rate
overtimeSaturdayFirstHoursPay	overtimeSaturdayFirstHoursPay	number	Overtime saturday first hours pay
overtimeSaturdayAfterHoursPay	overtimeSaturdayAfterHoursPay	number	Overtime saturday after hours pay
overtimeSundayFirstHoursPay	overtimeSundayFirstHoursPay	number	Overtime sunday first hours pay
overtimeSundayAfterHoursPay	overtimeSundayAfterHoursPay	number	Overtime sunday after hours pay
overtimePublicHolidayFirstHoursPay	overtimePublicHolidayFirstHoursPay	number	Overtime public holiday first hours pay
overtimePublicHolidayAfterHoursPay	overtimePublicHolidayAfterHoursPay	number	Overtime public holiday after hours pay
timeOffInLieu	timeOffInLieu	number	Time off in lieu
attendReviewStatus	attendReviewStatus	boolean	Attendance Review Status (0: Unaudited; 1: Approved)
attendReviewer	attendReviewer	string	Attendance Reviewer
attendReviewTime	attendReviewTime	date-time	Attendance Review Time
payrollReviewStatus	payrollReviewStatus	boolean	Salary Review Status (0: Unaudited; 1: Approved)
payrollReviewer	payrollReviewer	string	Salary Reviewer
payrollReviewTime	payrollReviewTime	date-time	Salary Review Time
dataStatus	dataStatus	string	Data Status (0: Unaudited; 1: Attendance Review; 2: Salary Review)
attendReviewerName	attendReviewerName	string	Name Of Attendance Reviewer
payrollReviewerName	payrollReviewerName	string	Name Of Salary Reviewer

ResultV3LeaveHolidayInsertResp

Name	Path	Type	Description
code	code	integer
message	message	string
data	data	V3LeaveHolidayInsertResp	Result of Adding Leave Application

V3LeaveHolidayInsertResp

Result of Adding Leave Application

Name	Path	Type	Description
id	id	string	id
employeeId	employeeId	string	Employee ID
englishName	englishName	string	English Name
holidayType	holidayType	string	Holiday Type ID
holidayTypeName	holidayTypeName	string	Holiday Type Name
startDate	startDate	date	Start Date
startTime	startTime	string	Start Time am:Morning pm:Afternoon allDay:All Day
endDate	endDate	date	End Date
endTime	endTime	string	End Time am:Morning pm:Afternoon allDay:All Day
leaveTime	leaveTime	number	Leave Duration
timeType	timeType	string	Duration Type 0:One day 1:Multiple days
holidayDate	holidayDate	date	Leave Date for Single Day Leave
time	time	string	Leave Time for Single Day Leave am:Morning pm:Afternoon allDay:All Day
remark	remark	string	Reason
status	status	string	Approval Status 0:Under Review, 1:Rejected, 2:Approved

ResultV3BizReimbursementInsertResp

Name	Path	Type	Description
code	code	integer
message	message	string
data	data	V3BizReimbursementInsertResp	Reimbursement Application Response

V3BizReimbursementInsertResp

Reimbursement Application Response

Name	Path	Type	Description
id	id	string	ID
employeeId	employeeId	string	Employee ID
reimbursementType	reimbursementType	string	Reimbursement Type
reimbursementTypeName	reimbursementTypeName	string	Reimbursement Type Name
reimbursementDate	reimbursementDate	date	Reimbursement Date
reimbursementName	reimbursementName	string	Reimbursement Name
amount	amount	number	Reimbursement Amount
remark	remark	string	Reason
status	status	string	Approval Status 0-Pending 1-Denied 2-Approved 3-Canceled 4-Deleted
englishName	englishName	string	Employee English Name

ResultV3AddEmployeeResp

Name	Path	Type
code	code	integer
message	message	string
data	data	V3AddEmployeeResp

V3AddEmployeeResp

Name	Path	Type	Description
id	id	string	New employee's ID

ResultV3AddEmployeeHistoryResp

Name	Path	Type
code	code	integer
message	message	string
data	data	V3AddEmployeeHistoryResp

V3AddEmployeeHistoryResp

Name	Path	Type	Description
id	id	string	Add employee's historical ID

ResultV3CalAttendanceResp

Name	Path	Type
code	code	integer
message	message	string
data	data	V3CalAttendanceResp

V3CalAttendanceResp

Name	Path	Type	Description
calId	calId	string	Calculate ID (used to obtain progress)

ResultV3AddTimesheetResp

Name	Path	Type
code	code	integer
message	message	string
data	data	V3AddTimesheetResp

V3AddTimesheetResp

Name	Path	Type	Description
id	id	string	New timesheet ID

ResultV3AddCalendarRemarkInfoResp

Name	Path	Type
code	code	integer
message	message	string
data	data	V3AddCalendarRemarkInfoResp

V3AddCalendarRemarkInfoResp

Name	Path	Type	Description
id	id	string	New calendar remark's ID

ResultV3AddMobileCardResp

Name	Path	Type
code	code	integer
message	message	string
data	data	V3AddMobileCardResp

V3AddMobileCardResp

Name	Path	Type	Description
id	id	string	New mobile card's ID

ResultListV3BizCustomizeDictionaryResp

Name	Path	Type
code	code	integer
message	message	string
data	data	array of V3BizCustomizeDictionaryResp

V3BizCustomizeDictionaryResp

Data Dictionary

Name	Path	Type	Description
id	id	string	ID
name	name	string	Dictionary Name
num	num	integer	Number
code	code	string	Code
isInternal	isInternal	boolean	Is Internal Dictionary Item
area	area	string	Area

ResultListV3BizCustomizeDictionaryItemResp

Name	Path	Type
code	code	integer
message	message	string
data	data	array of V3BizCustomizeDictionaryItemResp

V3BizCustomizeDictionaryItemResp

Custom Dictionary Item

Name	Path	Type	Description
id	id	string	ID
parentId	parentId	string	Dictionary ID
code	code	string	Code
num	num	integer	Number
text	text	string	Option Value
addedValue1	addedValue1	string	Added Value 1
addedValue2	addedValue2	string	Added Value 2
addedValue3	addedValue3	string	Added Value 3
addedValue4	addedValue4	string	Added Value 4
addedValue5	addedValue5	string	Added Value 5
mpfCode	mpfCode	string	MPF Corresponding Value
isEnable	isEnable	boolean	Is Enabled

IPageV3BizEmployeeCustomizationResp

Name	Path	Type
size	size	integer
current	current	integer
pages	pages	integer
total	total	integer
records	records	array of V3BizEmployeeCustomizationResp

ResultIPageV3BizEmployeeCustomizationResp

Name	Path	Type
code	code	integer
message	message	string
data	data	IPageV3BizEmployeeCustomizationResp

V3BizEmployeeCustomizationResp

Employee customization item

Name	Path	Type	Description
id	id	string	ID
projectType	projectType	string	Project type
projectName	projectName	string	Project name
formulaAlias	formulaAlias	string	Formula alias
dictionaryType	dictionaryType	string	Dictionary ID
dictionaryCode	dictionaryCode	string	Dictionary code
dictionaryTypeName	dictionaryTypeName	string	Dictionary name

ResultV3BizEmployeeCustomizationResp

Name	Path	Type	Description
code	code	integer
message	message	string
data	data	V3BizEmployeeCustomizationResp	Employee customization item

ResultV3BizAttendanceConfigureResp

Name	Path	Type	Description
code	code	integer
message	message	string
data	data	V3BizAttendanceConfigureResp	Attendance configuration

V3BizAttendanceConfigureResp

Attendance configuration

Name	Path	Type	Description
isAllowViewSchedule	isAllowViewSchedule	boolean	Whether to allow viewing colleague schedules
isAllowViewLeave	isAllowViewLeave	boolean	Whether to allow viewing colleague leaves
isAllowSubstitute	isAllowSubstitute	boolean	Whether to allow shift substitution
isAllowEmployeeEditDevice	isAllowEmployeeEditDevice	boolean	Whether employees are allowed to edit Bluetooth devices
isAllowCreateCode	isAllowCreateCode	boolean	Whether to allow employees to generate QR code for clocking in
isEnableFieldWork	isEnableFieldWork	boolean	Whether field work punch-in is enabled
isEnableDeviceBind	isEnableDeviceBind	boolean	Whether device binding is enabled
attendanceManageOpenshift	attendanceManageOpenshift	boolean	Whether shift scheduling is enabled
attendanceManageProjectPro	attendanceManageProjectPro	boolean	Whether advanced scheduling project is enabled
workingBreakPairing	workingBreakPairing	boolean	Whether mandatory verification of work and break punch-in times on the app is enabled
forceOpenshiftSchedule	forceOpenshiftSchedule	boolean	Whether to force the use of openshift scheduling

IPageV3LeaveWorkFlowDefinitionResp

Name	Path	Type
size	size	integer
current	current	integer
pages	pages	integer
total	total	integer
records	records	array of V3LeaveWorkFlowDefinitionResp

ResultIPageV3LeaveWorkFlowDefinitionResp

Name	Path	Type
code	code	integer
message	message	string
data	data	IPageV3LeaveWorkFlowDefinitionResp

V3LeaveWorkFlowDefinitionResp

Approval process

Name	Path	Type	Description
id	id	string	id
name	name	string	name
isEnabled	isEnabled	string	Is enabled
isInternallyInstalled	isInternallyInstalled	boolean	Is internally installed
allowCustomApprover	allowCustomApprover	boolean	Whether to allow employees to customize approvers
type	type	string	Document type 0: Timesheet 1: Leave request 2: Leave cash-out form 3: Reimbursement form
department	department	string	Allowed departments to apply
position	position	string	Allowed positions to apply
workLocation	workLocation	string	Allowed office locations to apply
tag	tag	string	Allowed tags to apply
employee	employee	string	Allowed employees to apply
record	record	string	Process document
scope	scope	string	Allowed application scope
node	node	string	Node name
takeEffectIndex	takeEffectIndex	integer	Take effect order
includeAll	includeAll	boolean	Whether to allow all employees to apply

IPageV3WorkPatternSummaryResp

Name	Path	Type
size	size	integer
current	current	integer
pages	pages	integer
total	total	integer
records	records	array of V3WorkPatternSummaryResp

ResultIPageV3WorkPatternSummaryResp

Name	Path	Type
code	code	integer
message	message	string
data	data	IPageV3WorkPatternSummaryResp

V3WorkPatternSummaryResp

Name	Path	Type	Description
id	id	string	id
number	number	string	Number
name	name	string	Name
workHoursForDay	workHoursForDay	number	Work Hours For Day
workHoursForWeek	workHoursForWeek	number	Work Hours For Week
workHoursForYear	workHoursForYear	number	Work Hours For Year
totalHours	totalHours	number	Total Hours
cycleType	cycleType	string	Cycle Type
fte	fte	string	FTE
status	status	string	Status 0：enabled, 1:disabled

ResultV3WorkPatternResp

Name	Path	Type
code	code	integer
message	message	string
data	data	V3WorkPatternResp

V3TermsSettingResp

Name	Path	Type	Description
id	id	string	primary key
amount	amount	number	payroll amount
workHours	workHours	number	working hours
shiftTemplateId	shiftTemplateId	string	shift template id
termsWorkId	termsWorkId	string	work terms id
sign	sign	string	Single/biweekly marker 0: single week, 1: biweekly
daySign	daySign	string	day sign Monday to Sunday are (1, 2, 3, 4, 5, 6, 7), biweekly is (8, 9, 10, 11, 12, 13, 14), and public holidays are 15
workPlaceId	workPlaceId	string	work location
salaryProject	salaryProject	string	project name id
salaryType	salaryType	integer	salary calculation method
workPlaceName	workPlaceName	string	work location name
salaryProjectName	salaryProjectName	string	project name
shiftTemplateName	shiftTemplateName	string	shift template name

V3WorkPatternResp

Name	Path	Type	Description
id	id	string	id
number	number	string	number
name	name	string	name
workHoursForDay	workHoursForDay	number	working hours per day
workHoursForWeek	workHoursForWeek	number	working hours per week
workHoursForYear	workHoursForYear	number	working hours per year
totalHours	totalHours	number	total working hours
cycleType	cycleType	string	cycle type 0: Once a month, 1: Multiple times a month, 2: Weekly salary, 3: New every two weeks, 4: Half a month
fte	fte	string	FTE
status	status	string	status 0：enabled,1:disabled
salaryCalculationStyle	salaryCalculationStyle	integer	Salary calculation method 0: by time, 1: by office location, 2: by project
workTime	workTime	integer	working time
doubleWeekBaseDate	doubleWeekBaseDate	date-time	base date for biweekly cycle
weekSalaryType	weekSalaryType	string	weekly salary type
isThisWeek	isThisWeek	integer	whether current week is single week
advancedSetting	advancedSetting	string	advanced settings
isInternal	isInternal	boolean	whether built-in
termsWorkDefaultId	termsWorkDefaultId	string	default work terms id
settingList	settingList	array of V3TermsSettingResp	work terms details

IPageV3PayrollNonFixedResp

Name	Path	Type
size	size	integer
current	current	integer
pages	pages	integer
total	total	integer
records	records	array of V3PayrollNonFixedResp

ResultIPageV3PayrollNonFixedResp

Name	Path	Type
code	code	integer
message	message	string
data	data	IPageV3PayrollNonFixedResp

V3PayrollNonFixedResp

Name	Path	Type	Description
id	id	string	id
employeeId	employeeId	string	employee id
payrollItemId	payrollItemId	string	payroll item id
money	money	number	amount
paymentType	paymentType	string	payment type 0: Income, 1: Deduction, 2: Others
payrollDate	payrollDate	date	payroll date
remark	remark	string	reason
code	code	string	employee number
englishName	englishName	string	employee english name
chineseName	chineseName	string	employee chinese name
positionName	positionName	string	employee position
payrollItemName	payrollItemName	string	payroll item name
costCenterName	costCenterName	string	cost center
calculateSalaryType	calculateSalaryType	string	salary calculation type
payrollPlanId	payrollPlanId	string	payroll plan id
dataType	dataType	string	data type
payrollPlanName	payrollPlanName	string	payroll plan name

IPageV3PayrollPlanResp

Name	Path	Type
size	size	integer
current	current	integer
pages	pages	integer
total	total	integer
records	records	array of V3PayrollPlanResp

ResultIPageV3PayrollPlanResp

Name	Path	Type
code	code	integer
message	message	string
data	data	IPageV3PayrollPlanResp

V3PayrollPlanResp

Name	Path	Type	Description
id	id	string	id
name	name	string	payroll plan name
payrollRegulationId	payrollRegulationId	string	payroll regulation id
year	year	string	period year
month	month	string	period month
periodStartDate	periodStartDate	date	period payroll calculation start date
periodEndDate	periodEndDate	date	period payroll calculation end date
degree	degree	string	times
population	population	integer	number of people
actualSalary	actualSalary	number	actual payroll
payrollDate	payrollDate	date	payment date
type	type	string	type
remark	remark	string	reason
attendCalculationStartDate	attendCalculationStartDate	date	attendance calculation start date
attendCalculationEndDate	attendCalculationEndDate	date	attendance calculation end date
timeDefinedFlag	timeDefinedFlag	boolean	attendance time custom
status	status	string	Payroll Plan Status, 0: Pending Approval, 1: Verified / Pending Payment, 2: Paid
isIncludeBasicSalary	isIncludeBasicSalary	boolean	whether to include basic salary
isIncludeNonFixedSalary	isIncludeNonFixedSalary	boolean	whether to include non-fixed salary
isIncludeAttendCalculation	isIncludeAttendCalculation	boolean	whether to include attendance data
isIncludeLeaveSalary	isIncludeLeaveSalary	boolean	whether to include holiday salary
isIncludeFixedSalary	isIncludeFixedSalary	boolean	whether to include payroll template
paymentType	paymentType	string	Payment Type, 0: Bank Transfer, 1: Checks, 2: Cash
period	period	string	period
step	step	integer	step
isAutoLoadStaff	isAutoLoadStaff	boolean	whether to automatically load employees
payrollTimeType	payrollTimeType	string	Payroll Time Type, 0: Once a Month, 1: Multiple Times a Month, 2: Weekly Pay, 3: Biweekly Salary, 4: Once Every Two Weeks
temporaryOperationName	temporaryOperationName	string	name during temporary calculation
employeeScopeType	employeeScopeType	string	Employee Scope in Temporary Operation, 0: Paid Employees Under This Compensation Rule, 1: Resignation of Employees Under This Salary Rule, 2: Manually Add Employees
degreeStr	degreeStr	string	times
payrollPeriodId	payrollPeriodId	string	payroll period id

IPageV3PayrollPlanDetailResp

Name	Path	Type
size	size	integer
current	current	integer
pages	pages	integer
total	total	integer
records	records	array of V3PayrollPlanDetailResp

ResultIPageV3PayrollPlanDetailResp

Name	Path	Type
code	code	integer
message	message	string
data	data	IPageV3PayrollPlanDetailResp

V3PayrollPlanDetailResp

Name	Path	Type	Description
id	id	string	id
employeeId	employeeId	string	employee id
payrollPlanId	payrollPlanId	string	payroll plan id
payrollRegulationId	payrollRegulationId	string	payroll regulation id
paymentDate	paymentDate	date	payment date
paymentMode	paymentMode	string	Payment method 0: bank transfer, 1: check, 2: cash

IPageV3PayrollRegResp

Name	Path	Type
size	size	integer
current	current	integer
pages	pages	integer
total	total	integer
records	records	array of V3PayrollRegResp

ResultIPageV3PayrollRegResp

Name	Path	Type
code	code	integer
message	message	string
data	data	IPageV3PayrollRegResp

V3PayrollRegResp

Name	Path	Type	Description
id	id	string	id
name	name	string	name
payrollType	payrollType	string	Salary calculation format: 0: once a month, 1: multiple times a month, 2: weekly salary, 3: biweekly new, 4: half month
totalDays	totalDays	string	total working days
firstDay	firstDay	string	first day of period
year	year	string	year
month	month	string	month
status	status	string	status
isDefaultInPayrollRegulation	isDefaultInPayrollRegulation	boolean	is default in payroll regulation
payrollTimeType	payrollTimeType	string	number of paychecks
firstPeriodStartDate	firstPeriodStartDate	date	first period start date
payrollPolicyId	payrollPolicyId	string	payroll policy id

ResultV3PayrollRegResp

Name	Path	Type
code	code	integer
message	message	string
data	data	V3PayrollRegResp

ResultListV3PayrollPlanDetailResp

Name	Path	Type
code	code	integer
message	message	string
data	data	array of V3PayrollPlanDetailResp

IPageV3PayrollItemResp

Name	Path	Type
size	size	integer
current	current	integer
pages	pages	integer
total	total	integer
records	records	array of V3PayrollItemResp

ResultIPageV3PayrollItemResp

Name	Path	Type
code	code	integer
message	message	string
data	data	IPageV3PayrollItemResp

V3PayrollItemResp

Name	Path	Type	Description
id	id	string	id
payrollItemTypeId	payrollItemTypeId	string	payroll item category id
name	name	string	payroll item name
paymentType	paymentType	string	Payment type: 0: Income, 1: Deduction, 2: Others
status	status	string	status
carryRule	carryRule	string	rounding rule, 0: carry, 1: round, 2: intercept
decimalDigits	decimalDigits	integer	number of decimal places
taxIncomeId	taxIncomeId	string	tax income id
socialSecurityIncomeId	socialSecurityIncomeId	string	social security income id
averagePayrollIncomeId	averagePayrollIncomeId	string	average payroll income id
isBuildIn	isBuildIn	string	whether built-in
payrollItemDefaultId	payrollItemDefaultId	string	default payroll item id
sequence	sequence	integer	custom payroll item sort number
isExistRegulationRules	isExistRegulationRules	boolean	whether there is a calculation formula
regulationRules	regulationRules	string	rule formula
step	step	integer	current step
payrollRegulationIdSet	payrollRegulationIdSet	string	payroll regulation id set
calculationOrder	calculationOrder	string	calculation order
regulationRulesAlias	regulationRulesAlias	string	formula alias
isEditable	isEditable	boolean	editable
zoneOfApplication	zoneOfApplication	string	applicable country/region
field	field	string	payroll plan detail field
limitRules	limitRules	string	limit payroll rules
salaryElement	salaryElement	string	salary element type
hours	hours	string	hours
ratio	ratio	string	ratio
payrollItemTypeName	payrollItemTypeName	string	payroll item category name

ResultV3PayrollItemResp

Name	Path	Type
code	code	integer
message	message	string
data	data	V3PayrollItemResp

ResultListV3PayrollFixedResp

Name	Path	Type
code	code	integer
message	message	string
data	data	array of V3PayrollFixedResp

V3PayrollFixedResp

Name	Path	Type	Description
id	id	string	id
employeeId	employeeId	string	employee id
payrollItemId	payrollItemId	string	payroll item id
money	money	number	amount
payrollItemName	payrollItemName	string	payroll item name
paymentType	paymentType	string	payment type 0: Income, 1: Deduction, 2: Others
startDate	startDate	date	start date
endDate	endDate	date	end date
totalLimitAmount	totalLimitAmount	number	total limit amount
paidAmount	paidAmount	number	paid amount
surplusAmount	surplusAmount	number	surplus amount

IPageV3ExternalPayrollResp

Name	Path	Type
size	size	integer
current	current	integer
pages	pages	integer
total	total	integer
records	records	array of V3ExternalPayrollResp

ResultIPageV3ExternalPayrollResp

Name	Path	Type
code	code	integer
message	message	string
data	data	IPageV3ExternalPayrollResp

V3ExternalPayrollResp

Name	Path	Type	Description
id	id	string	id
code	code	string	number
employeeId	employeeId	string	employee ID
employeeCode	employeeCode	string	employee number
employeeName	employeeName	string	employee name
businessSalaryItemId	businessSalaryItemId	string	business payroll item ID
money	money	number	amount
occurrenceDate	occurrenceDate	date	occurrence date
remark	remark	string	remark
expirationDate	expirationDate	date	expiration date

IPageV3ExternalPayItemResp

Name	Path	Type
size	size	integer
current	current	integer
pages	pages	integer
total	total	integer
records	records	array of V3ExternalPayItemResp

ResultIPageV3ExternalPayItemResp

Name	Path	Type
code	code	integer
message	message	string
data	data	IPageV3ExternalPayItemResp

V3ExternalPayItemResp

Name	Path	Type	Description
id	id	string	id
customItemTypeId	customItemTypeId	string	payroll item category id
name	name	string	payroll item name
paymentType	paymentType	string	payment type 0: Income, 1: Deduction, 2: Others
status	status	string	status
carryRule	carryRule	string	rounding rule
decimalDigits	decimalDigits	integer	number of decimal places
formulaAlias	formulaAlias	string	formula alias

ResultV3ExternalPayItemResp

Name	Path	Type
code	code	integer
message	message	string
data	data	V3ExternalPayItemResp

IPageV3LeaveTypeResp

Name	Path	Type
size	size	integer
current	current	integer
pages	pages	integer
total	total	integer
records	records	array of V3LeaveTypeResp

ResultIPageV3LeaveTypeResp

Name	Path	Type
code	code	integer
message	message	string
data	data	IPageV3LeaveTypeResp

V3LeaveTypeResp

Leave Type

Name	Path	Type	Description
id	id	string	ID
name	name	string	Name
shortName	shortName	string	Short Name
unit	unit	string	Calculation Unit: 1:Day 0:Hour
isSalary	isSalary	string	Is Paid Leave: 0:No 1:Yes
displayBalance	displayBalance	string	Display Balance: 0:No 1:Yes
isIncludePublicHoliday	isIncludePublicHoliday	string	Include Public Holiday: 0:No 1:Yes
isExistsLimit	isExistsLimit	string	Has Quota: 0:No 1:Yes
isBuiltIn	isBuiltIn	string	Is Built-in: 0:No 1:Yes
availabilityOfEmployees	availabilityOfEmployees	string	Employee Availability: 0:No 1:Yes
updateSpecies	updateSpecies	string	Leave Calculation Method: 0:Unlimited Leave 1:One-time Leave 2:Calculation based on length of service 3:Fixed Yearly/Monthly Quota 4:Continuous Sick Leave 5:AU Leave Accrued 6:Statutory holiday 7:Accumulate from the Attendance Items Time Off In Lieu
builtInId	builtInId	string	Built-in Leave Type ID
leaveToCash	leaveToCash	string	Leave to Cash Conversion: 0:No 1:Yes

IPageV3LeavePolicyTypeResp

Name	Path	Type
size	size	integer
current	current	integer
pages	pages	integer
total	total	integer
records	records	array of V3LeavePolicyTypeResp

ResultIPageV3LeavePolicyTypeResp

Name	Path	Type
code	code	integer
message	message	string
data	data	IPageV3LeavePolicyTypeResp

V3LeavePolicyTypeResp

Leave Type in Leave Policy

Name	Path	Type	Description
id	id	string	id
regulationId	regulationId	string	Leave Policy ID
holidayId	holidayId	string	Leave Type ID
usedEntry	usedEntry	integer	Eligibility after how many months of employment
minLength	minLength	number	Minimum leave duration
disposableTotal	disposableTotal	number	One-time leave quota
yearTotal	yearTotal	number	Annual leave quota
ruleStartTime	ruleStartTime	date	Rule annual start date
basicEntry	basicEntry	string	Calculate leave based on hire date? 1: Yes, Others: No
generationFrequency	generationFrequency	string	Generation frequency: 0: Monthly calculation, 1: Annual calculation
totalDays	totalDays	string	Total days per year used for leave calculation
decimalDigits	decimalDigits	integer	Number of decimal places to retain
carryRule	carryRule	string	Rounding rule: 0: Round up, 1: Round half-up, 2: Truncate
checkTime	checkTime	string	Leave Allocation Timing: 0: First day of cycle, 1: Last day of cycle
isCarryOver	isCarryOver	string	Allow carry-over to next year? 0: Not allowed, 1: Allowed
maxTransfer	maxTransfer	number	Maximum transferable quota
isOvered	isOvered	string	Allow over-application? 0: Not allowed, 1: Allowed
isIncludeRest	isIncludeRest	string	Include public holidays and rest days? 0: No, 1: Yes
frequencyOfOnce	frequencyOfOnce	string	One-time leave generation frequency: 0: Once, 1: Multiple times
name	name	string	Name
shortName	shortName	string	Short name
unit	unit	string	Calculation unit
isSalary	isSalary	string	Is paid? 0: Unpaid, 1: Paid
updateSpecies	updateSpecies	string	Leave Calculation Method: 0:Unlimited Leave 1:One-time Leave 2:Calculation based on length of service 3:Fixed Yearly/Monthly Quota 4:Continuous Sick Leave 5:AU Leave Accrued 6:Statutory holiday 7:Accumulate from the Attendance Items Time Off In Lieu
generationType	generationType	string	SHDay leave allocation method. 0: Allocate on statutory holiday day; 1: Allocate at the beginning of each year
minAge	minAge	integer	SHDay minimum age
maxAge	maxAge	integer	SHDay maximum age
minMonthToApply	minMonthToApply	integer	How many months after hiring SHDay can be applied (in months)
deferCarryover	deferCarryover	string	Defer carry-over? 0: No, 1: Yes
deferCarryoverMonth	deferCarryoverMonth	integer	Months to defer carry-over

IPageV3LeavePolicyResp

Name	Path	Type
size	size	integer
current	current	integer
pages	pages	integer
total	total	integer
records	records	array of V3LeavePolicyResp

ResultIPageV3LeavePolicyResp

Name	Path	Type
code	code	integer
message	message	string
data	data	IPageV3LeavePolicyResp

V3LeavePolicyResp

Leave Policy

Name	Path	Type	Description
id	id	string	id
name	name	string	Name
workDays	workDays	string	Work Days
workHours	workHours	number	Working Hours Per Day
holidaysId	holidaysId	string	Public Holidays
createTime	createTime	date-time	Creation Time

ResultV3LeavePolicyDetailResp

Name	Path	Type
code	code	integer
message	message	string
data	data	V3LeavePolicyDetailResp

V3LeavePolicyDetailResp

Name	Path	Type	Description
id	id	string	id
name	name	string	Name
workDays	workDays	string	Work days
workHours	workHours	number	Daily working hours
holidaysId	holidaysId	string	Public holiday id
createTime	createTime	date-time	Creation time
leavePublicName	leavePublicName	string	Public holiday name
leavePublicTotalDays	leavePublicTotalDays	integer	Total public holiday days in current year
leaveTypeNameList	leaveTypeNameList	array of string	Leave type names
leaveTypeCount	leaveTypeCount	integer	Number of leave types

IPageV3LeaveBalanceResp

Name	Path	Type
size	size	integer
current	current	integer
pages	pages	integer
total	total	integer
records	records	array of V3LeaveBalanceResp

ResultIPageV3LeaveBalanceResp

Name	Path	Type
code	code	integer
message	message	string
data	data	IPageV3LeaveBalanceResp

V3LeaveBalanceResp

Name	Path	Type	Description
employeeId	employeeId	string	Employee ID
englishName	englishName	string	English Name
chineseName	chineseName	string	Chinese Name
code	code	string	Code
holidayType	holidayType	string	Holiday Type ID
holidayRule	holidayRule	string	Holiday Rule
holidayRuleName	holidayRuleName	string	Holiday Rule Name
limit	limit	number	Current Quota
planing	planing	number	Planned Quota
balance	balance	number	Available Quota

ResultV3LeaveBalanceDetailResp

Name	Path	Type
code	code	integer
message	message	string
data	data	V3LeaveBalanceDetailResp

V3LeaveBalanceDetailResp

Name	Path	Type	Description
employeeId	employeeId	string	Employee ID
englishName	englishName	string	English Name
chineseName	chineseName	string	Chinese Name
code	code	string	Code
holidayType	holidayType	string	Holiday Type ID
holidayTypeName	holidayTypeName	string	Holiday Type Name
regularType	regularType	string	Holiday Rule
limit	limit	number	Current Limit
planing	planing	number	Planned Balance
balance	balance	number	Available Balance
unit	unit	string	Calculation Unit 1:Day 0:Hour

IPageV3LeaveHolidayBalanceResp

Name	Path	Type
size	size	integer
current	current	integer
pages	pages	integer
total	total	integer
records	records	array of V3LeaveHolidayBalanceResp

ResultIPageV3LeaveHolidayBalanceResp

Name	Path	Type
code	code	integer
message	message	string
data	data	IPageV3LeaveHolidayBalanceResp

V3LeaveHolidayBalanceResp

Name	Path	Type	Description
id	id	string	id
employeeId	employeeId	string	Employee ID
holidayType	holidayType	string	Holiday Type ID
holidayRule	holidayRule	string	Holiday Rule
occurrenceTime	occurrenceTime	date-time	Occurrence Time
recordId	recordId	string	Record ID
status	status	string	Status 0:Effective;1:Planned
remark	remark	string	Remark 0:System Generated 1:Manual adjustment 2:Vacation 3:Vacation plan 4:Holiday deletion 5:Update quota 6:Insert data 7:Annual carry over 8:Holiday Update 9:Import 10:Leave to cash 11:Leave to cash deletion 12:Departure reset
cause	cause	string	Cause
adjust	adjust	string	Adjustment Value
afterAdjust	afterAdjust	string	Balance After Adjustment

IPageV3LeaveHolidayResp

Name	Path	Type
size	size	integer
current	current	integer
pages	pages	integer
total	total	integer
records	records	array of V3LeaveHolidayResp

ResultIPageV3LeaveHolidayResp

Name	Path	Type
code	code	integer
message	message	string
data	data	IPageV3LeaveHolidayResp

V3LeaveHolidayResp

Name	Path	Type	Description
id	id	string	id
employeeId	employeeId	string	Employee ID
englishName	englishName	string	English name
chineseName	chineseName	string	Chinese name
code	code	string	Code
holidayType	holidayType	string	Holiday type ID
holidayTypeName	holidayTypeName	string	Holiday type name
startDate	startDate	date	Start date
startTime	startTime	string	Start time am: Morning pm: Afternoon allDay: All day
endDate	endDate	date	End date
endTime	endTime	string	End time am: Morning pm: Afternoon allDay: All day
leaveTime	leaveTime	number	Leave duration
timeType	timeType	string	Duration type 0: One day 1: Multiple days
remark	remark	string	Reason
status	status	string	Approval status 0: Under review, 1: Rejected, 2: Approved
holidayDate	holidayDate	date	Leave date for single-day leave
time	time	string	Leave time for single-day leave am: Morning pm: Afternoon allDay: All day

ResultV3LeaveHolidayDetailResp

Name	Path	Type
code	code	integer
message	message	string
data	data	V3LeaveHolidayDetailResp

V3LeaveHolidayDetailResp

Name	Path	Type	Description
id	id	string	id
employeeId	employeeId	string	Employee ID
englishName	englishName	string	English Name
chineseName	chineseName	string	Chinese Name
code	code	string	Code
holidayType	holidayType	string	Leave Type ID
holidayTypeName	holidayTypeName	string	Leave Type Name
startDate	startDate	date	Start Date
startTime	startTime	string	Start Time am:Morning pm:Afternoon allDay:All day
endDate	endDate	date	End Date
endTime	endTime	string	End Time am:Morning pm:Afternoon allDay:All day
leaveTime	leaveTime	number	Leave Duration
timeType	timeType	string	Duration Type 0:A Day 1:Multiple Days
remark	remark	string	Reason
status	status	string	Approval Status 0:Pending 1:Rejected 2:Approved
holidayDate	holidayDate	date	Leave Date for Single Day Leave
time	time	string	Leave Time for Single Day Leave am:Morning pm:Afternoon allDay:All day
departmentName	departmentName	string	Department Name
positionName	positionName	string	Position Name
balance	balance	number	Available Balance
unit	unit	string	Leave Type Unit 1.Day 0.Hour

ResultListV3LeaveProcessResp

Name	Path	Type
code	code	integer
message	message	string
data	data	array of V3LeaveProcessResp

V3LeaveProcessResp

Leave application approval process information

Name	Path	Type	Description
id	id	string	ID
recordId	recordId	string	Application ID
employeeId	employeeId	string	Approver ID
employeeName	employeeName	string	Approver name
status	status	string	Approval status 0:In progress, 1:Rejected, 2:Approved, 3:Cancelled, 4:Deleted
remark	remark	string	Approval comments
workFlowOrder	workFlowOrder	integer	Approval sequence
recordType	recordType	string	Application type
isCurrent	isCurrent	boolean	Whether the process is at the current approver

IPageV3BizReimbursementTypeResp

Name	Path	Type
size	size	integer
current	current	integer
pages	pages	integer
total	total	integer
records	records	array of V3BizReimbursementTypeResp

ResultIPageV3BizReimbursementTypeResp

Name	Path	Type
code	code	integer
message	message	string
data	data	IPageV3BizReimbursementTypeResp

V3BizReimbursementTypeResp

Reimbursement Type

Name	Path	Type	Description
id	id	string	ID
name	name	string	Name

IPageV3BizReimbursementResp

Name	Path	Type
size	size	integer
current	current	integer
pages	pages	integer
total	total	integer
records	records	array of V3BizReimbursementResp

ResultIPageV3BizReimbursementResp

Name	Path	Type
code	code	integer
message	message	string
data	data	IPageV3BizReimbursementResp

V3BizReimbursementResp

Reimbursement application

Name	Path	Type	Description
id	id	string	ID
employeeId	employeeId	string	Employee ID
code	code	string	Employee code
reimbursementType	reimbursementType	string	Reimbursement type
reimbursementTypeName	reimbursementTypeName	string	Reimbursement type name
reimbursementDate	reimbursementDate	date	Reimbursement date
reimbursementName	reimbursementName	string	Reimbursement name
amount	amount	number	Reimbursement amount
remark	remark	string	Reason
status	status	string	Approval status 0-Pending 1-Rejected 2-Approved 3-Cancelled 4-Deleted
englishName	englishName	string	English name

ResultV3BizReimbursementDetailResp

Name	Path	Type	Description
code	code	integer
message	message	string
data	data	V3BizReimbursementDetailResp	Reimbursement application details

V3BizReimbursementDetailResp

Reimbursement application details

Name	Path	Type	Description
id	id	string	ID
employeeId	employeeId	string	Employee ID
code	code	string	Employee code
chineseName	chineseName	string	Chinese name
englishName	englishName	string	English name
departmentName	departmentName	string	Department name
reimbursementType	reimbursementType	string	Reimbursement type
reimbursementTypeName	reimbursementTypeName	string	Reimbursement type name
reimbursementDate	reimbursementDate	date	Reimbursement date
reimbursementName	reimbursementName	string	Reimbursement name
amount	amount	number	Reimbursement amount
remark	remark	string	Reason
status	status	string	Approval status 0-Pending approval 1-Rejected 2-Approved 3-Cancelled 4-Deleted

IPageV3EmployeeListResp

Name	Path	Type
size	size	integer
current	current	integer
pages	pages	integer
total	total	integer
records	records	array of V3EmployeeListResp

ResultIPageV3EmployeeListResp

Name	Path	Type
code	code	integer
message	message	string
data	data	IPageV3EmployeeListResp

V3EmployeeListResp

Employee information

Name	Path	Type	Description
id	id	string	ID
headFile	headFile	string	Head sculpture
code	code	string	Code
englishName	englishName	string	Name (display name)
surnameEnglish	surnameEnglish	string	Surname (ID card)
personalNameEnglish	personalNameEnglish	string	Given Name (ID card)
departmentId	departmentId	string	Department ID
departmentName	departmentName	string	Department Name
departmentCode	departmentCode	string	Department Code
positionId	positionId	string	Job ID
positionName	positionName	string	Job Name
positionCode	positionCode	string	Job Code
directSupervisorId	directSupervisorId	string	Manager ID
directSupervisorEnglishName	directSupervisorEnglishName	string	Manager Name
directSupervisorCode	directSupervisorCode	string	Manager Code
entryDate	entryDate	date	Entry Date
lastWorkingDate	lastWorkingDate	date	Last Working Date
attendCalculationId	attendCalculationId	string	Office Location ID
attendCalculationName	attendCalculationName	string	Office Location Name
attendCalculationCode	attendCalculationCode	string	Office Location Code
countryCode	countryCode	string	Region Code
phone	phone	string	Phone
email	email	string	Email
birthday	birthday	string	Date Of Birth
hireType	hireType	string	Employment Form (0: Full Time,1: Temporary, 2: Freelance, 3: Part Time, 4: Contract,5: Internship, 6: Virtual Employee)
calculateSalaryType	calculateSalaryType	string	Salary Calculation Method (0: Monthly 1: Hourly 2: Yearly 3: Daily 4: Weekly)
status	status	integer	Status (0 Resignation, 1 Employment)
regularType	regularType	string	Holiday Rule ID
regularTypeName	regularTypeName	string	Holiday Rule Name
payrollRegulationId	payrollRegulationId	string	Salary Rule ID
payrollRegulationName	payrollRegulationName	string	Salary Rule Name
costCenterId	costCenterId	string	Cost Center ID
costCenterName	costCenterName	string	Cost Center Name
costCenterCode	costCenterCode	string	Cost Center Code

ResultV3EmployeeInfoResp

Name	Path	Type	Description
code	code	integer
message	message	string
data	data	V3EmployeeInfoResp	Employee information

V3EmployeeInfoResp

Employee information

Name	Path	Type	Description
id	id	string	Id
englishName	englishName	string	English Name
chineseName	chineseName	string	Chinese Name
email	email	string	Email
countryCode	countryCode	string	Region Code
phone	phone	string	Phone
sex	sex	string	Sex
age	age	integer	Age
address	address	string	Residential Area
code	code	string	Code
identityCard	identityCard	string	Identity Card
bankCard	bankCard	string	Bank Card
status	status	integer	Status (0 Resignation, 1 Employment)
flag	flag	integer	Tag (0: Add To Preferred, 1: Add To Blacklist)
score	score	number	Score
expectedArea	expectedArea	string	Expected Region
nickName	nickName	string	Nickname
position	position	string	Apply For A Position
arrivalDate	arrivalDate	date-time	Date Of Availability
salary	salary	integer	Expected Salary
education	education	string	Education Level (0: Form 3/Certificate, 1: Form 5/Certificate, 2: Hong Kong Diploma Of Secondary Education/Form 7/Diploma, 3: Associate Degree/Advanced Diploma, 4: Bachelor's Degree, 5: Master's Degree, 6: Doctoral Degree)
comApplication	comApplication	string	Computer Applications
otherApplication	otherApplication	string	Other Applications
chineseTyping	chineseTyping	string	Chinese Typing
chineseOther	chineseOther	string	Chinese Typing Other
englishTyping	englishTyping	string	Typing
chineseWpm	chineseWpm	integer	Chinese Typing/Minute
englishWpm	englishWpm	integer	English Typing/Minute
cantonese	cantonese	string	Cantonese
english	english	string	English
mandarin	mandarin	string	Mandarin
otherLanguage	otherLanguage	string	Other Languages
birthday	birthday	string	Date Of Birth:
accountNumber	accountNumber	string	Account No
departmentId	departmentId	string	Department Id
departmentName	departmentName	string	Department Name
positionId	positionId	string	Job Id
positionName	positionName	string	Job Name
entryDate	entryDate	date	Entry Date
directSupervisorId	directSupervisorId	string	Manager ID
directSupervisorEnglishName	directSupervisorEnglishName	string	Manager Name
attendCalculationId	attendCalculationId	string	Office Location Id
attendCalculationName	attendCalculationName	string	Office Location Name
hireType	hireType	string	Employment Form (0: Full Time,1: Temporary, 2: Freelance, 3: Part Time, 4: Contract,5: Internship, 6: Virtual Employee)
basicPay	basicPay	number	Basic Pay
calculateSalaryType	calculateSalaryType	string	Salary Calculation Method (0: Monthly 1: Hourly 2: Yearly 3: Daily 4: Weekly)
takeEffectDate	takeEffectDate	date	Effective Date
nationality	nationality	string	Nationality
maritalStatus	maritalStatus	string	Marital Status (0: Single 1: Married 2: Divorced 3: Widowed)
emergencyContactName	emergencyContactName	string	Emergency Contact Name
emergencyContactRelation	emergencyContactRelation	string	Relationship
emergencyContactPhone	emergencyContactPhone	string	Emergency Contact Phone
bankName	bankName	string	Bank Name
bankBranchNumber	bankBranchNumber	string	Bank Branch Number
bankAccountNo	bankAccountNo	string	Bank Account
lastWorkingDate	lastWorkingDate	date	Last Working Date
bankCode	bankCode	string	Bank Number
remark	remark	string	Notes
regionCode	regionCode	string	Area Code
regularType	regularType	string	Holiday Rule Id
regularTypeName	regularTypeName	string	Holiday Rule Name
costCenterId	costCenterId	string	Cost Center Id
costCenterName	costCenterName	string	Cost Center Name
payrollRegulationId	payrollRegulationId	string	Salary Rule Id
payrollRegulationName	payrollRegulationName	string	Salary Rule Name
identityCardHk	identityCardHk	string	Hong Kong Identity Card No
passportNumber	passportNumber	string	Passport Number
passportIssuingPlace	passportIssuingPlace	string	Passport Issuance Location
spouseName	spouseName	string	Name Of Spouse
spouseIdentityCardHk	spouseIdentityCardHk	string	Spouse's Hong Kong Identity Card No
spousePassportNumber	spousePassportNumber	string	Spouse Passport Number
spousePassportIssuingPlace	spousePassportIssuingPlace	string	Spouse's Passport Issuance Location
postalAddress	postalAddress	string	Mail Address
employerName	employerName	string	Employer Name
reasonsLeave	reasonsLeave	string	Reason For Leaving (0: Death, 1: Redundancy, 2: Early Retirement Schemes, 3: Invalidity, 4: Dismiss, 5: Resignation, 6: Retirement, 7: Abandonment Of Employment, 8: Probation Period Not Completed Satisfactorily (legally Dismiss), 9: Fixed Term Contract Expire (legally As Dismiss))
isForDeparture	isForDeparture	string	Is The Resignation Process Underway (0: No 1:Yes)
hometown	hometown	string	Native Place
nation	nation	string	Nationality
politicalStatus	politicalStatus	string	Political Status
highestEducation	highestEducation	string	Highest Education Level
workDate	workDate	date	Date Of Employment (specified Seniority Calculation Date)
confirmationDate	confirmationDate	date	Date Of Confirmation
probation	probation	string	Trial Period
isDisabled	isDisabled	boolean	Are You A Person With Disabilities (0: No 1:Yes)
isForeignNationality	isForeignNationality	boolean	Are You A Foreigner (0: No 1:Yes)
domicileLocation	domicileLocation	string	Registered Residence
certificateType	certificateType	string	Id Type (0: Identity Card, 1: Other)
certificateNumber	certificateNumber	string	Id No
isMartyrDependents	isMartyrDependents	boolean	Is It A Martyr's Family (0: No 1:Yes)
occupationTaxNumber	occupationTaxNumber	string	Occupational Tax Number
nonLocalBlueCardNumber	nonLocalBlueCardNumber	string	Non Local Employee Id Card (blue Card) Number
isForeignEmployees	isForeignEmployees	boolean	Are You A Non Local Employee (0: No 1:Yes)
weeklyLeaveWorkAgreement	weeklyLeaveWorkAgreement	string	Weekly Leave Work Agreement
workHours	workHours	number	Daily Hours Of Operation
employeeType	employeeType	string	Employee Classification
jobLevel	jobLevel	string	Job Grade
post	post	string	Position
salaryScale	salaryScale	string	Salary Scale
jobTitle	jobTitle	string	Job Title
recruitmentSource	recruitmentSource	string	Recruitment Source
graduatedSchool	graduatedSchool	string	Alma Mater
profession	profession	string	Major
calculateSalaryTypeText	calculateSalaryTypeText	string	Salary Calculation Form Value
hireTypeText	hireTypeText	string	Employment Form Value
termsOfWork	termsOfWork	string	Work Clause
totalHours	totalHours	number	Total Working Hours
payrollPackageFte	payrollPackageFte	number	Salary Package Fte
payrollPackageProData	payrollPackageProData	number	Compensation Package - pro_data
hourlyWagePercent	hourlyWagePercent	number	Hourly Wage Ratio
terminationCompensationDate	terminationCompensationDate	date	Calculation Date Of Severance Compensation
terminationEmployedLength	terminationEmployedLength	number	Resignation Length Of Service
ageOfTermination	ageOfTermination	integer	Resignation Age
appellation	appellation	string	Appellation
middleName	middleName	string	Middle Name
homePhone	homePhone	string	Home Phone
officePhone	officePhone	string	Office Phone
country	country	string	Country
province	province	string	Province
city	city	string	City
postcode	postcode	string	Postal Code
contractEndDate	contractEndDate	date	Contract End Date
taxNumber	taxNumber	string	Tax Id
taxpayerStatus	taxpayerStatus	string	Taxpayer Identity
isRequirementsThreshold	isRequirementsThreshold	string	Is A Threshold Required
isSupportingAccount	isSupportingAccount	string	Does It Support Accounting
exemptionMedicalInsuranceTax	exemptionMedicalInsuranceTax	string	Exemption From Medical Insurance Taxation 0: No Exemption, 1: Half Exemption, 2: All Exemption
tfnSignDate	tfnSignDate	date	Tfn Declaration Signing Date
taxIdentity	taxIdentity	string	Tax Identity
otherIncomeName	otherIncomeName	string	Naming Of Other Types Of Income
mobileCardCalType	mobileCardCalType	string	Calculation Method For Field Clock In (1: Not Counting Working Hours，2: Direct Working Hours，3: Work Hours After Approval)
termsOfWorkName	termsOfWorkName	string	Name Of Work Terms
insurePlanName	insurePlanName	string	Insurance Plan Name
majorWorkLocationId	majorWorkLocationId	string	Main Office Location
majorWorkLocationName	majorWorkLocationName	string	Main Office Location Name
whetherResidence	whetherResidence	string	Do You Provide A Place Of Residence
award	award	string	Labor Management Adjudication Agreement
employeeRateType	employeeRateType	string	Award Employment Type
classification	classification	string	Classification Level
payrollTemplateId	payrollTemplateId	string	Payroll Template
beneficiaryType	beneficiaryType	string	Beneficiary
surnameEnglish	surnameEnglish	string	Surname (ID card)
personalNameEnglish	personalNameEnglish	string	Given Name (ID card)
departmentCode	departmentCode	string	Department Code
positionCode	positionCode	string	Job Code
directSupervisorCode	directSupervisorCode	string	Code of Immediate Supervisor
attendCalculationCode	attendCalculationCode	string	Office Location Code
costCenterCode	costCenterCode	string	Cost Center Code

IPageV3EmployeeHistoryListResp

Name	Path	Type
size	size	integer
current	current	integer
pages	pages	integer
total	total	integer
records	records	array of V3EmployeeHistoryListResp

ResultIPageV3EmployeeHistoryListResp

Name	Path	Type
code	code	integer
message	message	string
data	data	IPageV3EmployeeHistoryListResp

V3EmployeeHistoryListResp

Name	Path	Type	Description
id	id	string	ID
employeeId	employeeId	string	Employee ID
employeeName	employeeName	string	Employee Name
departmentId	departmentId	string	Department ID
departmentName	departmentName	string	Department Name
positionId	positionId	string	Position ID
positionName	positionName	string	Position Name
entryDate	entryDate	date	Join Date
directSupervisorId	directSupervisorId	string	Manager ID
directSupervisorName	directSupervisorName	string	Manager Name
attendCalculationId	attendCalculationId	string	Location ID
attendCalculationName	attendCalculationName	string	Location Name
hireType	hireType	string	Employment Type (0: Full Time,1: Temporary, 2: Freelance, 3: Part Time, 4: Contract,5: Internship, 6: Virtual Employee)
basicPay	basicPay	number	Basic Salary
calculateSalaryType	calculateSalaryType	string	Salary Type (0: Monthly 1: Hourly 2: Yearly 3: Daily 4: Weekly)
workDate	workDate	date	Date of seniority calculation
confirmationDate	confirmationDate	date	Regularization Date
takeEffectStatus	takeEffectStatus	string	Take effect status (0: Have failed,1: Effect of,2: In the future to take effect,3: cancel)
takeEffectDate	takeEffectDate	date	Take effect date
regularType	regularType	string	Leave Policy
regularTypeName	regularTypeName	string	Leave Policy Name
cause	cause	string	Cause
remark	remark	string	Remarks
costCenterId	costCenterId	string	Cost center ID
costCenterName	costCenterName	string	Cost center Name
payrollRegulationId	payrollRegulationId	string	Payroll Policy
payrollRegulationName	payrollRegulationName	string	Payroll Policy Name
lastWorkingDate	lastWorkingDate	date	Termination Date
employeeStatus	employeeStatus	integer	Employee Status (0: Terminated,1: Active)
majorWorkLocationId	majorWorkLocationId	string	Major Location ID
majorWorkLocationName	majorWorkLocationName	string	Major Location Name

ResultListV3SysEnterpriseUserResp

Name	Path	Type
code	code	integer
message	message	string
data	data	array of V3SysEnterpriseUserResp

V3SysEnterpriseUserResp

Name	Path	Type	Description
id	id	string	ID
name	name	string	Name
countryCode	countryCode	string	Country/Region Code (e.g., HK for Hong Kong, AU for Australia, MO for Macau, TW for Taiwan)
phone	phone	string	Phone
email	email	string	Email
isEnabled	isEnabled	integer	Is Enabled, 1:Enabled, 0:Disabled
userId	userId	string	User ID
emailConfirmed	emailConfirmed	boolean	Email Confirmed
lastSendTime	lastSendTime	date-time	Last Send Verification Email Time
roleList	roleList	array of V3SysRoleResp	Role List

V3SysRoleResp

Name	Path	Type	Description
id	id	string	id
name	name	string	name
code	code	string	code
description	description	string	description
isEnabled	isEnabled	integer	isEnabled, 0:disabled, 1: enabled

ResultV3SysEnterpriseUserResp

Name	Path	Type
code	code	integer
message	message	string
data	data	V3SysEnterpriseUserResp

IPageV3LabelResp

Name	Path	Type
size	size	integer
current	current	integer
pages	pages	integer
total	total	integer
records	records	array of V3LabelResp

ResultIPageV3LabelResp

Name	Path	Type
code	code	integer
message	message	string
data	data	IPageV3LabelResp

V3LabelResp

Name	Path	Type	Description
id	id	string	ID
labelCode	labelCode	string	Label Code
labelName	labelName	string	Label Name
labelStatus	labelStatus	integer	Label Status, 0:Disabled, 1:Enabled
parentId	parentId	string	Parent Label ID
parentName	parentName	string	Parent Label Name

IPageV3PositionResp

Name	Path	Type
size	size	integer
current	current	integer
pages	pages	integer
total	total	integer
records	records	array of V3PositionResp

ResultIPageV3PositionResp

Name	Path	Type
code	code	integer
message	message	string
data	data	IPageV3PositionResp

V3PositionResp

Name	Path	Type	Description
id	id	string	ID
name	name	string	Position Name
positionCode	positionCode	string	Position Code
status	status	string	Status, 0:Disabled, 1:Enabled

IPageV3AttAddressResp

Name	Path	Type
size	size	integer
current	current	integer
pages	pages	integer
total	total	integer
records	records	array of V3AttAddressResp

ResultIPageV3AttAddressResp

Name	Path	Type
code	code	integer
message	message	string
data	data	IPageV3AttAddressResp

V3AttAddressResp

Name	Path	Type	Description
id	id	string	ID
name	name	string	Address Abbreviation
address	address	string	Detailed Address
longitude	longitude	number	Longitude
latitude	latitude	number	Latitude
region	region	integer	Check In Range
isEnableGps	isEnableGps	boolean	Is GPS Enabled, 0:Disabled, 1:Enabled
isEnableBluetooth	isEnableBluetooth	boolean	Is Bluetooth Enabled, 0:Disabled, 1:Enabled
attendanceAddressCode	attendanceAddressCode	string	Attendance Address Code
status	status	string	Status, 0:Disabled, 1:Enabled
mapType	mapType	string	Map Type, 0:Baidu Map; 1:Google Map; 2:Gaode Map
areaCode	areaCode	string	Region Code (e.g., HK for Hong Kong, AU for Australia, MO for Macau, TW for Taiwan)

ResultV3AttAddressResp

Name	Path	Type
code	code	integer
message	message	string
data	data	V3AttAddressResp

ResultV3AttRuleResp

Name	Path	Type
code	code	integer
message	message	string
data	data	V3AttRuleResp

V3AttRuleResp

Name	Path	Type	Description
id	id	string	id
workLocation	workLocation	string	Work Location
minIntervalTime	minIntervalTime	integer	Minimum Interval Time
shiftInRange	shiftInRange	integer	Shift In Range
shiftOffRange	shiftOffRange	integer	Shift Off Range
beLateRange	beLateRange	integer	Be Late Range
leaveEarlyRange	leaveEarlyRange	integer	Leave Early Range
workingHoursRounding	workingHoursRounding	integer	Working Hours Rounding
shiftInStandard	shiftInStandard	boolean	Shift In Standard
shiftOffStandard	shiftOffStandard	boolean	Shift Off Standard
scheduleTemplate	scheduleTemplate	string	Schedule Template
whetherUpdateClock	whetherUpdateClock	boolean	Whether Update Clock
prohibitClockingInOutsideTheOpenRange	prohibitClockingInOutsideTheOpenRange	boolean	Prohibit Clocking In Outside The Open Range

IPageV3DeviceResp

Name	Path	Type
size	size	integer
current	current	integer
pages	pages	integer
total	total	integer
records	records	array of V3DeviceResp

ResultIPageV3DeviceResp

Name	Path	Type
code	code	integer
message	message	string
data	data	IPageV3DeviceResp

V3DeviceResp

Name	Path	Type	Description
id	id	string	ID
name	name	string	Device Name
deviceId	deviceId	string	Device ID
major	major	string	Major
minor	minor	string	Minor
isRestrictLocation	isRestrictLocation	string	Is Restricted to Work Location
addressId	addressId	string	Check-in Point ID
addressName	addressName	string	Check-in Point Name
status	status	string	Status, 0:Disabled, 1:Enabled
deviceType	deviceType	string	Check-in Device Type, 0:Bluetooth; 1:Face Recognition

IPageV3DepartmentResp

Name	Path	Type
size	size	integer
current	current	integer
pages	pages	integer
total	total	integer
records	records	array of V3DepartmentResp

ResultIPageV3DepartmentResp

Name	Path	Type
code	code	integer
message	message	string
data	data	IPageV3DepartmentResp

V3DepartmentResp

Name	Path	Type	Description
id	id	string	ID
name	name	string	Department Name
departmentCode	departmentCode	string	Department Code
status	status	string	Status, 0:Disabled, 1:Enabled
parentId	parentId	string	Parent Department ID
parentName	parentName	string	Parent Department Name

IPageV3CostCenterResp

Name	Path	Type
size	size	integer
current	current	integer
pages	pages	integer
total	total	integer
records	records	array of V3CostCenterResp

ResultIPageV3CostCenterResp

Name	Path	Type
code	code	integer
message	message	string
data	data	IPageV3CostCenterResp

V3CostCenterResp

Name	Path	Type	Description
id	id	string	ID
name	name	string	Cost Center Name
costCenterCode	costCenterCode	string	Cost Center Code
status	status	string	Status, 0:Disabled, 1:Enabled

ResultV3TenantResp

Name	Path	Type	Description
code	code	integer
message	message	string
data	data	V3TenantResp	Tenant information

V3TenantResp

Tenant information

Name	Path	Type	Description
id	id	string	ID
bmsId	bmsId	string	BMSId
name	name	string	Name
businessRegistrationNumber	businessRegistrationNumber	string	Business registration number
countryCode	countryCode	string	Country/Region Code
phone	phone	string	Phone
email	email	string	Email
address	address	string	Address
logo	logo	string	Logo
region	region	string	Preset region (e.g., HK for Hong Kong, AU for Australia, MO for Macau, TW for Taiwan)
timeZone	timeZone	string	Time zone ID
realTimeZone	realTimeZone	string	Time zone
zoneName	zoneName	string	Time zone name
bankName	bankName	string	Bank name
bankBranchCode	bankBranchCode	string	Bank branch number
bankAccountNo	bankAccountNo	string	Bank Account
employerName	employerName	string	Employer's Name
employerPosition	employerPosition	string	Employer Position
employerFileNumber	employerFileNumber	string	Employer file number
mainLanguage	mainLanguage	string	Pre-set data master language field
currencyCode	currencyCode	string	Currency
accountType	accountType	string	Account Type
paymentCode	paymentCode	string	Payment code
paymentReference	paymentReference	string	Payment reference
legalNameOfEnterprise	legalNameOfEnterprise	string	Legal name of the enterprise
area	area	string	Legal name of the enterprise
is57ACompany	is57ACompany	string	Is it a 57A enterprise? 0: No, 1: Yes
branchNum	branchNum	string	Branch Office Number
postCode	postCode	string	zip code
agencyBusinessNum	agencyBusinessNum	string	Proxy company business number
registeredAgentNum	registeredAgentNum	string	Registration agent number
agentContactName	agentContactName	string	Name of proxy contact person
agentEmail	agentEmail	string	Agent email
agentTel	agentTel	string	Agent's phone number
hasAgentCompany	hasAgentCompany	string	Is there a proxy company? 0: No, 1: Yes
ausAbn	ausAbn	string	Tax ID (Australia Region)

IPageV3TimesheetListResp

Name	Path	Type
size	size	integer
current	current	integer
pages	pages	integer
total	total	integer
records	records	array of V3TimesheetListResp

ResultIPageV3TimesheetListResp

Name	Path	Type
code	code	integer
message	message	string
data	data	IPageV3TimesheetListResp

V3TimesheetListResp

Name	Path	Type	Description
id	id	string	ID
employeeId	employeeId	string	Employee ID
code	code	string	Employee code
englishName	englishName	string	Employee name
type	type	string	Application type (0: Overtime,1: Normal Hours,2: Break)
workOverTimeType	workOverTimeType	string	Overtime type (0: Working Overtime On Weekdays,1: Working Overtime On Rest Days,2: Working Overtime On Statutory Holidays)
date	date	date	Application date
startTime	startTime	date-time	Start time
endTime	endTime	date-time	End time
mealTime	mealTime	integer	Meal time
times	times	number	Application duration
addressCardId	addressCardId	string	Work location ID
addressCardName	addressCardName	string	Work location name
remark	remark	string	Remarks
finalApprover	finalApprover	string	Final approver ID
finalApproverName	finalApproverName	string	Final approver name
createTime	createTime	date-time	Submission time
status	status	string	Status (0: Pending,1: Denied,2: Approved,3: Canceled,4: Deleted)

ResultV3TimesheetInfoResp

Name	Path	Type
code	code	integer
message	message	string
data	data	V3TimesheetInfoResp

V3TimesheetInfoResp

Name	Path	Type	Description
id	id	string	ID
employeeId	employeeId	string	Employee ID
englishName	englishName	string	Employee name
type	type	string	Application type (0: Overtime,1: Normal Hours,2: Break)
workOverTimeType	workOverTimeType	string	Overtime type (0: Working Overtime On Weekdays,1: Working Overtime On Rest Days,2: Working Overtime On Statutory Holidays)
date	date	date	Application date
startTime	startTime	date-time	Start time
endTime	endTime	date-time	End time
mealTime	mealTime	integer	Meal time
times	times	number	Application duration
addressCardId	addressCardId	string	Work location ID
addressCardName	addressCardName	string	Work location name
attendanceItemId	attendanceItemId	string	Item ID
attendanceItemName	attendanceItemName	string	Item name
hourlyRate	hourlyRate	number	Hourly rate
tierRate	tierRate	number	Multiple
actualAmount	actualAmount	number	Actual amount
costCenterId	costCenterId	string	Cost center ID
costCenterName	costCenterName	string	Cost center name
remark	remark	string	Remarks

ResultListV3AttendanceDetailListResp

Name	Path	Type
code	code	integer
message	message	string
data	data	array of V3AttendanceDetailListResp

V3AttendanceDetailListResp

Name	Path	Type	Description
id	id	string	ID
dataStatus	dataStatus	string	Data status (0: Unaudited;1: Attendance review;2: Salary review)
attendDay	attendDay	date	Attendance date
type	type	string	Date type(0: Working Day,1: Rest Day,2: Legal Holiday)
shiftIn	shiftIn	string	The Time When One Should Be At Work
shiftOff	shiftOff	string	The Time When One Should Get Off Work
actualIn	actualIn	date-time	Actual Clock-in
actualOff	actualOff	date-time	Actual Clock-out
workingOvertime	workingOvertime	number	Overtime hours on weekdays
holidayOvertime	holidayOvertime	number	Overtime hours on day off
dayOffOvertime	dayOffOvertime	number	Overtime hours on holiday
beLateLength	beLateLength	double	Duration of late
leaveEarlyLength	leaveEarlyLength	double	Duration of early departure
leaveTime	leaveTime	number	Leave duration
adjust	adjust	number	Adjust duration
afterAdjust	afterAdjust	number	Adjusted duration
attendStatus	attendStatus	string	Attendance Status (0: Normal,1: Late,2: Overtime,3: Early Departure,4: Absenteeism,5: Unverified Clock-in,6: Other)

IPageV3StatusFlagListResp

Name	Path	Type
size	size	integer
current	current	integer
pages	pages	integer
total	total	integer
records	records	array of V3StatusFlagListResp

ResultIPageV3StatusFlagListResp

Name	Path	Type
code	code	integer
message	message	string
data	data	IPageV3StatusFlagListResp

V3StatusFlagListResp

Name	Path	Type	Description
id	id	string	ID
employeeId	employeeId	string	Employee ID
employeeName	employeeName	string	Employee name
employeeStatus	employeeStatus	string	Employee status (0: Free,1: Be busy)
timeType	timeType	string	Time type (0: One day,1: many days)
startDate	startDate	date	Start date
endDate	endDate	date	End date
recordDate	recordDate	date	Record date
expectWorkLocation	expectWorkLocation	string	Expected work location ID
expectWorkLocationName	expectWorkLocationName	string	Expected work location name
expectWorkTimeTemplate	expectWorkTimeTemplate	string	Expected work template ID
expectWorkTimeTemplateName	expectWorkTimeTemplateName	string	Expected work template name
expectWorkStartTime	expectWorkStartTime	string	Expected start time
expectWorkEndTime	expectWorkEndTime	string	Expected end time
remark	remark	string	Remarks

IPageV3AttendanceListResp

Name	Path	Type
size	size	integer
current	current	integer
pages	pages	integer
total	total	integer
records	records	array of V3AttendanceListResp

ResultIPageV3AttendanceListResp

Name	Path	Type
code	code	integer
message	message	string
data	data	IPageV3AttendanceListResp

V3AttendanceListResp

Name	Path	Type	Description
id	id	string	ID
employeeId	employeeId	string	Employee ID
code	code	string	Employee code
englishName	englishName	string	Employee name
positionId	positionId	string	Position ID
positionName	positionName	string	Position name
departmentId	departmentId	string	Department ID
departmentName	departmentName	string	Department name
startDate	startDate	string	Start date
endDate	endDate	string	End date
shiftLabor	shiftLabor	number	The required attendance duration
laborLength	laborLength	number	The actual work hours
workingOvertime	workingOvertime	number	Overtime hours on weekdays
dayOffOvertime	dayOffOvertime	number	Overtime hours on day off
holidayOvertime	holidayOvertime	number	Overtime hours on holiday
beLateLength	beLateLength	double	Duration of late
leaveEarlyLength	leaveEarlyLength	double	Duration of early departure
leaveTime	leaveTime	number	Leave duration
absenceLength	absenceLength	number	Absence duration
adjust	adjust	number	Adjust duration

IPageV3AttendanceItemListResp

Name	Path	Type
size	size	integer
current	current	integer
pages	pages	integer
total	total	integer
records	records	array of V3AttendanceItemListResp

ResultIPageV3AttendanceItemListResp

Name	Path	Type
code	code	integer
message	message	string
data	data	IPageV3AttendanceItemListResp

V3AttendanceItemListResp

Name	Path	Type	Description
id	id	string	ID
name	name	string	Name
hkName	hkName	string	Traditional Chinese name
enName	enName	string	English name
cnName	cnName	string	Simplified Chinese Name
defaultId	defaultId	string	Built in item ID
regulationRulesAlias	regulationRulesAlias	string	Formula alias
decimalDigits	decimalDigits	integer	Decimal places
carryRule	carryRule	string	Carry rule (0: Round Up,1: Round Off,2: Round Down)
sequence	sequence	integer	Custom Number
isExistRegulationRules	isExistRegulationRules	integer	Is exists formula (0: No,1: Yes)
regulationRules	regulationRules	string	Formula content
field	field	string	Attendance entity field name
calculationOrder	calculationOrder	integer	Attendance calculation sequence

IPageV3MobileCardListResp

Name	Path	Type
size	size	integer
current	current	integer
pages	pages	integer
total	total	integer
records	records	array of V3MobileCardListResp

ResultIPageV3MobileCardListResp

Name	Path	Type
code	code	integer
message	message	string
data	data	IPageV3MobileCardListResp

V3MobileCardListResp

Name	Path	Type	Description
id	id	string	ID
employeeId	employeeId	string	Employee ID
employeeCode	employeeCode	string	Employee code
employeeEnglishName	employeeEnglishName	string	Employee name
employeeDeptName	employeeDeptName	string	Department name
date	date	date-time	Date
cardType	cardType	string	Mobile card type (1: Clock-in,2: Clock-out)
mode	mode	string	Check in method (0: GPS,1: Bluetooth,2: Wifi,3: QR code,4: Field check-in,5: Face recognition)
workLocationId	workLocationId	string	Work location ID
workLocationName	workLocationName	string	Work location name
actualLongitude	actualLongitude	number	Longitude
actualLatitude	actualLatitude	number	Latitude
deviceName	deviceName	string	Equipment name
codeSource	codeSource	string	QR code source
deviceId	deviceId	string	Bind device ID

ResultV3MobileCardInfoResp

Name	Path	Type
code	code	integer
message	message	string
data	data	V3MobileCardInfoResp

V3MobileCardInfoResp

Name	Path	Type	Description
id	id	string	ID
employeeId	employeeId	string	Employee ID
employeeCode	employeeCode	string	Employee code
employeeEnglishName	employeeEnglishName	string	Employee name
date	date	date-time	Date
attendDate	attendDate	date	Attendance date
cardType	cardType	string	Mobile card type (1: Clock-in,2: Clock-out)
mode	mode	string	Check in method (0: GPS,1: Bluetooth,2: Wifi,3: QR code,4: Field check-in,5: Face recognition)
workLocationId	workLocationId	string	Work location ID
workLocationName	workLocationName	string	Work location name
actualLongitude	actualLongitude	number	Longitude
actualLatitude	actualLatitude	number	Latitude
deviceName	deviceName	string	Equipment name
codeSource	codeSource	string	QR code source
deviceId	deviceId	string	Bind device ID

IPageV3ShiftTemplateListResp

Name	Path	Type
size	size	integer
current	current	integer
pages	pages	integer
total	total	integer
records	records	array of V3ShiftTemplateListResp

ResultIPageV3ShiftTemplateListResp

Name	Path	Type
code	code	integer
message	message	string
data	data	IPageV3ShiftTemplateListResp

V3ShiftTemplateListResp

Name	Path	Type	Description
id	id	string	ID
name	name	string	Name
shiftIn	shiftIn	string	Start Time
shiftOff	shiftOff	string	End Time
mealTime	mealTime	integer	Meal duration
remark	remark	string	Remarks
status	status	string	Status (0: Disabled, 1: Enabled)
attendanceAddressId	attendanceAddressId	string	Work location ID
attendanceAddressName	attendanceAddressName	string	Work location Name
dateType	dateType	string	Shift Type (0: weekdays, 1: rest days, 2: statutory holidays)
isDeductionMealTime	isDeductionMealTime	boolean	Deducting meal time (1: Yes, 0: No)
lunchStartTime	lunchStartTime	string	Lunch start time
lunchEndTime	lunchEndTime	string	Lunch end time

IPageV3RosterListResp

Name	Path	Type
size	size	integer
current	current	integer
pages	pages	integer
total	total	integer
records	records	array of V3RosterListResp

ResultIPageV3RosterListResp

Name	Path	Type
code	code	integer
message	message	string
data	data	IPageV3RosterListResp

V3RosterListResp

Name	Path	Type	Description
id	id	string	ID
employeeId	employeeId	string	Employee ID
employeeEnglishName	employeeEnglishName	string	Employee Name
attendDay	attendDay	date	Attendance Date
shiftTemplateId	shiftTemplateId	string	Shift template ID
shiftTemplateName	shiftTemplateName	string	Shift template Name
shiftIn	shiftIn	string	Start Time
shiftOff	shiftOff	string	End Time
actualIn	actualIn	date-time	Actual Clock-in
actualOff	actualOff	date-time	Actual Clock-out
beLateLength	beLateLength	number	Duration of late
leaveEarlyLength	leaveEarlyLength	number	Duration of early departure
shiftLabor	shiftLabor	number	The required attendance duration
laborLength	laborLength	number	The actual work hours
attendStatus	attendStatus	string	Attendance status (0: normal, 1: late, 2: overtime, 3: early leave, 4: absenteeism)
mealTime	mealTime	integer	Meal duration
shiftStatus	shiftStatus	string	Shift Status (0: Published, 1: Unpublished)
remark	remark	string	Remarks
attendanceItemId	attendanceItemId	string	Project ID
attendanceItemName	attendanceItemName	string	Project Name
dateType	dateType	string	Shift Type (0: weekdays, 1: rest days, 2: statutory holidays)

ResultV3RosterInfoResp

Name	Path	Type
code	code	integer
message	message	string
data	data	V3RosterInfoResp

V3RosterInfoResp

Name	Path	Type	Description
id	id	string	ID
employeeId	employeeId	string	Employee ID
employeeEnglishName	employeeEnglishName	string	Employee Name
attendDay	attendDay	date	Attendance Date
shiftTemplateId	shiftTemplateId	string	Shift template ID
shiftTemplateName	shiftTemplateName	string	Shift template Name
shiftIn	shiftIn	string	Start Time
shiftOff	shiftOff	string	End Time
actualIn	actualIn	date-time	Actual Clock-in
actualOff	actualOff	date-time	Actual Clock-out
beLateLength	beLateLength	number	Duration of late
leaveEarlyLength	leaveEarlyLength	number	Duration of early departure
shiftLabor	shiftLabor	number	The required attendance duration
laborLength	laborLength	number	The actual work hours
attendStatus	attendStatus	string	Attendance status (0: normal, 1: late, 2: overtime, 3: early leave, 4: absenteeism)
mealTime	mealTime	integer	Meal duration
shiftStatus	shiftStatus	string	Shift Status (0: Published, 1: Unpublished)
remark	remark	string	Remarks
attendanceItemId	attendanceItemId	string	Project ID
attendanceItemName	attendanceItemName	string	Project Name
dateType	dateType	string	Shift Type (0: weekdays, 1: rest days, 2: statutory holidays)

IPageV3ProjectListResp

Name	Path	Type
size	size	integer
current	current	integer
pages	pages	integer
total	total	integer
records	records	array of V3ProjectListResp

ResultIPageV3ProjectListResp

Name	Path	Type
code	code	integer
message	message	string
data	data	IPageV3ProjectListResp

V3ProjectListResp

Name	Path	Type	Description
id	id	string	ID
name	name	string	Name
code	code	string	Code
attendanceItemStatus	attendanceItemStatus	integer	Status (0: Disable,1: Enable)
categoryId	categoryId	string	Category ID
categoryName	categoryName	string	Category Name
hourlyRate	hourlyRate	number	Hourly rate
minRate	minRate	number	Min hourly rate
maxRate	maxRate	number	Max hourly rate

ResultV3ProjectInfoResp

Name	Path	Type
code	code	integer
message	message	string
data	data	V3ProjectInfoResp

V3ProjectInfoResp

Name	Path	Type	Description
id	id	string	ID
name	name	string	Name
code	code	string	Code
attendanceItemStatus	attendanceItemStatus	integer	Status (0: Disable,1: Enable)
categoryId	categoryId	string	Category ID
categoryName	categoryName	string	Category Name
hourlyRate	hourlyRate	number	Hourly rate
minRate	minRate	number	Min hourly rate
maxRate	maxRate	number	Max hourly rate

IPageV3ProjectCertificateListResp

Name	Path	Type
size	size	integer
current	current	integer
pages	pages	integer
total	total	integer
records	records	array of V3ProjectCertificateListResp

ResultIPageV3ProjectCertificateListResp

Name	Path	Type
code	code	integer
message	message	string
data	data	IPageV3ProjectCertificateListResp

V3ProjectCertificateListResp

Name	Path	Type	Description
id	id	string	ID
employeeId	employeeId	string	Employee ID
employeeName	employeeName	string	Employee Name
projectId	projectId	string	Project ID
projectName	projectName	string	Project Name
tier	tier	string	Tier
tierRate	tierRate	number	Tier rate
shiftHours	shiftHours	number	Schedule hours
workedHours	workedHours	number	Worked hours

IPageV3ProjectCertificateHoursListResp

Name	Path	Type
size	size	integer
current	current	integer
pages	pages	integer
total	total	integer
records	records	array of V3ProjectCertificateHoursListResp

ResultIPageV3ProjectCertificateHoursListResp

Name	Path	Type
code	code	integer
message	message	string
data	data	IPageV3ProjectCertificateHoursListResp

V3ProjectCertificateHoursListResp

Name	Path	Type	Description
id	id	string	ID
projectCertificateId	projectCertificateId	string	Project certificate ID
occurrenceTime	occurrenceTime	date-time	Occurrence time
status	status	string	Status (0: Taken Effect, 1: Planned)
type	type	integer	Type (5: Manual input, 10: System generated)
reason	reason	string	Reason
amount	amount	number	adjusted balance
balance	balance	number	Adjust the limit
payrollPlanId	payrollPlanId	string	Payroll Plan ID
payrollPlanName	payrollPlanName	string	Payroll Plan Name
shiftHour	shiftHour	number	Schedule hours

IPageV3ScheduleProjectCategoryListResp

Name	Path	Type
size	size	integer
current	current	integer
pages	pages	integer
total	total	integer
records	records	array of V3ScheduleProjectCategoryListResp

ResultIPageV3ScheduleProjectCategoryListResp

Name	Path	Type
code	code	integer
message	message	string
data	data	IPageV3ScheduleProjectCategoryListResp

V3ScheduleProjectCategoryListResp

Name	Path	Type	Description
id	id	string	ID
name	name	string	Name
code	code	string	Code
parentId	parentId	string	Parent category ID
status	status	string	Status (0: Disable,1: Enable)
parentName	parentName	string	Parent category name

IPageV3OpenShiftListResp

Name	Path	Type
size	size	integer
current	current	integer
pages	pages	integer
total	total	integer
records	records	array of V3OpenShiftListResp

ResultIPageV3OpenShiftListResp

Name	Path	Type
code	code	integer
message	message	string
data	data	IPageV3OpenShiftListResp

V3OpenShiftListResp

Name	Path	Type	Description
id	id	string	ID
code	code	string	Code
projectId	projectId	string	Project ID
projectName	projectName	string	Project Name
costCenterId	costCenterId	string	Cost center ID
costCenterName	costCenterName	string	Cost center Name
categoryId	categoryId	string	Category ID
categoryName	categoryName	string	Category Name
hourlyRate	hourlyRate	number	Hourly rate
date	date	date	Date
startTime	startTime	string	Start time
endTime	endTime	string	End time
scheduleHours	scheduleHours	number	The required attendance duration
empPlanNo	empPlanNo	integer	Planned number of employees
empScheduleNo	empScheduleNo	integer	Number of employees arranged
locationId	locationId	string	Work location ID
shiftType	shiftType	string	Shift Type (0: weekdays, 1: rest days, 2: statutory holidays)
remark	remark	string	Remarks
mealTime	mealTime	integer	Meal duration
status	status	string	Status (2: Paid)
scheduledAmount	scheduledAmount	number	Schedule amount
planAmount	planAmount	number	Plan Amount

ResultV3OpenShiftInfoResp

Name	Path	Type
code	code	integer
message	message	string
data	data	V3OpenShiftInfoResp

V3OpenShiftInfoResp

Name	Path	Type	Description
id	id	string	ID
code	code	string	Code
projectId	projectId	string	Project ID
projectName	projectName	string	Project Name
costCenterId	costCenterId	string	Cost center ID
costCenterName	costCenterName	string	Cost center Name
hourlyRate	hourlyRate	number	Hourly rate
date	date	date	Date
startTime	startTime	string	Start time
endTime	endTime	string	End time
scheduleHours	scheduleHours	number	The required attendance duration
empPlanNo	empPlanNo	integer	Planned number of employees
empScheduleNo	empScheduleNo	integer	Number of employees arranged
locationId	locationId	string	Work location ID
locationName	locationName	string	Work location Name
categoryId	categoryId	string	Category ID
categoryName	categoryName	string	Category Name
shiftType	shiftType	string	Shift Type (0: weekdays, 1: rest days, 2: statutory holidays)
remark	remark	string	Remarks
mealTime	mealTime	integer	Meal duration
status	status	string	Status (2: Paid)
scheduledAmount	scheduledAmount	number	Schedule amount
planAmount	planAmount	number	Plan Amount

Share via

Workstem HK (Preview)

Workstem HK

Pre-requisites

API documentation

Supported Operations

Throttling Limits

Actions

Add a cost center

Parameters

Returns

Add a department

Parameters

Returns

Add a new calendar remark

Parameters

Returns

Add a position

Parameters

Returns

Add a tag

Parameters

Returns

Add employee history

Parameters

Returns

Add employee information

Parameters

Returns

Add External Salary Data

Parameters

Returns

Add fixed salary data

Parameters

Returns

Add Leave Application

Parameters

Returns

Add leave balance adjustment record

Parameters

Returns

Add location info

Parameters

Returns

Add mobile card

Parameters

Returns

Add open shift information

Parameters

Returns

Add project category information

Parameters

Returns

Add project certificate hours

Parameters

Returns

Add project certificate information

Parameters

Returns

Add project information

Parameters

Returns

Add Reimbursement Application

Parameters

Returns

Add roster information

Parameters

Returns

Add shift template information

Parameters

Returns

Add timesheet

Parameters

Returns

Add Variable Salary Data

Parameters

Returns

Add Work Pattern Info

Parameters

Returns