ChangeEmployeeImmediateView
The ChangeEmployee Immediately model
Name | Description | Type | Additional information |
---|---|---|---|
Change  EmployeeId |
The unique id assigned to this ChangeEmployee request once it is validated and saved. |
integer |
None. |
ChangeType |
Indicates the type of request being made: Use: Change to request immediate updating of an existing Employee record, ReadOnly |
string |
Required Matching: Change 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 e |
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 e |
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 e |
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. |
string |
Required Matching: ([^'"])* Max length: 20 |
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. |
string |
Matching: ([^"])* Max length: 50 |
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. |
string |
Matching: ([^'"])* Max length: 50 |
Gender |
The employee's sex (gender). Allowed values: Male, Female or Other Gender codes may be found using api/Lookups?type=Gender |
string |
Matching: ([^'"])* Max length: 6 |
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: ([^"])* Max length: 15 |
PreferredName |
The employee's preferred name Meridian: Maximum length allowed is 15 characters. |
string |
Matching: ([^"])* Max length: 15 |
MaritalStatus |
The employee's marital status. MaritalStatus codes may be found using api/Lookups?type=MaritalStatus |
string |
Matching: ([^'"])* Max length: 30 |
Street |
The street address where the ChangeEmployee lives. Meridian: Maximum length allowed is 40 characters.WageEasy: Maximum length allowed is 225 characters. |
string |
Matching: ([^"])* Max length: 225 |
SuburbCity |
The suburb where the ChangeEmployee 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 ChangeEmployee 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: ([^'"])* Max length: 10 |
Postcode |
The postcode where the ChangeEmployee lives. |
string |
Matching: ([^'"])* Max length: 4 |
Country |
The country in which the ChangeEmployee 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: 40 |
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: ([^"])* Max length: 225 |
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: ([^'"])* Max length: 10 |
PostalPostcode |
The post code for the employee's postal address. |
string |
Matching: ([^'"])* Max length: 4 |
PostalCountry |
The country for the employee's postal address. 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: 30 |
Telephone1 |
The employee's primary or default telephone number. |
string |
Matching: ([^'"])* Max length: 20 |
Telephone2 |
The employee's alternative telephone number. |
string |
Matching: ([^'"])* Max length: 20 |
HiredDate |
The date the ChangeEmployee 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. |
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. WageEasy: JobClassification codes may be found using api/Lookups?type=JobClassification |
string |
Matching: ([^'"])* Max length: 60 |
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 |
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. |
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. |