EmployeeService

Method	Description
EmployeeService.addEmployeeEvents	Adds employee events without affecting existing events
EmployeeService.adjustStatusHistory	Updates an employee's status/type change history date.
EmployeeService.approveOrDenyPTORequest	Approves or denies employee PTO requests
EmployeeService.benefitPlanSetEligible	Change enrollment status of a benefit plan from Not Eligible to Eligible
EmployeeService.benefitPlanSetInEligible	Change enrollment status of a benefit plan from Eligible to Not Eligible
EmployeeService.benefitPlanSetTerminate	Change enrollment status of a benefit plan from Active to Terminated
EmployeeService.benefitPlanSetWaive	Change enrollment status of a benefit plan from Eligible to Waived
EmployeeService.cancelPTORequest	Cancel an employee PTO request.
EmployeeService.checkForGarnishments	Returns whether an employee has active garnishments. Does not return garnishment details.
EmployeeService.download1095C	Downloads Form 1095-C for a specified employee or range of employees.
EmployeeService.downloadW2	Downloads Form W-2 for a specified employee or range of employees.
EmployeeService.get1095CYears	Return a list of Form 1095-C years available for a specified employee (if the client is configured to show these forms in Employee Portal).
EmployeeService.get1099Years	Return a list of Form 1099 years for a particular client and independent contractor (if the client is configured to show these forms in Employee Portal).
EmployeeService.getAddressInfo	Retrieve address information for the specified employee
Note: Not in prismhr-api. Endpoint was deprecated in API 1.30 or combined with others. EmployeeService.getEmpRestricted	Retrieve information for up to 20 employees, excluding sensitive information (ethnic code, birth date, driver’s license ID, and Social Security number)
EmployeeService.getEmployee	Retrieve detailed information for up to 20 employees for the specified employee IDs
EmployeeService.getEmployeeBySSN	Retrieve detailed information for up to 20 employees for the specified Social Security numbers
EmployeeService.getEmployeeEvents	Retrieve a list of employee events for a single employee
EmployeeService.getEmployeeList	Retrieve list of IDs for employees who are employed by the specified client that the PrismHR user can access
EmployeeService.getEmployeesReadyforEverify	This method requires collaboration with a third-party vendor. Retrieve all employees with an E-Verify status of Everification-Requested.
EmployeeService.getEmployeeSSNList	Retrieve a list of employees including their employee IDs and Social Security numbers for the specified client
EmployeeService.getEmployersInfo	Retrieve employee’s current employer and all employers associated with the specified client
EmployeeService.getEverifyStatus	This method requires collaboration with a third-party vendor. Retrieve an employee's E-Verify status and case number.
EmployeeService.getFutureEeChange	Retrieve employee changes to position, pay rate, and status that are scheduled for a date in the future
EmployeeService.getGarnishmentEmployee	Retrieve the employee ID associated with a specific client and garnishment. Use this in conjunction with garnishment subscription events, returned by `SubscriptionService.getEvents` and `getNewEvents`.
EmployeeService.getHistory	Retrieve events for the employee: pay rate changes, job/position changes, leaves of absence, status changes, and employment termination
EmployeeService.getI9Data	Retrieve all data pertinent to the USCIS form I9 for a particular employee as employed by the specified client
EmployeeService.getLeaveRequests	Retrieve employee PTO requests for specified client ID and leave request
EmployeeService.getLifEevent	Retrieve a single employee life event for the provided client and employee.
EmployeeService.getOSHA	Retrieve OSHA Cases information
EmployeeService.getPayCardEmployees	Return employee IDs associated with a particular bank transit number. Can also check if a specific employee ID corresponds to a specific bank transit number.
EmployeeService.getPayRateHistory	Retrieve Pay Rate historical information
EmployeeService.getPendingApproval	Retrieve a list of pending approvals by employee ID
EmployeeService.getPositionRate	Retrieve Employee Position Rates information for the specified employee
EmployeeService.getScheduledDeductions	Retrieve a list of an employee’s scheduled deductions. These are one-time or temporary deductions and do not include standard deductions or garnishments.
EmployeeService.getStatusHistoryForAdjustment	Provides all the information necessary to make a status/type history date adjustment for an employee in a specified client (`EmployeeService.adjustStatusHistory`).
EmployeeService.getTerminationDateRange	Retrieve a valid date range for employee terminations
Note: Not in prismhr-api. Endpoint was deprecated in API 1.30 or combined with others. EmployeeService.getUserDefinedFields	Retrieve user-defined fields and the fields’ values for the employee
EmployeeService.getW2Years	Return a list of Form W-2 years available for the specified employee.
EmployeeService.lookupBySsn	Retrieve information associated with the Social Security number: name, client ID, employee ID, and current status
EmployeeService.reactivate	Activate an employee on leave.
EmployeeService.rehireEmployee	Rehire an employee
EmployeeService.removeEmployee	Remove up to twenty employee records
EmployeeService.reprint1099	Download Form 1099 for a particular employee and year. The employee ID must belong to an independent contractor.
EmployeeService.requestPTO	Create planned time off (PTO) requests under client or global PTO plans.
EmployeeService.setEmployeePayAllocations	Creates or updates employee pay allocations.
EmployeeService.setEmployer	Update the employer assignment for a specified employee.
EmployeeService.setEverifyStatus	This method requires collaboration with a third-party vendor. Sets an employee's E-Verify status, flag, and case number.
EmployeeService.setHSA	Creates and updates employee direct deposit details related to health savings accounts (HSA).
EmployeeService.setI9Data	Update an employee's form I-9 information
EmployeeService.setPositionRate	Update employee position/job rates
Note: Not in prismhr-api. Endpoint was deprecated in API 1.30 or combined with others. EmployeeService.setUserDefinedFields	Update user-defined fields for an employee
EmployeeService.takeLeaveOfAbsence	Place an employee on leave of absence.
EmployeeService.terminateEmployee	Terminate employment of single employee at a single client
Note: Not in prismhr-api. Endpoint was deprecated in API 1.30 or combined with others. EmployeeService.turnOffOnboardActiveFlag	Turn off the Onboard Active flag to enable users to enter new employee information through the API without the electronic onboarding process
EmployeeService.updateAddressInfo	Update employee’s address information
EmployeeService.updateAssignment	Update employee’s assignments in Employee Details Work tab
EmployeeService.updateDirectDeposit	Update employee’s direct deposit account information
EmployeeService.updateDirectDepositForAdmins	Update direct deposit account information for checking and savings accounts as well as pay cards
EmployeeService.updateEmergencyContact	Update employee’s emergency contact information in Employee Details Personal tab
Note: Not in prismhr-api. Endpoint was deprecated in API 1.30 or combined with others. EmployeeService.updateEmployeeClientInfo	Update employee data values related to their client.
EmployeeService.updateEmployeeEvents	Update existing employee events for an employee and requires a checksum value
EmployeeService.updateEmployeeFields	Update individual employee fields without the need to supply a checksum. You can submit only the fields you want to update.
EmployeeService.updateEmployeeSkills	Updates an employee's skills and education information
EmployeeService.updateEmployeeStatusType	Change employee’s status or type as in Status Type Change form
EmployeeService.updateFutureAssignment	Make future-dated changes to employee Division, Department, Location, or Benefit group
EmployeeService.updateJobCode	Update employee’s position/job code
EmployeeService.updatePayGroup	Update employee’s pay group information
EmployeeService.updatePayMethod	Update employee pay method information
EmployeeService.updatePayRate	Update employee’s pay rate information
Note: Not in prismhr-api. Endpoint was deprecated in API 1.30 or combined with others. EmployeeService.updatePerformanceReview	Update/push performance review information for an employee from another product into PrismHR
Note: Not in prismhr-api. Endpoint was deprecated in API 1.30 or combined with others. EmployeeService.updatePersonalInfo	Update employee’s personal information
EmployeeService.updateScheduledDeduction	Update employee’s Scheduled Deductions
EmployeeService.updateW4	Update employee’s tax information for the Form W-4
EmployeeService.validateEmployeeStatusType	Check for any issues with changing the employee’s status
EmployeeService.validateEmployeeTerminate	Check for any issues that would arise with terminating the employee
EmployeeService.validateReactivate	Reactivate an employee on leave. Use this method before using `EmployeeService.reactivate` to validate the reactivation request.
EmployeeService.validateTakeLeaveOfAbsence	Validate an employee's leave of absence. Use this method before using `EmployeeService. takeLeaveOfAbsence` to validate a leave of absence request.

