API ReferenceEmployees

Cancel offboarding an employee

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.

Authentication

AuthorizationBearer
Authorization header using the Bearer scheme

Path Parameters

employee_idstringRequiredformat: "ee_.+"

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:
national_tax_idstring
phone_numberstring
emailstring
platform_idstring or nullformat: "pt_.+"
idstring or nullformat: "ee_.+"
employer_idstring or nullformat: "er_.+"
statusenum or null
Allowed values:
external_customer_idstring or null

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_addressobject or null
nationalityenum or null
start_onstring or nullformat: "date"
earliest_benefits_start_datestring or nullformat: "date"
offboard_onstring or nullformat: "date-time"
bank_accountobject or null
metadatamap from strings to strings or null

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Maximum 25 keys. Individual keys can be up to 40 characters and values up to 500 characters.

objectstring or null
The object type

Errors