NameDescriptionTypeAdditional information
ChangeEmployee
 DetailId

integer

None.

Change
 EmployeeId

The ChangeEmployeeId. Do not supply

integer

None.

ChangeType

The ChangeType.

string

Required

Matching: ([^'"])*

Max length: 20

ChangeStatus

The ChangeStatus. Do not supply.

string

Matching: ([^'"])*

Max length: 20

TFN

The employee's TFN.

string

Matching: ([^'"])*

Max length: 9

ABN

The employee's ABN.

string

Matching: ([^'"])*

Max length: 11

BasisOfPayment

The BasisOfPayment for the employee.
IsAustralianResident Valid values are:
FullTime,
PartTime,
Casual,
Services,
PensionAnnuity

string

Matching: ([^'"])*

Max length: 20

IsAustralian
 Resident

Is an Australian Resident

boolean

None.

IsWorkingHoliday
 Maker

Is a working holiday maker

boolean

None.

VisaCountry

Country to issue a visa for the working holiday maker

string

Max length: 100

MedicareClaims
 Reduction

Medicare Claims Reduction

boolean

None.

MedicareNumberOf
 Children

Number of children for Medicare purposes

integer

None.

HECS

Whether employee has HECS/HELP

boolean

None.

SFSS

Whether employee has SFSS

boolean

None.

GenerateAutopay

Generate Auto Pay for this employee. Values must be Yes, No, Suspend

string

Matching: ([^'"])*

Max length: 14

EmploymentType

The Employment Type for the employee. Employment Type codes may be found at api/Lookups?type=EmploymentType

string

Matching: ([^'"])*

Max length: 30

MinimumPay

The Minimum Pay limit for the employee.

decimal number

None.

MaximumPay

The Maximum Pay limit for the employee.

decimal number

None.

ServiceHoursTo
 Date

The Service Hours to Date.

decimal number

None.

NormalHours

The Normal Hours paid for the employee

decimal number

None.

PayClass

The PayClass for the employee.

string

Matching: ([^'"])*

RateIncrease
 Code

The Rate Increase Code for the employee. As determined by the list of valid Rate Increase codes.

string

Matching: ([^'"])*

Max length: 30

YearlySalary

The Yearly Salary for the employee.

decimal number

None.

AutopayAmount

The Auto Pay Amount for the employee.

decimal number

None.

NormalRate

The Normal Rate for the employee.

decimal number

None.

TimeAndHalfRate

The Time And a Half Rate for the employee.

decimal number

None.

DoubleTimeRate

The Double Time Rate for the employee.

decimal number

None.

OtherRate

The Other Rate for the employee.

decimal number

None.

AwardRate

The Award Rate for the employee.

decimal number

None.

DefaultCost
 Account

The Default Cost Account for the employee. Cost Account codes may be found at api/Lookups?type=CostAccount

string

Matching: ([^'"])*

Max length: 50

WorkPlannerCode

The Work Planner Code for the employee. Work Planner codes may be found at api/Lookups?type=WorkPattern

string

Matching: ([^'"])*

Max length: 10

TerminationDate

The Termination Date for the employee, must be after Hire Date

date

None.

Termination
 Reason

The Termination Reason for the employee. Termination Reason codes may be found at api/Lookups?type=TerminationReason

string

Matching: ([^"])*

Max length: 50

NZStudentLoan

If employee has NZ Standard Student Loan

boolean

None.

NZSpecifySLRate

If employee has NZ Specified Student Loan

boolean

None.

NZStudentLoanTax
 Rate

The NZ Student Loan Tax Rate for the employee. 0-100

decimal number

None.

NZExclude
 FromEMS

Whether to Exclude From NZ EMS.

boolean

None.

NZWithholdingTax

Whether this employee has NZ Withholding Tax

boolean

None.

IRDEmployeeName

The IRD Employee Name for the employee.

string

Matching: ([^'"])*

Max length: 20

TFNDateSigned

The TFN Date Signed for the employee.

date

None.

TFNForSuper

Whether the TFN For Super for the employee. Values are Yes, No

string

Matching: ([^'"])*

Max length: 20

TaxScaleCode

A valid Tax Scale Code, default to ‘02’.

string

Matching: ([^'"])*

SpecifyTaxRate

The Specify Tax Rate for the employee. Numeric, 0-4 decimal places and must be less than 100.00.

decimal number

None.

FamilyTax
 Benefit

Whether Family Tax Benefit for the employee.

boolean

None.

OtherRebates

Wehterh Other Rebates for the employee.

boolean

None.

TotalRebates

The Total Rebates for the employee.

decimal number

None.

DailyTaxing

Whether Daily Taxing for the employee.

boolean

None.

VariationDate

The Variation Date for the employee.

date

None.

ReportableFringe
 Benefit

The Reportable Fringe Benefits for the employee.

decimal number

None.

OtherIncome

The Other Income for the employee.

decimal number

None.

NonCashBenefit

The Non Cash Benefit for the employee.

decimal number

None.

PaymentType

The Payment Type for the employee. Valid values LabourHire, OtherSpecifiedPayment, VoluntaryAgreement, PersonalServicesIncome, ForeignEmployementIncome, JointPetroleumDevArea

string

Matching: ([^'"])*

Max length: 30

EarningsType

The Earnings Type for the employee. Valid values Taxable, Exempt, SpecifyRate

string

Matching: ([^'"])*

Max length: 20

ContractHours
 Code

The Contract Hours Code for the employee. Contract Hours codes may be found at api/Lookups?type=ContractHours

string

Matching: ([^'"])*

Max length: 10

AutopayType

The Autopay Type for the employee. Values can be NormalHoursPaid, WorkPlannerHours

string

Matching: ([^'"])*

Max length: 22

WorkPatternCode

The Work Pattern Code for the employee. Work Planner codes may be found at api/Lookups?type=WorkPattern

string

Matching: ([^'"])*

Max length: 10

WorkPatternCycle
 StartDay

The Work Pattern Cycle Start Day for the employee. 1 to maximum number of days in Work Pattern. Default = 1

integer

None.

WorkPattern
 EffectiveFrom

The Work Pattern Effective From for the employee.

date

None.

AwardCode

The Award Code for the employee. Award codes may be found at api/Lookups?type=Awards

string

Matching: ([^'"])*

Max length: 12

AwardClassification
 Code

The Award Classification Code for the employee.

string

Matching: ([^'"])*

Max length: 10

AwardCategory
 Code

The Award Category Code for the employee. Award Category codes may be found at api/Lookups?type=AwardCategory

string

Matching: ([^'"])*

Max length: 10

AwardCondition
 Group

The Award Condition Group for the employee. Award Condition Group codes may be found at api/Lookups?type=AwardConditionGroup

string

Matching: ([^'"])*

Max length: 30

AwardUseThis
 Rate

The Award Use This Rate for the employee.

decimal number

None.

AwardNormal
 Hours

The Award Normal Hours for the employee.

decimal number

None.

AwardYearly
 Salary

The Award Yearly Salary for the employee.

decimal number

None.

PersonalEmail

string

None.

BasisOf
 Employment

string

None.

TFNPensioner

boolean

None.

TFNTaxFree

boolean

None.

TFNTaxOffset

boolean

None.

TFNPrevious
 Surname

string

None.

ReportingTo

string

None.

TFNEmployee
 Declaration

boolean

None.

ABNPayee
 Declaration

boolean

None.

ATOConsent

boolean

None.

IsAnnualised
 Salary

boolean

None.

Annualised
 AnniversaryDate

date

None.