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

Request

POST http://keypay.yourpayroll.local/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",
            "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 Description
anniversaryDate date-time Nullable
bankAccounts[] array
bankAccounts[].accountName string String
bankAccounts[].accountNumber string String
bankAccounts[].accountType string BankAccountTypeEnum

Possible values are:

  • Electronic
  • ManualDeposit
  • CashOrCheque
  • Bpay
bankAccounts[].allocateBalance boolean Boolean
bankAccounts[].allocatedPercentage double Nullable
bankAccounts[].bsb string String
bankAccounts[].canBeDeleted boolean Boolean
bankAccounts[].externalReferenceId string String
bankAccounts[].fixedAmount double Nullable
bankAccounts[].id int32 Int32
bankAccounts[].isEmployeeEditable boolean Boolean
bankAccounts[].source string ExternalService

Possible values are:

  • None
  • Saasu
  • Xero
  • MYOB
  • Deputy
  • EmployeeTimePunch
  • ClickSuper
  • IntegratedTimesheets
  • FileImport
  • FileExport
  • QuickBooks
  • Harmony
  • AwardStore
  • Attache
  • IntegratedRostering
  • ReckonAccounts
  • API
  • MicroPower
  • RosterLive
  • NetSuite
  • Kounta
  • TimeAndAttendanceKiosk
  • DetailedFileExport
  • JonasPremier
  • WageEasy
  • Maestrano
  • WorkZone
  • EmployeePortal
  • RosterTemplate
  • Onboarding
  • Admin
  • WorkZoneClockOnOff
  • NetSuiteOneWorld
  • Sage50
  • PensionSync
businessId int32 Int32
dateOfBirth date-time Nullable
email string String
endDate date-time Nullable
externalId string String
externalReferenceId string String
firstName string String
gender string String
homePhone string String
isPostalAddressSameAsResidential boolean Boolean
middleName string String
mobilePhone string String
otherName string String
postalAddressLine2 string String
postalCountry string String
postalPostcode string String
postalState string String
postalStreetAddress string String
postalSuburb string String
postalSuburbId int32 Nullable
residentialAddressLine2 string String
residentialCountry string String
residentialPostcode string String
residentialState string String
residentialStreetAddress string String
residentialSuburb string String
residentialSuburbId int32 Nullable
source string ExternalService

Possible values are:

  • None
  • Saasu
  • Xero
  • MYOB
  • Deputy
  • EmployeeTimePunch
  • ClickSuper
  • IntegratedTimesheets
  • FileImport
  • FileExport
  • QuickBooks
  • Harmony
  • AwardStore
  • Attache
  • IntegratedRostering
  • ReckonAccounts
  • API
  • MicroPower
  • RosterLive
  • NetSuite
  • Kounta
  • TimeAndAttendanceKiosk
  • DetailedFileExport
  • JonasPremier
  • WageEasy
  • Maestrano
  • WorkZone
  • EmployeePortal
  • RosterTemplate
  • Onboarding
  • Admin
  • WorkZoneClockOnOff
  • NetSuiteOneWorld
  • Sage50
  • PensionSync
startDate date-time DateTime
surname string String
tagsString string String
taxFileNumber string String
taxFileNumberMasked string String
timesheetSetting string EmployeeTimesheetSetting

Possible values are:

  • Disabled
  • Enabled
  • EnabledForExceptions
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