Retrieve employee details with payroll information

Response Object

Name	Type	Description
id	guid	Unique identifier of the employee
code	string	Code which is used to represent employee.
center_id	guid	Unique identifier of the center.
is_consultant	bool	Boolean that represents if the employee is a consultant or not.
created_by	guid	The id of the employee who created this employee profile.
personal_info	object	Object that contains personal information of the employee.
address	object	Object that comtains personal info of the employee.
login_info	object	Object that contains login information of the employee.
job_info	object	Object that contains job information of the employee.
preference_info	object	Object which contains preference information of the employee.
payroll_info	object	Object that contains the payroll info of the employee.
vanity_image_url	string	The employee profile image.
roles	object	`Optional` Object that contains the employee's security profile ID element: `security_profile_id`. For more information, refer to the Retrieve the list of security roles in a center API.
catalog_info	object	Object that contains the catalog information of the employee.

job_info Object

Name	Type	Description
job_id	guid	`Mandatory` Unique 32-character identifier of the employee's job.
job_name	string	`Optional` Name of the employee's job.
designation_id	guid	`Optional` Unique 32-character identifier of the employee's designation.
company_name	string	`Optional` Name of the employee's company.
salary	decimal	`Optional` Salary of the employee.
hourly_rate	decimal	`Optional` Hourly rate of the employee.
overtime_baseline_hours	decimal	`Optional` If the employees works for more than the specified number of overtime_baseline_hours, it is considered as overtime for that employee.
overtime_type	int	`Optional` Type of the employee's overtime: weekly = 7.
overtime_multiplier	decimal	`Optional` Multiplier for the employee's overtime. Employee's overtime payment amount = (overtime_multiplier x base rate amount of the employee).
work_task_ids	Collection of guid	`Optional` Array of work task IDs for the employee.
request_therapist_bonus	decimal	`Optional` Therapist bonus requested for the employee.
mandatory_break_period	int	`Optional` Mandatory break period time provided to the employee.
is_elgible_for_additional_commision_bonus	boolean	`Optional` Indicates whether the employee is eligible for additional commission hours.
max_work_hours	int	`Optional` Maximum number of working hours of the employee.
target_revenue	decimal	`Optional` Target revenue of the employee.
vacation_days	int	`Optional` Number of days provided to the employee for vacation.
special_leave_days	int	`Optional` Number of days provided to the employee as special leave days.
start_date	datetime	`Optional` Date on which the employee started to work in the center.
end_date	datetime	`Optional` Date on which the employee stopped to work in the center.
tenure_start_date	datetime	`Optional` Tenure start date of the employee.
pay_type	enum	`Optional` Indicates the type of payment type received by the employee: 0 - center default payment type, 1 - Houly pay + commission (overtime exempt), 2 - Hourly pay + commission (overtime eligible). If you do not specify any value for this parameter, the default value is considered as 0.

preference_info Object

Name	Type	Description
culture_id	int	Unique identifier of the employee's culture.
search_tags	string	Search tags associated to the employee.
receive_marketing_emails	boolean	Indicates whether the employee can receive marketing emails.
receive_marketing_messages	boolean	Indicates whether the employee can receive marketing messages.
receive_transactional_emails	boolean	Indicates whether the employee can receive transactional emails.
receive_transactional_messages	boolean	Indicates whether the employee can receive transactional messages.
receive_daily_reports	boolean	Indicates whether the employee can receive daily reports.
receive_register_closure_report	boolean	Indicates whether the employee can receive the Register Closure report.
waive_biometric_checkin	boolean	Indicates whether the employee's biometric check-in process has been waived.
access_manager_productivity_app	boolean	Indicates whether the employee can access the Manager Productivity app.
is_mentor	boolean	Indicates whether the employee is a mentor.
access_employee_productivity_app	boolean	Indicates whether the employee can access the Employee Productivity app.
access_code	string	Access code of the employee.
keyword	string	Keywords used to search for the employee.
allow_analytics_access	int	If true, it indicates that the employee has been granted access to analytics data.
allow_api_access	boolean	If true, it indicates that the employee has been granted access to APIs.
text_field_1	string	Primary text field.
text_field_2	string	Secondary text field.
additional_date_1	datetime	Any additional date of significance provided to the employee.
additional_date_2	datetime	Any further additional date of significance provided to the employee.
send_confirmation_for_scheduled_appointments	boolean	Send confirmation email and text to guests for appointments scheduled for this employee.

personal_info Object

Name	Type	Description
first_name	string	`Mandatory` First name of the employee.
middle_name	string	`Optional` Middle name of the employee.
last_name	string	`Optional` Middle name of the employee.
nick_name	string	`Mandatory` Nickname of the employee.
notification_name	string	`Mandatory` Name of the employee that is to be displayed in notifications.
email	string	`Mandatory` Email ID of the employee.
mobile_phone	object	`Mandatory` Object that contains the employee's mobile phone-related elements: `country_code` and `number`.
home_phone	object	`Optional` Object that contains the employee's home phone-related elements: `country_code` and `number`.
work_phone	object	`Optional` Object that contains the employee's work phone-related elements: `country_code` and `number`.
gender	enum	`Optional` Indicates the gender of the employee: NotSpecified - -1, Male - 1, Female - 0, and Other - 3.
birth_date	datetime	`Optional` Birth date and time of the employee.
anniversary_date	datetime	`Optional` Date and time of the employee's anniversary.

address Object

Name	Type	Description
address_1	string	`Optional` Primary address of the employee.
address_2	string	`Optional` Secondary address of the employee.
city	string	`Optional` City in which the employee resides.
country_id	int	`Optional` Unique ID of the country to which employee belongs. You can retrieve the appropriate country_id by using the List all countries API.
state_id	int	`Optional` Unique ID of the state to which employee belongs.
zip_code	string	`Optional` Zip code of the employee's address.

login_info Object

Name	Type	Description
username	string	Username of the employee

catalog_info Object

Name	Type	Description
show_in_catalog	bool	Shows the employee information in the catalog.
display_name	string	Displays the name of the employee.
description	string	Brief description for the employee.

payroll_info Object

Name	Type	Description
include_in_payroll	int	Information about employee payroll.