NameDescriptionTypeAdditional information
idEmployee
 Detail

The payroll unique DB id

integer

None.

EmpCode

The employee's EmpCode.

string

None.

Surname

The Surname for the employee.

string

None.

FirstName

The Firstname for the employee.

string

None.

MiddleName

The middle name for the employee.

string

None.

PreferredName

The preferred name for the employee.

string

None.

TFN

The employee's TFN.

string

None.

ABN

The employee's ABN.

string

None.

BasisOfPayment

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

string

None.

IsAustralian
 Resident

Is an Australian Resident

boolean

None.

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

None.

EmploymentType

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

string

None.

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

None.

RateIncrease
 Code

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

string

None.

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

None.

WorkPlannerCode

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

string

None.

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

None.

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

None.

TFNDateSigned

The TFN Date Signed for the employee.

date

None.

TFNForSuper

Whether the TFN For Super for the employee.

string

None.

TaxScaleCode

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

string

None.

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.

NonCashBenfit

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

None.

EarningsType

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

string

None.

ContractHours
 Code

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

string

None.

AutopayType

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

string

None.

DefaultEmail

The employee's preferred email address.

Meridian:

Maximum length allowed is 100 characters.

string

None.

EmailUsedFor
 Payslips

Is this employee's email to be used as the address for emailing pay advices

boolean

None.

EmailUsedFor
 PaymentSummaries

Is this employee's email to be used as the address for emailing payment summaries

boolean

None.

EmailType

Is this employee's email to be used is work email or personal email Return value either is "Work" or "Personal"

string

None.

NZTaxRate

decimal number

None.

NZStudent
 LoanCIR

NZ student loan CIR

boolean

None.

NZStudentLoanCI
 RTaxRate

NZ student loan CIR rate

decimal number

None.

NZStudent
 LoanBOR

NZ student loan BOR

boolean

None.

NZStudentLoanBO
 RTaxRate

NZ NZ student loan BOR rate

decimal number

None.

NZStudentLoanBO
 RType

NZ student loan BOR type

string

None.

TfnTaxFree

Tax free threshold

boolean

None.

IsWorkingHoliday
 Maker

Is a working holiday maker

boolean

None.

VisaCountry

Country to issue a visa for the working holiday maker

string

None.

IsAnnualised
 Salary

IsAnnualisedSalary

boolean

None.

Annualised
 AnniversaryDate

AnnualisedAnniversaryDate

date

None.

WorkPatternCode

string

None.

DaysInCycle

integer

None.

EffectiveFrom

date

None.