API ReferenceEmployees

Offboard an employee

Schedules an employee to be offboarded. Changes affecting payroll will be reflected in the next available payroll cycle data run. Offboarding an employee can be cancelled up to, and including, the day before they are scheduled for offboarding. A webhook is available to inform you when this completes.

Path parameters

employee_idstringRequired

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

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

Request

This endpoint expects an object.
offboard_ondatetimeRequired
offboard_reasonstringRequired

Response

OK

first_namestring
last_namestring
date_of_birthstringformat: "date"
sex_at_birthenum
Allowed values:
national_tax_idstring
phone_numberstring
emailstring
platform_idstringOptionalformat: "pt_.+"
idstringOptionalformat: "ee_.+"
employer_idstringOptionalformat: "er_.+"
statusenumOptional
Allowed values:
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

Errors