NameDescriptionTypeAdditional information
Change
 EmployeeId

integer

None.

ChangeType

string

Required

Matching: ([^'"])*

Max length: 20

ChangeStatus

string

Matching: ([^'"])*

Max length: 20

ReceivedDate

date

None.

ReceivedDate
 Time

date

None.

PickedUpDate
 Time

date

None.

PickedUpDate

date

None.

RejectedDate
 Time

date

None.

RejectedDate

date

None.

ImplementedDate
 Time

date

None.

ImplementedDate

date

None.

EffectiveDate

date

None.

Validation
 Result

integer

None.

ErrorMessage

string

Matching: ([^'"])*

Max length: 500

Gender

The Gender of the employee

Allowed values:Male, Female, Intersex, Other

string

None.

MaritalStatus

The Marital Status of the employee

Allowed values:Defacto, Divorced, Married, Single, Widowed

string

None.

Employment
 Category

The Employment Category of the employee

Allowed values: FullTime, PartTime, Casual

string

None.

EmployeeNo

The unique code identifing the actual employee in question. This code is required input on ALL requests. Maximim length allowed is 20 characters.

string

Required

Matching: ([^'"])*

Max length: 20

LastName

The employee's surname (last name/family name). Required when the ChangeType is Add, optional for all other ChangeTypes. Maximum length allowed is 50 characters.

string

Max length: 50

FirstName

The employee's first name (given name/Christian name). Maximum length allowed is 30 characters.

string

Max length: 30

SecondName

The employee's middle name Maximum length allowed is 30 characters.

string

Max length: 30

Title

The employee's salutation or title (e.g. Mr, Mrs, Sir, Doctor or Air Vice Marshall, etc). Maximum length allowed is 15 characters.

string

Max length: 15

JobTitle

The employee's Job Title Maximum length allowed is 50 characters.

string

Max length: 50

HomeAddress

The employee's Home Address Maximum length allowed is 255 characters.

string

Max length: 255

HomeCity

The employee's Home City or Suburb Maximum length allowed is 40 characters.

string

Max length: 40

HomeState

The employee's Home State Maximum length allowed is 10 characters.

string

Max length: 10

HomePostcode

The employee's Home Postcode Maximum length allowed is 10 characters.

string

Max length: 10

HomeCountry

The employee's Home Country Maximum length allowed is 50 characters.

string

Max length: 50

PostalAddress

The employee's Postal Address Maximum length allowed is 255 characters.

string

Max length: 255

PostalCity

The employee's Postal City or Suburb Maximum length allowed is 40 characters.

string

Max length: 40

PostalState

The employee's Postal State Maximum length allowed is 10 characters.

string

Max length: 10

PostalPostcode

The employee's Postal Postcode Maximum length allowed is 10 characters.

string

Max length: 10

PostalCountry

The employee's Postal Country Maximum length allowed is 50 characters.

string

Max length: 50

Birthday

The employee's Birth date

date

None.

Location

The employee's location for payroll purposes.


Allowed values: Must be one of the valid Location in the target payroll database.


Location may be found using api/Lookups?type=Location

string

None.

PayPeriod

The employee's PayPeriod for payroll purposes.


Allowed values: Must be one of the valid PayPeriod in the target payroll database.


PayPeriod may be found using api/Lookups?type=PayPeriod

string

None.

EmploymentDate

date

None.

AwardDate

date

None.

TerminateDate

date

None.

TerminateReason

string

None.

AwardKey

The employee's AwardKey for award conditions.


Allowed values: Must be one of the valid AwardKey id in the target payroll database.


AwardKey id may be found using api/Lookups?type=Award

string

None.

Salaried

boolean

None.

TaxKey

The employee's TaxKey for the employee's nominated tax scale.


Allowed values: Must be one of the valid TaxKey id in the target payroll database.


TaxKey id may be found using api/Lookups?type=Tax

string

None.

SecondaryTaxKey

The employee's SecondaryTaxKey for the employee's secondary tax scale.


Allowed values: Must be one of the valid TaxKey id in the target payroll database.


TaxKey id may be found using api/Lookups?type=Tax

string

None.

TertiaryTaxKey

The employee's TertiaryTaxKey for the employee's 3rd tax scale.


Allowed values: Must be one of the valid TaxKey id in the target payroll database.


TaxKey id may be found using api/Lookups?type=Tax

string

None.

ForthTaxKey

The employee's ForthTaxKey for the employee's 4th tax scale.


Allowed values: Must be one of the valid TaxKey id in the target payroll database.


TaxKey id may be found using api/Lookups?type=Tax

string

None.

FifthTaxKey

The employee's FifthTaxKey for the employee's 4th tax scale.


Allowed values: Must be one of the valid TaxKey id in the target payroll database.


TaxKey id may be found using api/Lookups?type=Tax

string

None.

TaxAdjustment

Amount to manually adjust the tax by each pay

decimal number

None.

TaxFileNo

Employee's tax file number

string

None.

CanProvideTFNTo
 SuperFund

Whether the employee can TFN can be sent to super funds

boolean

None.

NonAustralian
 Resident

Whether the employee is a non Australian resident

boolean

None.

TimeCardNo

Timecard number for external systems to identify this employee

eg. If your software has a unique identifier it uses for this employee, timesheets can be exported with this identifier if it is stored in TimeCardNo

string

None.

GLCode

GL Code for this employee

string

None.

SecurityPassNo

Security pass number for this employee

string

None.

UserPassword

User password for this employee

string

None.

Photo

Photo of this employee

Collection of Byte[]

None.

Notes

Notes for this employee

string

None.

NormalDayHours

Normal day working hours for this employee. Set NormalDayHoursUseAward to false if you wish to override the normal day hours from the award

decimal number

None.

NormalDayHours
 UseAward

Normal day working hours override flag for this employee. Set NormalDayHoursUseAward to false if you wish to override the normal day hours from the award, true if they will use award normal day hours

boolean

None.

StandardPay
 Hours

Employees standard pay hours for their pay period, if they are using Standard Pays

decimal number

None.

IsStandardPays

Whether this employee uses standard pays

boolean

None.

DefaultEmail

Default email address for this employee

string

None.

DefaultEmailUsed
 ForPayslips

Whether the default email will be used to email payslips

boolean

None.

Telephone1

Default telephone for this employee

string

None.

Telephone1
 Description

Default telephone description for this employee

string

None.

Telephone2

Second telephone number for this employee

string

None.

Telephone2
 Description

Second telephone description for this employee

string

None.

DefaultPay
 RateKey

The employee's DefaultPayRateKey for payroll purpose


Allowed values: Must be one of the valid PayRateKey id in the target payroll database.


PayRateKey id may be found using api/Lookups?type=PayRate

string

None.

Default
 Department

The employee's DefaultDepartment.


Allowed values: Must be one of the valid default department in the target payroll database.


DefaultDepartment may be found using api/Lookups?type=Department

string

None.

Immediate
 Immediately

boolean

None.

PostedDate

date

None.

PostedDateTime

date

None.

UserId

integer

None.

UserName

string

None.

UserType

string

None.

PayrollDatabase

globally unique identifier

None.

DatabaseType

string

None.

SuppressedDate

date

None.

SuppressedDate
 Time

date

None.

ActionedDate

date

None.

ActionedDate
 Time

date

None.

PayrollLink
 Token

globally unique identifier

None.

WeChangeEmployee
 BankView

Collection of WeChangeEmployee
 BankView

None.

WeChangeEmployee
 AllowanceView

Collection of WeChangeEmployee
 AllowanceView

None.

WeChangeEmployee
 SuperView

Collection of WeChangeEmployee
 SuperView

None.