EmployeeService.addEmployeeEvents

Adds employee events without affecting existing events

EmployeeService.adjustStatusHistory

Updates an employee's status/type change history date.

EmployeeService.approveOrDenyPTORequest

Approves or denies employee PTO requests

EmployeeService.benefitPlanSetEligible

Change enrollment status of a benefit plan from Not Eligible to Eligible

EmployeeService.benefitPlanSetInEligible

Change enrollment status of a benefit plan from Eligible to Not Eligible

EmployeeService.benefitPlanSetTerminate

Change enrollment status of a benefit plan from Active to Terminated

EmployeeService.benefitPlanSetWaive

Change enrollment status of a benefit plan from Eligible to Waived

EmployeeService.cancelPTORequest

Cancel an employee PTO request.

EmployeeService.checkForGarnishments

Returns whether an employee has active garnishments. Does not return garnishment details.

EmployeeService.download1095C

Downloads Form 1095-C for a specified employee or range of employees.

EmployeeService.downloadW2

Downloads Form W-2 for a specified employee or range of employees.

EmployeeService.get1095CYears

Return a list of Form 1095-C years available for a specified employee (if the client is configured to show these forms in Employee Portal).

EmployeeService.get1099Years

Return a list of Form 1099 years for a particular client and independent contractor (if the client is configured to show these forms in Employee Portal).

