Administrative APIs | REST

Version:
Download Open API Specification

Get Employee Human Resource Information

https://api.wealthcare.com/system/Services/Employee/EmployeeHumanResourceInfo/{tpaId}/{employerId}/{employeeId}/Details

This operation is used to retrieve an individual employee’s Human Resources (HR) information.

  • tpaId string Required

    A unique identifier used to identify your admin instance. This value was system generated with the admin instance was created.

  • employerId string Required

    Unique identifier for the employer. Note: When the employer was created, WealthCare Admin assigned the 3-character prefix; you assigned the remaining characters.

  • employeeId string Required

    Unique identifier for the employee.

  • TpaId string

    This field is not used. The TpaId sent as a path parameter will be used.

  • EmpeSsn string

    This field is not used. The path parameter EmployeeId will be used to determine what employee to return data for.

  • EmprId string

    This field is not used. The EmployerId sent as a path parameter will be used.

  • socSecNum string

    This field is not used. The path parameter EmployeeId will be used to determine what employee to return data for.

  • AddComp1 string

    Any additional compensation reported by or determined by the Employer.

  • AddComp2 string

    Any additional compensation reported by or determined by the Employer.

  • BaseSalary string

    Enter the employee’s base salary determined by or reported by the Employer.

  • BranchCde string

    The branch code determined by the Employer/Administrator.

  • Cobra boolean

    Indicates if participant is enrolled in COBRA

  • CompOfficer boolean

    Employee Highly Compensated Cafeteria Plan Definition

  • CompOfficerDca boolean

    Highly Compensated Dependent Care definition

  • HireDte string

    Employee’s hire date

  • OrigHireDte string

    Employee’s original hire date if more than one period of employment exists.

  • TermDte string

    Date upon which the employee is no longer eligible for benefits. This existing field is being updated to validate that it is after the eligibility date.

  • EligDte string

    Date upon which the employee is eligible to elect benefits. This existing field is being updated to validate that it is prior to the termination date.

  • OccupCde string

    The administrator's occupation code for the employee

  • LocCde string

    The administrator's location code for the employee

  • DeptCde string

    Department code for the employee

  • DivisionKey string

    A unique identifier generated by WCA used to represent a division

  • SecCde string

    The employer or administrator's section code for the employee

  • HealthId string

    An assigned ID for the employee’s health plan. You can use this field for TPS matching but cannot use it to search for an employee.

  • EvidInsurability string

    The administrator's status code used to indicate evidence of insurability.

  • HcRelativeSsn string

    The social security number of the highly compensated relative.

  • PrevYrTotalComp string

    The employee’s previous year total compensation determined by or reported by the Employer.

  • StockPct string

    Percent of company stock employee holds.

  • VacationDays string

    Number of vacation days for the employee

  • UnionMember boolean

    indicates if the employee is a union member

  • Smoker boolean

    indicates if the employee is a smoker

  • NonResidentAlien boolean

    indicates if the employee is a non-resident alien

  • taxFilingStatusCde enum<string>

    Tax filing status

    Possible values: None Single Married Filing Jointly Married Filing Separately Head of Household qualifying Widow
  • employTypeCde enum<string>

    Employment type code

    Possible values: FullTime PartTime Contract
  • empeOptioncde enum<string>

    Option to enter election amounts Total Individual

    Possible values: Total Individual IsSelfCreated MedicareOpted Esrd CMSAdd HideDepClaimsOnExpensePage DDBankAcctValReqReminderSent DisableOnlineRepayment HasForeignCardShipAddress VIPException
  • keyEmpe boolean

    Indicates if employee is a key employee

  • spouseDepOfOwner boolean

    Spouse/Dependent of owner

  • electOtherAmt string

    Health Election Amount for an employee. Do not use this field if Option to Enter Election Amounts is ‘Total’. You can use this field to record the employee’s benefit/election amounts. This data can only be used when running the 25% Cafeteria Plan Test.

  • electHealthAmt string

    Health Election Amount for an employee. Do not use this field if Option to Enter Election Amounts is ‘Total’. You can use this field to record the employee’s benefit/election amounts. This data can only be used when running the 25% Cafeteria Plan Test.

  • electDentalAmt string

    Dental Election Amount for an employee. Do not use this field if Option to Enter Election Amounts is ‘Total’. You can use this field to record the employee’s benefit/election amounts. This data can only be used when running the 25% Cafeteria Plan Test

  • electVisionAmt string

    Vision Election Amount for an employee. Do not use this field if Option to Enter Election Amounts is ‘Total’. You can use this field to record the employee’s benefit/election amounts. This data can only be used when running the 25% Cafeteria Plan Test.

  • electGrpTermLifeAmt string

    Group Term Life Election Amount for an employee. Do not use this field if Option to Enter Election Amounts is ‘Total’. You can use this field to record the employee’s benefit/election amounts. This data can only be used when running the 25% Cafeteria Plan Test.

  • electOtherHealthAmt string

    Other Health Election Amount for an employee. Do not use this field if Option to Enter Election Amounts is ‘Total’. You can use this field to record the employee’s benefit/election amounts. This data can only be used when running the 25% Cafeteria Plan Test.

  • electLtdAmt string

    LTD Election Amount for an employee. Do not use this field if Option to Enter Election Amounts is ‘Total’. You can use this field to record the employee’s benefit/election amounts. This data can only be used when running the 25% Cafeteria Plan Test.

  • electStdAmt string

    STD Election Amount for an employee. Do not use this field if Option to Enter Election Amounts is ‘Total’. You can use this field to record the employee’s benefit/election amounts. This data can only be used when running the 25% Cafeteria Plan Test.

  • electAdoptionAmt string

    Adoption Election Amount for an employee. Do not use this field if Option to Enter Election Amounts is ‘Total’. You can use this field to record the employee’s benefit/election amounts. This data can only be used when running the 25% Cafeteria Plan Test.

  • elect401kAmt string

    401K election amount. Do not use this field if Option to Enter ElectionAmounts is ‘Total. You can use this field to record the employee’s benefit/election amounts. This data can only be used when running the 25% Cafeteria Plan Test.

  • electHealthFSAAmt string

    Health FSA Election Amount for an employee. Do not use this field if Option to Enter Election Amounts is ‘Total’. You can use this field to record the employee’s benefit/election amounts. This data can only be used when running the 25% Cafeteria Plan Test.

  • electDependentcareFSAAmt string

    Dependent Care FSA Election Amount for an employee. This field can be used to capture Dependent Care Election data for the Dependent Care Non-Discrimination Test. Do not use this field if Option to Enter Election Amounts is ‘Total’. You can use this field to record the employee’s benefit/election amounts. This data can only be used when running the 25% Cafeteria Plan Test.

  • totalElectAmt string

    The total of OTHER Election Amounts for an employee. Do not use this field if Option to Enter Election Amounts is ‘Total. You can use this field to record the employees benefit/election amounts. This data can only be used when running the 25% Cafeteria Plan Test

  • hcOverride string

    Highly compensated override

  • divisionName string

    Participant’s division name. This information should exactly match the division name as displayed in WCA

  • className string

    Participant’s class name. This information should exactly match the class name as displayed in WCA.