NameDescriptionTypeAdditional information
Change
 EmployeeId

The unique id assigned to this ChangeEmployee request once it is validated and saved.

ReadOnly

integer

None.

ChangeType

Indicates the type of request being made: Use:
Add to request creation of a new ChangeEmployee record,
Change to request updating an existing ChangeEmployee record,
Delete to request the deletion of an ChangeEmployee record.

Required

string

Required

Matching: ([^'"])*

Max length: 20

ChangeStatus

Indicates the status of the current request.

Leave blank when submitting a new request.

ReadOnly

string

Matching: ([^'"])*

Max length: 20

ReceivedDate

Set when a validated request is saved.

ReadOnly

date

None.

ReceivedDate
 Time

Set when a validated request is saved.

ReadOnly

date

None.

PickedUpDate
 Time

Set when a validated request is picked up by the DTS and inserted in to the Payroll Database staged table.

ReadOnly

date

None.

PickedUpDate

Set when a validated request is picked up by the DTS and inserted in to the Payroll Database staged table.

ReadOnly

date

None.

RejectedDate
 Time

Set when a validated request is accepted and implemented by payroll.

ReadOnly

date

None.

RejectedDate

Set when a validated request is Rejected by payroll.

ReadOnly

date

None.

ImplementedDate
 Time

Set when a validated request is Rejected by payroll.

ReadOnly

date

None.

ImplementedDate

Set when a validated request is accepted and implemented by payroll.

ReadOnly

date

None.

EffectiveDate

Use to give an indication to payroll when this change should be applied. It is a suggestion only.

date

None.

Validation
 Result

Set automatically to: 0 when a request is submitted; 1 when a request is validated.

ReadOnly

integer

None.

ErrorMessage

May contain errors identified when the request is processed by payroll.

ReadOnly

string

Matching: ([^'"])*

Max length: 500

EmpCode

The unique code identifing the actual ChangeEmployee record in question. This code is required input on ALL requests.

Meridian:

Maximum length allowed is 8 characters.

WageEasy:

Maximim length allowed is 20 characters.

Required

string

Required

Matching: ([^'"])*

Surname

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

Meridian:

Maximum length allowed is 40 characters.

WageEasy:

Maximum length allowed is 50 characters.

Required

string

Matching: ([^"])*

Location

The employee's location for payroll purposes.

Meridian:

Required when the ChangeType is Add, optional for all other ChangeTypes.

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

WageEasy:

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

string

Matching: ([^"])*

PayrollCompany

The employee's payroll company.

Meridian:

Required when the ChangeType is Add, optional for all other ChangeTypes.

Allowed values: Must be one of the valid Payroll Company codes in the target payroll database.

Maximum length allowed is 10 characters.

WageEasy:

PayrollCompany codes may be found using api/Lookups?type=PayrollCompany

string

Matching: ([^'"])*

Max length: 10

PayFrequency

The pay frequency or cycle the Employee will be paid on.

Meridian:

Required when the ChangeType is Add, optional for all other ChangeTypes.

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

Maximum length allowed is 10 characters.

WageEasy:

PayFrequency codes may be found using api/Lookups?type=PayFrequency

string

Matching: ([^'"])*

PayPoint

The pay point where the Employee will be paid.

Meridian:

Required when the ChangeType is Add, optional for all other ChangeTypes.

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

Maximum length allowed is 10 characters.

WageEasy:

PayPoint codes may be found using api/Lookups?type=PayPoint

string

Matching: ([^'"])*

Max length: 30

Title

The employee's salutation or title (e.g. Mr, Mrs, Sir, Doctor or Air Vice Marshall, etc).

Meridian:

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

Maximum length allowed is 50 characters.

WageEasy:

Maximum length allowed is 15 characters. Title codes may be found using api/Lookups?type=Title

string

Matching: ([^'"])*

Gender

The employee's sex (gender).

Typically allowed values: Male, Female or Other but refer to the Gender Lookup for a full list

Gender codes may be found at using api/Lookups?type=Gender

string

Matching: ([^'"])*

Max length: 20

FirstName

The employee's first name (given name/Christian name).

Meridian:

Maximum length allowed is 20 characters.

WageEasy:

Maximum length allowed is 30 characters.

string

Matching: ([^"])*

Max length: 30

MiddleName

The employee's middle name.

Meridian:

Maximum length allowed is 15 characters.

string

Matching: ([^"])*

PreferredName

The employee's preferred name.

Meridian:

Maximum length allowed is 15 characters.

string

Matching: ([^"])*

MaritalStatus

The employee's marital status.

Typically allowed values: Divorced, Married, Not Applicable, Single, Widowed but refer to teh MaritalStatus lookup

MaritalStatus codes may be found using api/Lookups?type=MaritalStatus

string

Matching: ([^'"])*

Street

The street address where the Employee lives.

Meridian:

Maximum length allowed is 40 characters.

WageEasy:

Maximum length allowed is 225 characters.

string

Matching: ([^"])*

SuburbCity

The suburb where the Employee lives.

Meridian:
Maximum length allowed is 40 characters.

WageEasy:
Maximum length allowed is 40 characters.

string

Matching: ([^"])*

Max length: 40

State

The state in which the Employee lives.

Meridian:
Maximum length allowed is 10 characters. Allowed values: ACT, NSW, NT, WA, QLD, SA, VIC, TAS, OTH by default

WageEasy:
Maximum length allowed is 6 characters.

State codes may be found using api/Lookups?type=State

string

Matching: ([^'"])*

Postcode

The postcode where the Employee lives.

string

Matching: ([^'"])*

Max length: 10

Country

The country in which the Employee lives.

Meridian:

Maximum length allowed is 30 characters.

WageEasy:

Maximum length allowed is 40 characters. Country codes may be found using api/Lookups?type=Country

string

Matching: ([^'"])*

Max length: 100

PostalStreet

The street address for the employee's postal address.

Meridian:

Maximum length allowed is 40 characters.

WageEasy:

Maximum length allowed is 225 characters.

string

Matching: ([^"])*

PostalSuburb
 City

The suburb for the employee's postal address.

Meridian:

Maximum length allowed is 30 characters.

WageEasy:

Maximum length allowed is

string

Matching: ([^"])*

Max length: 40

PostalState

The state for the employee's postal address.

Meridian:

Maximum length allowed is 6 characters.

WageEasy:

Maximum length allowed is 10 characters. State codes may be found using api/Lookups?type=State

string

Matching: ([^'"])*

PostalPostcode

The post code for the employee's postal address.

string

Matching: ([^'"])*

Max length: 10

PostalCountry

The country for the employee's postal address.

Meridian:

Maximum length allowed is 30 characters.

WageEasy:

Maximum length allowed is 40 characters.

string

Matching: ([^'"])*

Max length: 100

Telephone1

The employee's primary or default telephone number.

string

Matching: ([^'"])*

Max length: 20

Telephone2

The employee's alternative (mobile) telephone number.

string

Matching: ([^'"])*

Max length: 20

PaymentMethod

The method used to actually pay the ChangeEmployee.

Allowed values:Envelope, DirectDeposit, TransferEFT, AdviceOnly

string

Matching: ([^'"])*

Max length: 20

HiredDate

The date the Employee commence work.

date

None.

DefaultEmail

The employee's preferred email address.

Meridian:

Maximum length allowed is 100 characters.

WageEasy:

Maximum length allowed is 85 characters.

string

Matching: ([^"])*

Max length: 100

DefaultEmailUsed
 ForPayslips

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

Meridian:

Allowed values:True or False

WageEasy:

boolean

None.

DateOfBirth

The employee's date of birth.

date

None.

AboriginalTorres
 Strait

Indicates the employee's Aborginal or Torres Strait Islander status.

Allowed values:Unknown, Aboriginal, Islander, Declined, Both, Neither

string

Matching: ([^'"])*

Max length: 10

Job
 Classification

The employee's job classification.

Meridian:

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

JobClassification codes may be found using api/Lookups?type=JobClassification

string

Matching: ([^'"])*

WorkersCompCode

The employee's job classification.

Meridian:

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

WageEasy:

WorkersCompCode codes may be found using api/Lookups?type=WorkersComp

string

Matching: ([^'"])*

Max length: 10

UserDefined
 Fields

UserDefinedFields

A semi colon separated list of fieldname=value pairs

Each field name must start with u{c|f|i|d|b|l}EE followed by a fieldname

string

None.

ChangeEmployee
 AddDedView

Collection of ChangeEmployee
 AddDedView

None.

ChangeEmployee
 AddRateView

Collection of ChangeEmployee
 AddRateView

None.

ChangeEmployee
 BankView

Collection of ChangeEmployee
 BankView

None.

ChangeEmployee
 DetailView

Collection of ChangeEmployee
 DetailView

None.

ChangeEmployee
 LeaveView

Collection of ChangeEmployee
 LeaveView

None.

ChangeEmployee
 SuperContView

Collection of ChangeEmployee
 SuperContView

None.

ChangeEmployee
 EmailView

The Employee Email View is a placeholder for a future release. This property is currently not supported, and the "DefaultEmail" property should be used instead.

Collection of ChangeEmployee
 EmailView

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.

OnBoarding

boolean

None.

ReferenceNumber

Either not include any value for the ReferenceNumber field or to ensure the ReferenceNumber field is unique for each POST request when value is provided to this field.

string

None.

Comment

string

None.

IsEss

boolean

None.