GET api/WeEmployeeDetails/{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})

Name	Description	Type	Additional information
id	The Employee Code used in the WageEasy database	string	Required

Body Parameters

None.

Response Information

Resource Description

A single Employee's details if the employee is found

WeEmployeeDetailView

Name	Type	Additional information
Id	integer	None.
EmployeeNo	string	None.
LastName	string	None.
FirstName	string	None.
SecondName	string	None.
Title	string	None.
JobTitle	string	None.
HomeAddress	string	None.
HomeCity	string	None.
HomeState	string	None.
HomePostcode	string	None.
HomeCountry	string	None.
PostalAddress	string	None.
PostalCity	string	None.
PostalState	string	None.
PostalPostcode	string	None.
PostalCountry	string	None.
Birthday	date	None.
Gender	string	None.
MaritalStatus	string	None.
Location	string	None.
PayPeriod	string	None.
Employment Category	string	None.
EmploymentDate	date	None.
AwardDate	date	None.
TerminateDate	date	None.
TerminateReason	string	None.
AwardKey	string	None.
Salaried	boolean	None.
TaxKey	string	None.
SecondaryTaxKey	string	None.
TertiaryTaxKey	string	None.
ForthTaxKey	string	None.
FifthTaxKey	string	None.
TaxAdjustment	decimal number	None.
TaxFileNo	string	None.
CanProvideTFNTo SuperFund	boolean	None.
NonAustralian Resident	boolean	None.
TimeCardNo	string	None.
GLCode	string	None.
SecurityPassNo	string	None.
UserPassword	string	None.
Notes	string	None.
NormalDayHours	date	None.
NormalDayHours UseAward	boolean	None.
StandardPay Hours	decimal number	None.
IsStandardPays	boolean	None.
DefaultEmail	string	None.
DefaultEmailUsed ForPayslips	string	None.
Telephone1	string	None.
Telephone1 Description	string	None.
Telephone2	string	None.
Telephone2 Description	string	None.
DefaultPay RateKey	string	None.
Default Department	string	None.
KnownAs	string	None.
IncludesTaxFree Threshold	boolean	None.
IncludesHELP Debt	boolean	None.
IncludesSFSS Debt	boolean	None.
ClaimsFamilyTax Benefit	boolean	None.
FlatRate Threshold	integer	None.
TFNDeclaration Date	date	None.
DefaultPayRate Amount	decimal number	None.
WeEmployeeBank	Collection of WeEmployeeBank View	None.
WeEmployeeSuper	Collection of WeEmployeeSuper View	None.
WeEmployee Allowance	Collection of WeEmployeeAllowance View	None.
WeEmployeeLeave	Collection of WeEmployeeLeave View	None.

Response Formats

application/json, text/json

Sample:

