Create Employee

Create a new employee with personal details and engagement/job configuration.

Authentication

AuthorizationBearer

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

Headers

vnd.a1.tenant-idstringOptional

Tenant identifier for multi-tenant environments

Request

This endpoint expects an object.
personalDetailsobjectRequired
Personal details of the employee
engagementlist of objectsRequired
Engagement and job assignment details
bankobjectOptional
Bank account details
taxInformationobjectOptional
Tax information

Response

Employee created successfully
idintegerOptional
Internal employee ID
userUuidstringOptional
remoteIdintegerOptional
remoteSourcestringOptional
isLockedbooleanOptional
Whether the employee account is locked
personalDetailsobjectOptional
engagementlist of objectsOptional
bankobjectOptional
tax_informationobjectOptional
Tax and payroll information for the active engagement
lastSyncStatusobjectOptional

Sync status per category (e.g. JOB, TAX, BANK, EMPLOYEE)

employeeStatusintegerOptional
Numeric employee status code
employeeStateenumOptional
externalEmployeeNumberstringOptional

External employee number from integration (e.g. PaySpace)

Errors

400
Bad Request Error