v2
latestOpenAPI 3.0.32026-08-07534393676.1 KBemployee
put/api/employee/{id}/
Path parameters
idstring uuid required
A UUID string identifying this employee.
Headers
X-Companystring
The company id to request data for
Request body
idstring uuid required
companystring uuid required
emergency_contact_namestring nullable
emergency_contact_phonestring nullable
date_of_birthstring date
started_onstring date
selfiestring uri nullable
signature_image_base64string nullable
selfie_base64string nullable
delete_selfiestring nullable
emailstring email
phone_numberstring
blood_typestring nullable
full_namestring required
short_namestring required
leave_calculationsstring required
day_cardsstring required
leave_accruedstring required
sick_leave_usedstring required
sick_leave_accruedstring required
annual_leave_hoursstring
sick_leave_hoursstring
payment_infostring
notification_settingsstring
created_atstring date-time required
updated_atstring date-time required
deleted_atstring date-time nullable
colorstring nullable
last_notification_seen_timestring date-time required
first_namestring required
last_namestring
addressstring nullable
The format should be "address line, suburb postcode, country"
industry_cardstring nullable
signature_namestring nullable
signature_imagestring uri nullable
workplace_agreement_signed_datestring date-time nullable
weekday_hourly_ratenumber double nullable
overtime_hourly_ratenumber double nullable
weekday_daily_ratenumber double nullable
weekend_hourly_ratenumber double nullable
tradestring nullable
qualificationstring nullable
swms_recipient_namestring nullable
swms_recipient_emailstring nullable
annual_leave_starting_hoursnumber double
sick_leave_starting_hoursnumber double
allergiesstring nullable
medical_conditionsstring nullable
last_update_cronstring date-time
xero_employee_idstring uuid nullable
myob_employee_idstring uuid nullable
total_hoursnumber double
maternity_leave_usednumber double
active_on_messages_sincestring date-time nullable
active_on_live_sincestring date-time nullable
Response
idstring uuid required
companystring uuid required
emergency_contact_namestring nullable
emergency_contact_phonestring nullable
date_of_birthstring date
started_onstring date
selfiestring uri nullable
signature_image_base64string nullable
selfie_base64string nullable
delete_selfiestring nullable
emailstring email
phone_numberstring
blood_typestring nullable
full_namestring required
short_namestring required
leave_calculationsstring required
day_cardsstring required
leave_accruedstring required
sick_leave_usedstring required
sick_leave_accruedstring required
annual_leave_hoursstring
sick_leave_hoursstring
payment_infostring
notification_settingsstring
created_atstring date-time required
updated_atstring date-time required
deleted_atstring date-time nullable
colorstring nullable
last_notification_seen_timestring date-time required
first_namestring required
last_namestring
addressstring nullable
The format should be "address line, suburb postcode, country"
industry_cardstring nullable
signature_namestring nullable
signature_imagestring uri nullable
workplace_agreement_signed_datestring date-time nullable
weekday_hourly_ratenumber double nullable
overtime_hourly_ratenumber double nullable
weekday_daily_ratenumber double nullable
weekend_hourly_ratenumber double nullable
tradestring nullable
qualificationstring nullable
swms_recipient_namestring nullable
swms_recipient_emailstring nullable
annual_leave_starting_hoursnumber double
sick_leave_starting_hoursnumber double
allergiesstring nullable
medical_conditionsstring nullable
last_update_cronstring date-time
xero_employee_idstring uuid nullable
myob_employee_idstring uuid nullable
total_hoursnumber double
maternity_leave_usednumber double
active_on_messages_sincestring date-time nullable
active_on_live_sincestring date-time nullable