{
  "id": 1,
  "employeeNo": "sample string 2",
  "lastName": "sample string 3",
  "firstName": "sample string 4",
  "secondName": "sample string 5",
  "title": "sample string 6",
  "jobTitle": "sample string 7",
  "homeAddress": "sample string 8",
  "homeCity": "sample string 9",
  "homeState": "sample string 10",
  "homePostcode": "sample string 11",
  "homeCountry": "sample string 12",
  "postalAddress": "sample string 13",
  "postalCity": "sample string 14",
  "postalState": "sample string 15",
  "postalPostcode": "sample string 16",
  "postalCountry": "sample string 17",
  "birthday": "2024-11-21T23:41:42.5177887+11:00",
  "gender": "sample string 18",
  "maritalStatus": "sample string 19",
  "location": "sample string 20",
  "payPeriod": "sample string 21",
  "employmentCategory": "sample string 22",
  "employmentDate": "2024-11-21T23:41:42.5177887+11:00",
  "awardDate": "2024-11-21T23:41:42.5177887+11:00",
  "terminateDate": "2024-11-21T23:41:42.5177887+11:00",
  "terminateReason": "sample string 23",
  "awardKey": "sample string 24",
  "salaried": true,
  "taxKey": "sample string 25",
  "secondaryTaxKey": "sample string 26",
  "tertiaryTaxKey": "sample string 27",
  "forthTaxKey": "sample string 28",
  "fifthTaxKey": "sample string 29",
  "taxAdjustment": 1.1,
  "taxFileNo": "sample string 30",
  "canProvideTFNToSuperFund": true,
  "nonAustralianResident": true,
  "timeCardNo": "sample string 31",
  "glCode": "sample string 32",
  "securityPassNo": "sample string 33",
  "userPassword": "sample string 34",
  "notes": "sample string 35",
  "normalDayHours": "2024-11-21T23:41:42.5177887+11:00",
  "normalDayHoursUseAward": true,
  "standardPayHours": 1.1,
  "isStandardPays": true,
  "defaultEmail": "sample string 37",
  "defaultEmailUsedForPayslips": "sample string 38",
  "telephone1": "sample string 39",
  "telephone1Description": "sample string 40",
  "telephone2": "sample string 41",
  "telephone2Description": "sample string 42",
  "defaultPayRateKey": "sample string 43",
  "defaultDepartment": "sample string 44",
  "knownAs": "sample string 45",
  "includesTaxFreeThreshold": true,
  "includesHELPDebt": true,
  "includesSFSSDebt": true,
  "claimsFamilyTaxBenefit": true,
  "flatRateThreshold": 1,
  "tfnDeclarationDate": "2024-11-21T23:41:42.5177887+11:00",
  "defaultPayRateAmount": 1.1,
  "weEmployeeBank": [
    {
      "id": 1,
      "employeeNo": "sample string 2",
      "sequence": 1,
      "payMethod": "sample string 3",
      "bank": "sample string 4",
      "bsb": "sample string 5",
      "accountNo": "sample string 6",
      "accountSuffix": "sample string 7",
      "accountName": "sample string 8",
      "amount": 1.1,
      "default": true
    },
    {
      "id": 1,
      "employeeNo": "sample string 2",
      "sequence": 1,
      "payMethod": "sample string 3",
      "bank": "sample string 4",
      "bsb": "sample string 5",
      "accountNo": "sample string 6",
      "accountSuffix": "sample string 7",
      "accountName": "sample string 8",
      "amount": 1.1,
      "default": true
    }
  ],
  "weEmployeeSuper": [
    {
      "id": 1,
      "employeeNo": "sample string 2",
      "superFund": "sample string 3",
      "membershipNo": "sample string 4",
      "contribution": 1.1,
      "percentFlag": true,
      "contributionType": "sample string 6",
      "includeAsRESC": true,
      "joinDate": "2024-11-21T23:41:42.5177887+11:00",
      "outDate": "2024-11-21T23:41:42.5177887+11:00",
      "contributionTypeAdditional": "sample string 8"
    },
    {
      "id": 1,
      "employeeNo": "sample string 2",
      "superFund": "sample string 3",
      "membershipNo": "sample string 4",
      "contribution": 1.1,
      "percentFlag": true,
      "contributionType": "sample string 6",
      "includeAsRESC": true,
      "joinDate": "2024-11-21T23:41:42.5177887+11:00",
      "outDate": "2024-11-21T23:41:42.5177887+11:00",
      "contributionTypeAdditional": "sample string 8"
    }
  ],
  "weEmployeeAllowance": [
    {
      "id": 1,
      "employeeNo": "sample string 2",
      "empGpCert": "sample string 3",
      "allowanceKey": "sample string 4",
      "allowanceAccrual": "sample string 5",
      "department": "sample string 6",
      "active": 1,
      "onGroupCert": true,
      "showOnGpCertAs": "sample string 7",
      "payAlways": 1,
      "accruedAmount": 1.1,
      "averageCalcOn": true,
      "amount": 1.1,
      "overrideDefault": true,
      "excludeIncome": true
    },
    {
      "id": 1,
      "employeeNo": "sample string 2",
      "empGpCert": "sample string 3",
      "allowanceKey": "sample string 4",
      "allowanceAccrual": "sample string 5",
      "department": "sample string 6",
      "active": 1,
      "onGroupCert": true,
      "showOnGpCertAs": "sample string 7",
      "payAlways": 1,
      "accruedAmount": 1.1,
      "averageCalcOn": true,
      "amount": 1.1,
      "overrideDefault": true,
      "excludeIncome": true
    }
  ],
  "weEmployeeLeave": [
    {
      "id": 1,
      "employeeNo": "sample string 2",
      "leaveTypeId": 3,
      "leaveType": "sample string 4",
      "terminated": true,
      "terminationDate": "2024-11-21T23:41:42.5177887+11:00",
      "leaveCode": "sample string 5",
      "postEntDate": "2024-11-21T23:41:42.5177887+11:00",
      "postEntHours": 1.1,
      "postEntDays": 1.1,
      "postProDate": "2024-11-21T23:41:42.5177887+11:00",
      "postProHours": 1.1,
      "postProDays": 1.1,
      "currentAccrualDate": "2024-11-21T23:41:42.5177887+11:00",
      "currentAccrualHours": 1.1,
      "preEntHours": 1.1,
      "preEntDays": 1.1,
      "takenDate": "2024-11-21T23:41:42.5177887+11:00",
      "takenHours": 1.1,
      "hoursPerDay": 1.1,
      "daysPerWeek": 1.1
    },
    {
      "id": 1,
      "employeeNo": "sample string 2",
      "leaveTypeId": 3,
      "leaveType": "sample string 4",
      "terminated": true,
      "terminationDate": "2024-11-21T23:41:42.5177887+11:00",
      "leaveCode": "sample string 5",
      "postEntDate": "2024-11-21T23:41:42.5177887+11:00",
      "postEntHours": 1.1,
      "postEntDays": 1.1,
      "postProDate": "2024-11-21T23:41:42.5177887+11:00",
      "postProHours": 1.1,
      "postProDays": 1.1,
      "currentAccrualDate": "2024-11-21T23:41:42.5177887+11:00",
      "currentAccrualHours": 1.1,
      "preEntHours": 1.1,
      "preEntDays": 1.1,
      "takenDate": "2024-11-21T23:41:42.5177887+11:00",
      "takenHours": 1.1,
      "hoursPerDay": 1.1,
      "daysPerWeek": 1.1
    }
  ]
}