GET api/EmployeeDetails/{id}

Gets a single Employee live from a payroll database

Request Information

URI Parameters

(i.e.queryString parameters in the form ?param1={param1}&param2={param2})

NameDescriptionTypeAdditional information
id

The Employee Code used in the payroll database

 string

Required

Body Parameters

None.

Response Information

Resource Description

A single Employee's details if the employee is found

EmployeeView
NameDescriptionTypeAdditional 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:
Maximum length allowed is 40 characters.

WageEasy:
Maximum length allowed is 40 characters.

string

None.
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

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.

Response Formats

application/json, text/json

Sample: 
{
  "idEmployee": 1,
  "empCode": "sample string 2",
  "surname": "sample string 3",
  "firstName": "sample string 4",
  "middleName": "sample string 5",
  "preferredName": "sample string 6",
  "title": "sample string 7",
  "gender": "sample string 8",
  "maritalStatus": "sample string 9",
  "dateOfBirth": "2024-05-19T09:51:32.868435+10:00",
  "hiredDate": "2024-05-19T09:51:32.868435+10:00",
  "aboriginalTorresStrait": "sample string 10",
  "street": "sample string 11",
  "suburbCity": "sample string 12",
  "state": "sample string 13",
  "postcode": "sample string 14",
  "country": "sample string 15",
  "postalStreet": "sample string 16",
  "postalSuburbCity": "sample string 17",
  "postalState": "sample string 18",
  "postalPostcode": "sample string 19",
  "postalCountry": "sample string 20",
  "telephone1": "sample string 21",
  "telephone2": "sample string 22",
  "defaultEmail": "sample string 23",
  "payrollCompany": "sample string 24",
  "payFrequency": "sample string 25",
  "location": "sample string 26",
  "payPoint": "sample string 27",
  "workersCompCode": "sample string 28",
  "jobClassification": "sample string 29",
  "userDefinedFields": "sample string 30",
  "employeeDetail": [
    {
      "idEmployeeDetail": 1,
      "empCode": "sample string 2",
      "surname": "sample string 3",
      "firstName": "sample string 4",
      "middleName": "sample string 5",
      "preferredName": "sample string 6",
      "tfn": "sample string 7",
      "abn": "sample string 8",
      "basisOfPayment": "sample string 9",
      "isAustralianResident": true,
      "medicareClaimsReduction": true,
      "medicareNumberOfChildren": 1,
      "hecs": true,
      "sfss": true,
      "generateAutopay": "sample string 10",
      "employmentType": "sample string 11",
      "minimumPay": 1.1,
      "maximumPay": 1.1,
      "serviceHoursToDate": 1.1,
      "normalHours": 1.1,
      "payClass": "sample string 12",
      "rateIncreaseCode": "sample string 13",
      "yearlySalary": 1.1,
      "autopayAmount": 1.1,
      "normalRate": 1.1,
      "timeAndHalfRate": 1.1,
      "doubleTimeRate": 1.1,
      "otherRate": 1.1,
      "awardRate": 1.1,
      "defaultCostAccount": "sample string 14",
      "workPlannerCode": "sample string 15",
      "terminationDate": "2024-05-19T09:51:32.868435+10:00",
      "terminationReason": "sample string 16",
      "nzStudentLoan": true,
      "nzSpecifySLRate": true,
      "nzStudentLoanTaxRate": 1.1,
      "nzExcludeFromEMS": true,
      "nzWithholdingTax": true,
      "irdEmployeeName": "sample string 17",
      "tfnDateSigned": "2024-05-19T09:51:32.868435+10:00",
      "tfnForSuper": "sample string 18",
      "taxScaleCode": "sample string 19",
      "specifyTaxRate": 1.1,
      "familyTaxBenefit": true,
      "otherRebates": true,
      "totalRebates": 1.1,
      "dailyTaxing": true,
      "variationDate": "2024-05-19T09:51:32.868435+10:00",
      "reportableFringeBenefit": 1.1,
      "otherIncome": 1.1,
      "nonCashBenfit": 1.1,
      "paymentType": "sample string 20",
      "earningsType": "sample string 21",
      "contractHoursCode": "sample string 22",
      "autopayType": "sample string 23",
      "defaultEmail": "sample string 24",
      "emailUsedForPayslips": true,
      "emailUsedForPaymentSummaries": true,
      "emailType": "sample string 25",
      "nzTaxRate": 1.1,
      "nzStudentLoanCIR": true,
      "nzStudentLoanCIRTaxRate": 1.1,
      "nzStudentLoanBOR": true,
      "nzStudentLoanBORTaxRate": 1.1,
      "nzStudentLoanBORType": "sample string 26",
      "tfnTaxFree": true,
      "isWorkingHolidayMaker": true,
      "visaCountry": "sample string 27",
      "isAnnualisedSalary": true,
      "annualisedAnniversaryDate": "2024-05-19T09:51:32.868435+10:00"
    },
    {
      "idEmployeeDetail": 1,
      "empCode": "sample string 2",
      "surname": "sample string 3",
      "firstName": "sample string 4",
      "middleName": "sample string 5",
      "preferredName": "sample string 6",
      "tfn": "sample string 7",
      "abn": "sample string 8",
      "basisOfPayment": "sample string 9",
      "isAustralianResident": true,
      "medicareClaimsReduction": true,
      "medicareNumberOfChildren": 1,
      "hecs": true,
      "sfss": true,
      "generateAutopay": "sample string 10",
      "employmentType": "sample string 11",
      "minimumPay": 1.1,
      "maximumPay": 1.1,
      "serviceHoursToDate": 1.1,
      "normalHours": 1.1,
      "payClass": "sample string 12",
      "rateIncreaseCode": "sample string 13",
      "yearlySalary": 1.1,
      "autopayAmount": 1.1,
      "normalRate": 1.1,
      "timeAndHalfRate": 1.1,
      "doubleTimeRate": 1.1,
      "otherRate": 1.1,
      "awardRate": 1.1,
      "defaultCostAccount": "sample string 14",
      "workPlannerCode": "sample string 15",
      "terminationDate": "2024-05-19T09:51:32.868435+10:00",
      "terminationReason": "sample string 16",
      "nzStudentLoan": true,
      "nzSpecifySLRate": true,
      "nzStudentLoanTaxRate": 1.1,
      "nzExcludeFromEMS": true,
      "nzWithholdingTax": true,
      "irdEmployeeName": "sample string 17",
      "tfnDateSigned": "2024-05-19T09:51:32.868435+10:00",
      "tfnForSuper": "sample string 18",
      "taxScaleCode": "sample string 19",
      "specifyTaxRate": 1.1,
      "familyTaxBenefit": true,
      "otherRebates": true,
      "totalRebates": 1.1,
      "dailyTaxing": true,
      "variationDate": "2024-05-19T09:51:32.868435+10:00",
      "reportableFringeBenefit": 1.1,
      "otherIncome": 1.1,
      "nonCashBenfit": 1.1,
      "paymentType": "sample string 20",
      "earningsType": "sample string 21",
      "contractHoursCode": "sample string 22",
      "autopayType": "sample string 23",
      "defaultEmail": "sample string 24",
      "emailUsedForPayslips": true,
      "emailUsedForPaymentSummaries": true,
      "emailType": "sample string 25",
      "nzTaxRate": 1.1,
      "nzStudentLoanCIR": true,
      "nzStudentLoanCIRTaxRate": 1.1,
      "nzStudentLoanBOR": true,
      "nzStudentLoanBORTaxRate": 1.1,
      "nzStudentLoanBORType": "sample string 26",
      "tfnTaxFree": true,
      "isWorkingHolidayMaker": true,
      "visaCountry": "sample string 27",
      "isAnnualisedSalary": true,
      "annualisedAnniversaryDate": "2024-05-19T09:51:32.868435+10:00"
    }
  ],
  "employeeAddDeds": [
    {
      "idEmployeeAddDed": 1,
      "empCode": "sample string 2",
      "addDedCode": "sample string 3",
      "loadFromRegister": true,
      "value": 1.0,
      "standard": 1.0,
      "costAccount": "sample string 4",
      "memberNumber": "sample string 5"
    },
    {
      "idEmployeeAddDed": 1,
      "empCode": "sample string 2",
      "addDedCode": "sample string 3",
      "loadFromRegister": true,
      "value": 1.0,
      "standard": 1.0,
      "costAccount": "sample string 4",
      "memberNumber": "sample string 5"
    }
  ],
  "employeeAddRates": [
    {
      "idEmployeeAddRate": 1,
      "empCode": "sample string 2",
      "rateCode": "sample string 3",
      "rate": 1.1
    },
    {
      "idEmployeeAddRate": 1,
      "empCode": "sample string 2",
      "rateCode": "sample string 3",
      "rate": 1.1
    }
  ],
  "employeeBanks": [
    {
      "idEmployeeBank": 1,
      "empCode": "sample string 2",
      "bsbCode": "sample string 3",
      "accountNumber": "sample string 4",
      "eftCode": "sample string 5",
      "accountName": "sample string 6",
      "payAmount": 1.0,
      "balanceOfPay": true,
      "order": 1,
      "bankName": "sample string 7",
      "bankBranchName": "sample string 8",
      "bankState": "sample string 9"
    },
    {
      "idEmployeeBank": 1,
      "empCode": "sample string 2",
      "bsbCode": "sample string 3",
      "accountNumber": "sample string 4",
      "eftCode": "sample string 5",
      "accountName": "sample string 6",
      "payAmount": 1.0,
      "balanceOfPay": true,
      "order": 1,
      "bankName": "sample string 7",
      "bankBranchName": "sample string 8",
      "bankState": "sample string 9"
    }
  ],
  "employeeEmails": [
    {
      "idEmployeeEmail": 1,
      "empCode": "sample string 2",
      "emailAddress": "sample string 3",
      "useAsDefault": true,
      "useForPayslips": true,
      "zipPassword": "sample string 4",
      "useForPaymentSummaries": true,
      "emailType": "sample string 5"
    },
    {
      "idEmployeeEmail": 1,
      "empCode": "sample string 2",
      "emailAddress": "sample string 3",
      "useAsDefault": true,
      "useForPayslips": true,
      "zipPassword": "sample string 4",
      "useForPaymentSummaries": true,
      "emailType": "sample string 5"
    }
  ],
  "employeeLeaves": [
    {
      "idEmployeeLeave": 1,
      "empCode": "sample string 2",
      "firstName": "sample string 3",
      "surname": "sample string 4",
      "terminated": true,
      "terminationDate": "2024-05-19T09:51:32.868435+10:00",
      "leaveType": "sample string 5",
      "leaveCode": "sample string 6",
      "ytdLoading": 1.1,
      "postEntDate": "2024-05-19T09:51:32.868435+10:00",
      "postEntHours": 1.1,
      "postEntDays": 1.1,
      "postProDate": "2024-05-19T09:51:32.868435+10:00",
      "postProHours": 1.1,
      "postProDays": 1.1,
      "currentAccrualDate": "2024-05-19T09:51:32.868435+10:00",
      "currentAccrualHours": 1.1,
      "preEntHours": 1.1,
      "preEntDays": 1.1,
      "takenDate": "2024-05-19T09:51:32.868435+10:00",
      "takenHours": 1.1,
      "suspendEnt": true,
      "firstEntPeriod": true,
      "pre78EntHours": 1.1,
      "pre78EntDays": 1.1,
      "grant": true,
      "nonEntMonths": 1,
      "suspendFrom": "2024-05-19T09:51:32.868435+10:00",
      "suspendTo": "2024-05-19T09:51:32.868435+10:00",
      "nonEntMet": true,
      "costCode": "sample string 7",
      "leaveShifts": 1.1,
      "hoursPerDay": 1.1,
      "daysPerWeek": 1.1
    },
    {
      "idEmployeeLeave": 1,
      "empCode": "sample string 2",
      "firstName": "sample string 3",
      "surname": "sample string 4",
      "terminated": true,
      "terminationDate": "2024-05-19T09:51:32.868435+10:00",
      "leaveType": "sample string 5",
      "leaveCode": "sample string 6",
      "ytdLoading": 1.1,
      "postEntDate": "2024-05-19T09:51:32.868435+10:00",
      "postEntHours": 1.1,
      "postEntDays": 1.1,
      "postProDate": "2024-05-19T09:51:32.868435+10:00",
      "postProHours": 1.1,
      "postProDays": 1.1,
      "currentAccrualDate": "2024-05-19T09:51:32.868435+10:00",
      "currentAccrualHours": 1.1,
      "preEntHours": 1.1,
      "preEntDays": 1.1,
      "takenDate": "2024-05-19T09:51:32.868435+10:00",
      "takenHours": 1.1,
      "suspendEnt": true,
      "firstEntPeriod": true,
      "pre78EntHours": 1.1,
      "pre78EntDays": 1.1,
      "grant": true,
      "nonEntMonths": 1,
      "suspendFrom": "2024-05-19T09:51:32.868435+10:00",
      "suspendTo": "2024-05-19T09:51:32.868435+10:00",
      "nonEntMet": true,
      "costCode": "sample string 7",
      "leaveShifts": 1.1,
      "hoursPerDay": 1.1,
      "daysPerWeek": 1.1
    }
  ],
  "employeeSuperConts": [
    {
      "idEmployeeSuperCont": 1,
      "empCode": "sample string 2",
      "fundCode": "sample string 3",
      "dateJoined": "2024-05-19T09:51:32.868435+10:00",
      "membershipNumber": "sample string 4",
      "accountName": "sample string 5",
      "categoryCode": "sample string 6",
      "salaryForSuper": 1.0,
      "contributionCode": "sample string 7",
      "contributionType": "sample string 8",
      "contributionAmount": 1.0,
      "allocation": 1.0,
      "costAccount": "sample string 9",
      "isPrimaryContribution": true,
      "dateTerminated": "2024-05-19T09:51:32.868435+10:00"
    },
    {
      "idEmployeeSuperCont": 1,
      "empCode": "sample string 2",
      "fundCode": "sample string 3",
      "dateJoined": "2024-05-19T09:51:32.868435+10:00",
      "membershipNumber": "sample string 4",
      "accountName": "sample string 5",
      "categoryCode": "sample string 6",
      "salaryForSuper": 1.0,
      "contributionCode": "sample string 7",
      "contributionType": "sample string 8",
      "contributionAmount": 1.0,
      "allocation": 1.0,
      "costAccount": "sample string 9",
      "isPrimaryContribution": true,
      "dateTerminated": "2024-05-19T09:51:32.868435+10:00"
    }
  ],
  "emailUsedForPayslips": true,
  "emailUsedForPaymentSummaries": true,
  "emailType": "sample string 31",
  "referenceNumber": "sample string 32",
  "onBoarding": true
}