Required fields when adding an employee via the API


#1

One questions we get asked a lot is what fields are required for an employee record being added via the API. It’s important to note that when adding an employee, there’s 2 states the employee can be in:

  • Incomplete - this means the employee has been added successfully, but is not complete. You need to provide additional information for this employee before you can process them in a pay run
  • Complete - this means the minimum amount of information has been supplied for an employee to be processed in a pay run.

For an employee to be added to KeyPay via the API the following fields need to be supplied:

TaxFileNumber
FirstName
Surname
DateOfBirth
StartDate
ResidentialStreetAddress
ResidentialSuburb
EmploymentType

With these fields completed, I can send an employee object to the API and it will create the employee record, but it will be incomplete

In addition to the above fields, for an employee to be included in a pay run I need to also include the following information:

PaySchedule
PrimaryPayCategory
PrimaryLocation
PaySlipNotificationType
Rate
RateUnit
HoursPerWeek
BankAccount1_BSB
BankAccount1_AccountName
BankAccount1_AccountNumber
BankAccount1_AllocatedPercentage
SuperFund1_FundName
superFund1_MemberNumber
superFund1_AllocatedPercentage

Once all these fields have been supplied, you can then process an employee within a pay run.