Updates the personal details for the specified employee

Request

PUT https://apisg.yourpayroll.io/api/v2/ess/{employeeId}/personaldetails

Path parameters

Parameter name Value Description Additional
employeeId string Required

Request body

The request body takes a complete SgEssEmployeeDetailsEditModel 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",
        "addressLine3": "string",
        "addressType": "string",
        "blockNumber": "string",
        "country": "string",
        "countryId": "string",
        "isManualAddress": "boolean",
        "isOutOfRegion": "boolean",
        "levelNumber": "string",
        "postcode": "string",
        "state": "string",
        "streetAddress": "string",
        "streetName": "string",
        "suburb": "string",
        "suburbId": "int32",
        "unitNumber": "string"
    },
    "previousSurname": "string",
    "residentialAddress": {
        "addressLine2": "string",
        "addressLine3": "string",
        "addressType": "string",
        "blockNumber": "string",
        "country": "string",
        "countryId": "string",
        "isManualAddress": "boolean",
        "isOutOfRegion": "boolean",
        "levelNumber": "string",
        "postcode": "string",
        "state": "string",
        "streetAddress": "string",
        "streetName": "string",
        "suburb": "string",
        "suburbId": "int32",
        "unitNumber": "string"
    },
    "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 SgAddressModel
postalAddress.addressLine2 string String
postalAddress.addressLine3 string String
postalAddress.addressType string AddressTypeEnum

Possible values are:

  • LocalAddress
  • ForeignAddress
  • LocalCareOfAddress
postalAddress.blockNumber string String
postalAddress.country string String
postalAddress.countryId string String
postalAddress.isManualAddress boolean Nullable
postalAddress.isOutOfRegion boolean Nullable
postalAddress.levelNumber string String
postalAddress.postcode string String
postalAddress.state string String
postalAddress.streetAddress string String
postalAddress.streetName string String
postalAddress.suburb string String
postalAddress.suburbId int32 Nullable
postalAddress.unitNumber string String
previousSurname string String
residentialAddress object SgAddressModel
residentialAddress.addressLine2 string String
residentialAddress.addressLine3 string String
residentialAddress.addressType string AddressTypeEnum

Possible values are:

  • LocalAddress
  • ForeignAddress
  • LocalCareOfAddress
residentialAddress.blockNumber string String
residentialAddress.country string String
residentialAddress.countryId string String
residentialAddress.isManualAddress boolean Nullable
residentialAddress.isOutOfRegion boolean Nullable
residentialAddress.levelNumber string String
residentialAddress.postcode string String
residentialAddress.state string String
residentialAddress.streetAddress string String
residentialAddress.streetName string String
residentialAddress.suburb string String
residentialAddress.suburbId int32 Nullable
residentialAddress.unitNumber string String
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

SgEssEmployeeDetailsViewModel