EmployeeService.getAddressInfo

Retrieve address information for the specified employee

Note: Not in prismhr-api. Endpoint was deprecated in API 1.30 or combined with others.

EmployeeService.getEmpRestricted

Retrieve information for up to 20 employees, excluding sensitive information (ethnic code, birth date, driver’s license ID, and Social Security number)

EmployeeService.getEmployee

Retrieve detailed information for up to 20 employees for the specified employee IDs

EmployeeService.getEmployeeBySSN

Retrieve detailed information for up to 20 employees for the specified Social Security numbers

EmployeeService.getEmployeeEvents

Retrieve a list of employee events for a single employee

EmployeeService.getEmployeeList

Retrieve list of IDs for employees who are employed by the specified client that the PrismHR user can access

EmployeeService.getEmployeesReadyforEverify

This method requires collaboration with a third-party vendor.

Retrieve all employees with an E-Verify status of Everification-Requested.

EmployeeService.getEmployeeSSNList

Retrieve a list of employees including their employee IDs and Social Security numbers for the specified client

EmployeeService.getEmployersInfo

Retrieve employee’s current employer and all employers associated with the specified client

EmployeeService.getEverifyStatus

This method requires collaboration with a third-party vendor.

Retrieve an employee's E-Verify status and case number.

EmployeeService.getFutureEeChange

Retrieve employee changes to position, pay rate, and status that are scheduled for a date in the future

EmployeeService.getGarnishmentEmployee

Retrieve the employee ID associated with a specific client and garnishment. Use this in conjunction with garnishment subscription events, returned by SubscriptionService.getEvents and getNewEvents.

EmployeeService.getHistory

Retrieve events for the employee: pay rate changes, job/position changes, leaves of absence, status changes, and employment termination

EmployeeService.getI9Data

Retrieve all data pertinent to the USCIS form I9 for a particular employee as employed by the specified client

EmployeeService.getLeaveRequests

Retrieve employee PTO requests for specified client ID and leave request

EmployeeService.getLifEevent

Retrieve a single employee life event for the provided client and employee.

EmployeeService.getOSHA

Retrieve OSHA Cases information

EmployeeService.getPayCardEmployees

Return employee IDs associated with a particular bank transit number. Can also check if a specific employee ID corresponds to a specific bank transit number.

EmployeeService.getPayRateHistory

Retrieve Pay Rate historical information

EmployeeService.getPendingApproval

Retrieve a list of pending approvals by employee ID

EmployeeService.getPositionRate

Retrieve Employee Position Rates information for the specified employee

EmployeeService.getScheduledDeductions

Retrieve a list of an employee’s scheduled deductions. These are one-time or temporary deductions and do not include standard deductions or garnishments.

EmployeeService.getStatusHistoryForAdjustment

Provides all the information necessary to make a status/type history date adjustment for an employee in a specified client (EmployeeService.adjustStatusHistory).

EmployeeService.getTerminationDateRange

Retrieve a valid date range for employee terminations

