Cancel offboarding an employee

POST
/employees/:employee_id/offboard/cancel

Cancels the scheduled offboarding of an employee. Adjusts the next payroll cycle data to compensate for this change and if payroll ran while the offboarding was scheduled the next payroll cycle data will be adjusted to bring the scheme back to balance.

Path parameters

employee_idstringRequired

Headers

Idempotency-KeystringOptional

Unique key to ensure idempotent requests. If the same key is used for multiple identical & successful requests, the same response will be returned. Read more here

Response

OK

first_namestring
last_namestring
date_of_birthstringformat: "date"
sex_at_birthenum
Allowed values: malefemale
national_tax_idstring
phone_numberstring
emailstring
platform_idstringOptionalformat: "pt_.+"
idstringOptionalformat: "ee_.+"
employer_idstringOptionalformat: "er_.+"
statusenumOptional
Allowed values: pendingactiveoffboardinginactiverestricted
external_customer_idstringOptional

A unique identifier assigned by the Employer of Record (EoR) platform to the Customer (i.e. the company using the EoR service) for which the employee is employed. This ID groups employees under this Customer, enabling the aggregation of contribution reporting and other values per Customer rather than per legal entity. This parameter is only available to EoR platforms.

home_addressobjectOptional
nationalityenumOptional
start_onstringOptionalformat: "date"
offboard_ondatetimeOptional
bank_accountobjectOptional
objectstringOptional

The object type

Built with