Saves any employee details that the employee is allowed to set.

Request

POST https://api.yourpayroll.com.au/api/v2/ess/{employeeId}/details

Path parameters

Parameter name Value Description Additional
employeeId string Required

Request body

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

{
    "anniversaryDate": "date-time",
    "bankAccounts": [
        {
            "accountName": "string",
            "accountNumber": "string",
            "accountType": "string",
            "allocateBalance": "boolean",
            "allocatedPercentage": "double",
            "bsb": "string",
            "canBeDeleted": "boolean",
            "deleted": "boolean",
            "externalReferenceId": "string",
            "fixedAmount": "double",
            "id": "int32",
            "isEmployeeEditable": "boolean",
            "source": "string"
        }
    ],
    "businessId": "int32",
    "dateOfBirth": "date-time",
    "email": "string",
    "endDate": "date-time",
    "externalId": "string",
    "externalReferenceId": "string",
    "firstName": "string",
    "gender": "string",
    "homePhone": "string",
    "isPostalAddressSameAsResidential": "boolean",
    "middleName": "string",
    "mobilePhone": "string",
    "otherName": "string",
    "postalAddressLine2": "string",
    "postalCountry": "string",
    "postalPostcode": "string",
    "postalState": "string",
    "postalStreetAddress": "string",
    "postalSuburb": "string",
    "postalSuburbId": "int32",
    "residentialAddressLine2": "string",
    "residentialCountry": "string",
    "residentialPostcode": "string",
    "residentialState": "string",
    "residentialStreetAddress": "string",
    "residentialSuburb": "string",
    "residentialSuburbId": "int32",
    "source": "string",
    "startDate": "date-time",
    "surname": "string",
    "tagsString": "string",
    "taxFileNumber": "string",
    "taxFileNumberMasked": "string",
    "timesheetSetting": "string",
    "titleId": "int32",
    "workPhone": "string"
}

Properties

Name Type
anniversaryDate date-time
bankAccounts[] array
bankAccounts[].accountName string
bankAccounts[].accountNumber string
bankAccounts[].accountType string
bankAccounts[].allocateBalance boolean
bankAccounts[].allocatedPercentage double
bankAccounts[].bsb string
bankAccounts[].canBeDeleted boolean
bankAccounts[].deleted boolean
bankAccounts[].externalReferenceId string
bankAccounts[].fixedAmount double
bankAccounts[].id int32
bankAccounts[].isEmployeeEditable boolean
bankAccounts[].source string
businessId int32
dateOfBirth date-time
email string
endDate date-time
externalId string
externalReferenceId string
firstName string
gender string
homePhone string
isPostalAddressSameAsResidential boolean
middleName string
mobilePhone string
otherName string
postalAddressLine2 string
postalCountry string
postalPostcode string
postalState string
postalStreetAddress string
postalSuburb string
postalSuburbId int32
residentialAddressLine2 string
residentialCountry string
residentialPostcode string
residentialState string
residentialStreetAddress string
residentialSuburb string
residentialSuburbId int32
source string
startDate date-time
surname string
tagsString string
taxFileNumber string
taxFileNumberMasked string
timesheetSetting string
titleId int32
workPhone string

Response

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

Status code Description Resource
200 OK

OK