Updates the personal details for the specified employee. Only fields to be updated need be specified. Fields left unspecified or null will not be changed. To update a field provide the new value, to specifically clear a value use the string "(clear)". Valid TitleId values can be obtained from api/v2/ess/{employeeId}/lookup/title Valid SuburbId values can be obtained from api/v2/ess/{employeeId}/lookup/suburbs

Request

PUT https://api.yourpayroll.com.au/api/v2/ess/{employeeId}/personaldetails

Path parameters

Parameter name Value Description Additional
employeeId string Required

Request body

The request body takes a complete AuEssEmployeeDetailsEditModel resource, containing the following writable properties:

{
    "dateOfBirth": "date-time",
    "email": "string",
    "firstName": "string",
    "gender": "string",
    "homePhone": "string",
    "id": "int32",
    "isPostalAddressSameAsResidential": "boolean",
    "middleName": "string",
    "mobilePhone": "string",
    "otherName": "string",
    "postalAddress": {
        "addressLine2": "string",
        "country": "string",
        "countryId": "string",
        "isManualAddress": "boolean",
        "isOutOfRegion": "boolean",
        "postcode": "string",
        "state": "string",
        "streetAddress": "string",
        "suburb": "string",
        "suburbId": "int32"
    },
    "previousSurname": "string",
    "residentialAddress": {
        "addressLine2": "string",
        "country": "string",
        "countryId": "string",
        "isManualAddress": "boolean",
        "isOutOfRegion": "boolean",
        "postcode": "string",
        "state": "string",
        "streetAddress": "string",
        "suburb": "string",
        "suburbId": "int32"
    },
    "surname": "string",
    "titleId": "int32",
    "workPhone": "string"
}

Properties

Name Type Description
dateOfBirth date-time Nullable
email string String
firstName string String
gender string String
homePhone string String
id int32 Int32
isPostalAddressSameAsResidential boolean Nullable
middleName string String
mobilePhone string String
otherName string String
postalAddress object AuAddressModel
postalAddress.addressLine2 string String
postalAddress.country string String
postalAddress.countryId string String
postalAddress.isManualAddress boolean Nullable
postalAddress.isOutOfRegion boolean Nullable
postalAddress.postcode string String
postalAddress.state string String
postalAddress.streetAddress string String
postalAddress.suburb string String
postalAddress.suburbId int32 Nullable
previousSurname string String
residentialAddress object AuAddressModel
residentialAddress.addressLine2 string String
residentialAddress.country string String
residentialAddress.countryId string String
residentialAddress.isManualAddress boolean Nullable
residentialAddress.isOutOfRegion boolean Nullable
residentialAddress.postcode string String
residentialAddress.state string String
residentialAddress.streetAddress string String
residentialAddress.suburb string String
residentialAddress.suburbId int32 Nullable
surname string String
titleId int32 Nullable
workPhone string String

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK

OK

AuEssEmployeeDetailsViewModel