Initiate the Self Setup process for an Employee. If the employee has an existing employee record, the id should be specified. If the Email and Mobile provided are not the same as those on the employee record, they will be updated. If the employee does not yet have an employee record do not specify an id, one will be created with the details provided.
POST https://api.yourpayroll.com.au/api/v2/business/{businessId}/manager/employeeonboarding/initiateselfservice
Parameter name | Value | Description | Additional |
---|---|---|---|
businessId | string | Required |
The request body takes a complete AuInitiateEmployeeOnboardingApiModel resource, containing the following writable properties:
{
"email": "string",
"emergencyContactDetailsRequired": "boolean",
"employingEntityId": "int32",
"firstName": "string",
"id": "int32",
"mobile": "string",
"qualificationsRequired": "boolean",
"surname": "string",
"title": "int32"
}
Name | Type | Description |
---|---|---|
string | String | |
emergencyContactDetailsRequired | boolean | Boolean |
employingEntityId | int32 |
Nullable |
firstName | string | String |
id | int32 |
Nullable |
mobile | string | String |
qualificationsRequired | boolean | Boolean |
surname | string | String |
title | int32 |
Nullable |
The following HTTP status codes may be returned, optionally with a response resource.
Status code | Description | Resource |
---|---|---|
200 | OK OK |
Powered by DapperDox