EmployeeView
| Name | Description | Type | Additional information |
|---|---|---|---|
| idEmployee |
Database ID of the Employee record. This could be tracked for the rare case that Employee Codes change in this payroll DB |
integer |
None. |
| 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 |
None. |
| 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 |
None. |
| 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 |
None. |
| MiddleName |
The employee's middle name. Meridian: Maximum length allowed is 15 characters. |
string |
None. |
| PreferredName |
The employee's preferred name. Meridian: Maximum length allowed is 15 characters. |
string |
None. |
| 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 |
None. |
| 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 |
None. |
| 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 |
None. |
| DateOfBirth |
The employee's date of birth. |
date |
None. |
| HiredDate |
The date the Employee commence work. |
date |
None. |
| AboriginalTorres  Strait |
Indicates the employee's Aborginal or Torres Strait Islander status. Allowed values:Unknown, Aboriginal, Islander, Declined, Both, Neither |
string |
None. |
| Street |
The street address where the Employee lives. Meridian: Maximum length allowed is 40 characters.WageEasy: Maximum length allowed is 225 characters. |
string |
None. |
| SuburbCity |
The suburb where the Employee lives.
Meridian: WageEasy: |
string |
None. |
| State |
The state in which the Employee lives.
Meridian: WageEasy: |
string |
None. |
| Postcode |
The postcode where the Employee lives. |
string |
None. |
| 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 |
None. |
| 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 |
None. |
| PostalSuburb  City |
The suburb for the employee's postal address. Meridian: Maximum length allowed is 30 characters.WageEasy: Maximum length allowed is |
string |
None. |
| 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 |
None. |
| PostalPostcode |
The post code for the employee's postal address. |
string |
None. |
| PostalCountry |
The country for the employee's postal address. Meridian: Maximum length allowed is 30 characters.WageEasy: Maximum length allowed is 40 characters. |
string |
None. |
| Telephone1 |
The employee's primary or default telephone number. |
string |
None. |
| Telephone2 |
The employee's alternative (mobile) telephone number. |
string |
None. |
| DefaultEmail |
The employee's preferred email address. Meridian: Maximum length allowed is 100 characters.WageEasy: Maximum length allowed is 85 characters. |
string |
None. |
| 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 |
None. |
| 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 |
Max length: 20 |
| 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 |
None. |
| 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 |
None. |
| 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 |
None. |
| 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 |
None. |
| 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. |
| EmployeeDetail |
Collection of EmployeeDetail  View |
None. |
|
| EmployeeAddDeds |
Collection of EmployeeAddDed  View |
None. |
|
| EmployeeAdd  Rates |
Collection of EmployeeAddRate  View |
None. |
|
| EmployeeBanks |
Collection of EmployeeBank  View |
None. |
|
| EmployeeEmails |
The Employee Email View is a placeholder for a future release. This property is currently not supported, and "DefaultEmail" should be used instead. |
Collection of EmployeeEmail  View |
None. |
| EmployeeLeaves |
Collection of EmployeeLeave  View |
None. |
|
| EmployeeSuper  Conts |
Collection of EmployeeSuperCont  View |
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. |
| ReferenceNumber | string |
None. |
|
| OnBoarding | boolean |
None. |