Note: Not in prismhr-api. Endpoint was deprecated in API 1.30 or combined with others.

EmployeeService.getUserDefinedFields

Retrieve user-defined fields and the fields’ values for the employee

EmployeeService.getW2Years

Return a list of Form W-2 years available for the specified employee.

EmployeeService.lookupBySsn

Retrieve information associated with the Social Security number: name, client ID, employee ID, and current status

EmployeeService.reactivate

Activate an employee on leave.

EmployeeService.rehireEmployee

Rehire an employee

EmployeeService.removeEmployee

Remove up to twenty employee records

EmployeeService.reprint1099

Download Form 1099 for a particular employee and year. The employee ID must belong to an independent contractor.

EmployeeService.requestPTO

Create planned time off (PTO) requests under client or global PTO plans.

EmployeeService.setEmployeePayAllocations

Creates or updates employee pay allocations.

EmployeeService.setEmployer

Update the employer assignment for a specified employee.

EmployeeService.setEverifyStatus

This method requires collaboration with a third-party vendor.

Sets an employee's E-Verify status, flag, and case number.

EmployeeService.setHSA

Creates and updates employee direct deposit details related to health savings accounts (HSA).

EmployeeService.setI9Data

Update an employee's form I-9 information

EmployeeService.setPositionRate

Update employee position/job rates

Note: Not in prismhr-api. Endpoint was deprecated in API 1.30 or combined with others.

EmployeeService.setUserDefinedFields

Update user-defined fields for an employee

EmployeeService.takeLeaveOfAbsence

Place an employee on leave of absence.

EmployeeService.terminateEmployee

Terminate employment of single employee at a single client

Note: Not in prismhr-api. Endpoint was deprecated in API 1.30 or combined with others.

EmployeeService.turnOffOnboardActiveFlag

Turn off the Onboard Active flag to enable users to enter new employee information through the API without the electronic onboarding process

EmployeeService.updateAddressInfo

Update employee’s address information

EmployeeService.updateAssignment

Update employee’s assignments in Employee Details Work tab

EmployeeService.updateDirectDeposit

Update employee’s direct deposit account information

EmployeeService.updateDirectDepositForAdmins

Update direct deposit account information for checking and savings accounts as well as pay cards

EmployeeService.updateEmergencyContact

Update employee’s emergency contact information in Employee Details Personal tab

Note: Not in prismhr-api. Endpoint was deprecated in API 1.30 or combined with others.

EmployeeService.updateEmployeeClientInfo

Update employee data values related to their client.

EmployeeService.updateEmployeeEvents

Update existing employee events for an employee and requires a checksum value

EmployeeService.updateEmployeeFields

Update individual employee fields without the need to supply a checksum. You can submit only the fields you want to update.

EmployeeService.updateEmployeeSkills

Updates an employee's skills and education information

EmployeeService.updateEmployeeStatusType

Change employee’s status or type as in Status Type Change form

EmployeeService.updateFutureAssignment

Make future-dated changes to employee Division, Department, Location, or Benefit group

EmployeeService.updateJobCode

Update employee’s position/job code

EmployeeService.updatePayGroup

Update employee’s pay group information

EmployeeService.updatePayMethod

Update employee pay method information

EmployeeService.updatePayRate

Update employee’s pay rate information

Note: Not in prismhr-api. Endpoint was deprecated in API 1.30 or combined with others.

EmployeeService.updatePerformanceReview

Update/push performance review information for an employee from another product into PrismHR

Note: Not in prismhr-api. Endpoint was deprecated in API 1.30 or combined with others.

EmployeeService.updatePersonalInfo

Update employee’s personal information

EmployeeService.updateScheduledDeduction

Update employee’s Scheduled Deductions

EmployeeService.updateW4

Update employee’s tax information for the Form W-4

EmployeeService.validateEmployeeStatusType

Check for any issues with changing the employee’s status

EmployeeService.validateEmployeeTerminate

Check for any issues that would arise with terminating the employee

EmployeeService.validateReactivate

Reactivate an employee on leave. Use this method before using EmployeeService.reactivate to validate the reactivation request.

EmployeeService.validateTakeLeaveOfAbsence

Validate an employee's leave of absence. Use this method before using

EmployeeService.
takeLeaveOfAbsence

to validate a leave of absence request.