BenefitService

Method	Description
Note: Not in prismhr-api. Endpoint was deprecated in API 1.30 or combined with others. BenefitService.401KCensusExport	Retrieve census data for any active employees in all clients participating in a specified retirement plan.
BenefitService.addEmployeeAbsence	Add employee absences to their PTO register.
BenefitService.addFSAReimbursement	Create a new flexible spending account reimbursement for an employee. Does not modify existing FSA reimbursements.
BenefitService.adjustBenefitAdjustmentCycles	Calculate benefit plan adjustments related to changes in the benefit adjustment cycle.
BenefitService.adjustPTO	Adjust employee PTO (as in the Employee PTO Register Adjustment form).
BenefitService.benefitEnrollmentStatus	Return web enrollment configuration details for a specified client.
Note: Not in prismhr-api. Endpoint was deprecated in API 1.30 or combined with others. BenefitService.createBenefitPlanSetup	Update client’s Benefit Plan Setup parameters for group benefit plans; this Allowed Method gives web service users access to both the createBenefitPlanSetup and updateBenefitPlanSetup methods in the Benefit service. As of API 1.20, this method also supports setup of retirement, flex, employer match, and HSA plans.
BenefitService.deleteBenefitAdjustment	Delete a benefit adjustment associated with a specific reference number, employee, client, and checksum.
BenefitService.enrollBenefit	Enroll an employee in a benefit plan.
BenefitService.enrollPTORegister	Enroll an employee in a PTO register.
BenefitService.get401KMatchRules	Retrieve a client's 401(k) match rules.
BenefitService.getAbsenceJournal	Retrieve Employee absence information (PTO).
BenefitService.getACAOfferedEmployees	Retrieve information from the ACA Offered Employees form.
BenefitService.getActiveBenefitPlans	Retrieve Employee Benefits Enrollment information for active plans only
Note: Not in prismhr-api. Endpoint was deprecated in API 1.30 or combined with others. BenefitService.getActiveDependents	Retrieve Dependent information only for specified employees’ active dependents.
Note: Not in prismhr-api. Endpoint was deprecated in API 1.30 or combined with others. BenefitService.getActiveRetirementPlan	Retrieve Retirement Plan Enrollment information only for specified employees’ active plans.
BenefitService.getAvailableBenefitPlans	Retrieve available benefit plans for the specified employee, including status.
BenefitService.getBenefitAdjustments	Retrieve benefit adjustments for a specific employee.
BenefitService.getBenefitConfirmationData	Retrieve a JSON download of benefit confirmation data associated with a particular confirmation number. Use this method in conjunction with getBenefitConfirmationList.
BenefitService.getBenefitConfirmationList	Retrieve a list of benefit confirmation numbers and dates for a client and employee. Use this method in conjunction with getBenefitConfirmationData.
Note: Not in prismhr-api. Endpoint was deprecated in API 1.30 or combined with others. BenefitService.getBenefitGroupUserDefinedFields	Retrieve information about benefit group user-defined fields.
BenefitService.getBenefitPlanList	Retrieve a list of group benefit plan IDs, descriptions, and insurance class values.
BenefitService.getBenefitPlans	Retrieve Employee Benefits Enrollment information, including eligible plans or those that were waived or terminated.
BenefitService.getBenefitRule	Retrieve Benefit Rules information for specified clients.
BenefitService.getBenefitsEnrollmentTrace	Retrieve an employee's benefits enrollment workflow history.
BenefitService.getBenefitWorkflowGrid	Returns benefit enrollment workflow information from the Client Workflow Grid form.
BenefitService.getClientBenefitPlans	Retrieve all benefit plans available to a client, (regardless of their status).
BenefitService.getClientBenefitPlanSetupDetails	Retrieve benefit plan details for the specified client, plan, and plan classification.
BenefitService.getCobraCodes	Retrieve a list of qualifying events and termination reasons found in the Cobra processing parameters.
BenefitService.getCobraEmployee	Retrieve information about employees who are COBRA enrollees, such as enrollment process, qualifying events, and payments.
Note: Not in prismhr-api. Endpoint was deprecated in API 1.30 or combined with others. BenefitService.getDependent	Retrieve dependent information for a single specified employee, regardless of their status.
BenefitService.getDependents	Retrieve dependent information for specified employees, regardless of their status.
BenefitService.getDisabilityPlanEnrollmentDetails	Retrieve coverage amounts and other enrollment details for group benefit plans of Offer Type "STD" (short-term disability) or "LTD" (long-term disability").
BenefitService.getEligibleFlexSpendingPlans	Return a list of FSA and HSA plans for which the specified employee is eligible.
BenefitService.getEmployeePremium	Return information about employee benefit plan billing rates.
BenefitService.getEmployeeRetirementSummary	Retrieve the details of the retirement benefits for an employee.
BenefitService.getEnrollInputList	Retrieve the required elements to be able to enroll the employee in a plan.
BenefitService.getEnrollmentPlanDetails	Return benefit plan information from the carrier, including the deductible, copay, and visit type.
BenefitService.getFlexPlans	Retrieve Employee Flexible Spending Account enrollment information.
BenefitService.getFSAReimbursements	Retrieve data about FSA plan reimbursements for specific employees and clients.
BenefitService.getGroupBenefitPlan	Retrieve Group Benefit Plan details.
BenefitService.getGroupBenefitRates	Retrieve billing rates and premium rates for a specified benefit plan.
BenefitService.getGroupBenefitTypes	Retrieve group benefit plan type codes and the setup information associated with them, for use in your benefit plan setup process.
BenefitService.getLifeEventCodeDetails	Retrieve information about a client's life event codes, or a specified life event code.
BenefitService.getMonthlyACAInfo	Return calculations of monthly ACA data for an employee.
BenefitService.getPaidTimeOff	Retrieve Employee PTO Register information.
BenefitService.getPaidTimeOffPlans	Retrieve PTO Benefit Plans for specified clients.
BenefitService.getPlanYearInfo	Return information about retirement, HSA, and Section 125 benefit plan years.
BenefitService.getPtoAbsenceCodes	Retrieve PTO absence codes for a client. If an absenceCode is specified, one absence code is returned.
BenefitService.getPtoAutoEnrollRules	Retrieve information about PTO auto enroll rules.
BenefitService.getPtoClasses	Retrieve all PTO classes.
BenefitService.getPtoPlanDetails	Retrieve information about a single PTO benefit plan.
BenefitService.getPtoRegisterTypes	Return a list of PTO register types for a client.
BenefitService.getPtoRequestsList	Return a list of all employees' leave requests.
BenefitService.getRetirementLoans	Retrieve Employee Retirement Loans information.
BenefitService.getRetirementPlan	Retrieve Retirement Plan Enrollment information for specified employees, including eligible plans or those that were waived or made inactive.
BenefitService.getSection125Plans	Retrieve information about Section 125 plans or Health Savings Account (HSA) plans. Both plan types are associated with Flexible Spending Accounts (FSAs). This endpoint retrieves information about the FSAs associated with these plans. This endpoint also supports pagination for cases where more than 5000 records exist.
BenefitService.import401KData	Upload 401K import data, performs validations against the data, and then writes the new data to PrismHR. The response identifies those lines in the import data that did not pass validation, with error messages for each line. Rows that do pass validation are imported even if some rows contain errors.
BenefitService.retirementCensusExport	Return a CSV report file containing employee census information, including information about retirement benefit plans.
BenefitService.set401KMatchRules	Create or updates 401(k) match rules. Use the checksum from BenefitService.get401kMatchDetails.
BenefitService.setACAOfferedEmployees	Add data to the ACA Offered Employees form.
Note: Not in prismhr-api. Endpoint was deprecated in API 1.30 or combined with others. BenefitService.setBenefitGroupUserDefinedFields	Create or update user-defined benefit group fields for a specified client.
BenefitService.setBenefitAdjustments	Create or update benefit adjustments for an employee.
BenefitService.setBenefitRule	Set Benefit Rules for client. Now supports rule creation for medical, dental, vision, life insurance, and short/long-term disability plans.
BenefitService.setClientBenefitPlanSetupDetails	Updates benefit plan setup for a particular client. In prismhr-api, this replaces createBenefitPlanSetup and updateBenefitPlanSetup.
BenefitService.setDependent	Create a new dependent.
BenefitService.setDisabilityPlanEnrollmentDetails	Update coverage amounts and other enrollment details for group benefit plans of Offer Type "STD" (short-term disability) or "LTD" (long-term disability").
BenefitSerivce.setEmployeePtoAccrual	Start or stops the accrual of PTO for an employee.
BenefitService.setEnrollmentPlanDetails	Update benefit plan information from the carrier, including deductibles, copay amounts, and visit types.
BenefitService.setFlexPlan	Enroll a single employee in a flexible spending plan.
BenefitService.setGroupBenefitBillingRates	Set or updates billing rate details for the specified group benefit plan.
BenefitService.setGroupBenefitPlanDetails	Create or updates group benefit plan settings. Use the checksum from BenefitService.getGroupBenefitPlanDetails.
BenefitService.setGroupBenefitPremiumRates	Create or updates group benefit premium rate details. To obtain the checksum for this method, call BenefitService.getGroupBenefitRates.
BenefitService.setPtoAbsenceCode	Create or updates a single PTO absence code.
BenefitService.setPtoAutoEnrollRules	Create or updates PTO auto enroll rules. To update an existing rule set, use the checksum from BenefitService.getPtoAutoEnrollRules.
BenefitService.setPtoClass	Create a PTO class.
BenefitService.setPtoPlanDetails	Create a new or updates an existing PTO Benefit Plan. To obtain the checksum for this method, call the BenefitService.getPtoPlan method.
BenefitService.setPtoRegisterType	Create or update a single PTO register type.
BenefitService.setRetirementLoan	Create or update employee retirement loan.
BenefitService.submitLifeEvent	Enroll an employee in a life event workflow.
Note: Not in prismhr-api. Endpoint was deprecated in API 1.30 or combined with others. BenefitService.updateBenefitPlanSetup	To grant web service users access to this method in the API, enter the Allowed Method “BenefitService.createBenefitPlanSetup” (see above). As of API 1.20, this method now supports setup of retirement, flex, employer match, and HSA plans.
BenefitService.updateRetirementPlanElection	Update employee’s election details for a retirement plan.
BenefitService.updateRetirementPlanEnroll	Update employee’s Retirement Plan Enrollment details.

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

BenefitService.401KCensusExport

Retrieve census data for any active employees in all clients participating in a specified retirement plan.

BenefitService.addEmployeeAbsence

Add employee absences to their PTO register.

BenefitService.addFSAReimbursement

Create a new flexible spending account reimbursement for an employee. Does not modify existing FSA reimbursements.

BenefitService.adjustBenefitAdjustmentCycles

Calculate benefit plan adjustments related to changes in the benefit adjustment cycle.

BenefitService.adjustPTO

Adjust employee PTO (as in the Employee PTO Register Adjustment form).

BenefitService.benefitEnrollmentStatus

Return web enrollment configuration details for a specified client.

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

BenefitService.createBenefitPlanSetup

Update client’s Benefit Plan Setup parameters for group benefit plans; this Allowed Method gives web service users access to both the createBenefitPlanSetup and updateBenefitPlanSetup methods in the Benefit service.

As of API 1.20, this method also supports setup of retirement, flex, employer match, and HSA plans.

BenefitService.deleteBenefitAdjustment

Delete a benefit adjustment associated with a specific reference number, employee, client, and checksum.

BenefitService.enrollBenefit

Enroll an employee in a benefit plan.

BenefitService.enrollPTORegister

Enroll an employee in a PTO register.

BenefitService.get401KMatchRules

Retrieve a client's 401(k) match rules.

BenefitService.getAbsenceJournal

Retrieve Employee absence information (PTO).

BenefitService.getACAOfferedEmployees

Retrieve information from the ACA Offered Employees form.

BenefitService.getActiveBenefitPlans

Retrieve Employee Benefits Enrollment information for active plans only

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

BenefitService.getActiveDependents

Retrieve Dependent information only for specified employees’ active dependents.

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

BenefitService.getActiveRetirementPlan

Retrieve Retirement Plan Enrollment information only for specified employees’ active plans.

BenefitService.getAvailableBenefitPlans

Retrieve available benefit plans for the specified employee, including status.

BenefitService.getBenefitAdjustments

Retrieve benefit adjustments for a specific employee.

BenefitService.getBenefitConfirmationData

Retrieve a JSON download of benefit confirmation data associated with a particular confirmation number. Use this method in conjunction with getBenefitConfirmationList.

BenefitService.getBenefitConfirmationList

Retrieve a list of benefit confirmation numbers and dates for a client and employee. Use this method in conjunction with getBenefitConfirmationData.

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

BenefitService.getBenefitGroupUserDefinedFields

Retrieve information about benefit group user-defined fields.

BenefitService.getBenefitPlanList

Retrieve a list of group benefit plan IDs, descriptions, and insurance class values.

BenefitService.getBenefitPlans

Retrieve Employee Benefits Enrollment information, including eligible plans or those that were waived or terminated.

BenefitService.getBenefitRule

Retrieve Benefit Rules information for specified clients.

BenefitService.getBenefitsEnrollmentTrace

Retrieve an employee's benefits enrollment workflow history.

BenefitService.getBenefitWorkflowGrid

Returns benefit enrollment workflow information from the Client Workflow Grid form.

BenefitService.getClientBenefitPlans

Retrieve all benefit plans available to a client, (regardless of their status).

BenefitService.getClientBenefitPlanSetupDetails

Retrieve benefit plan details for the specified client, plan, and plan classification.

BenefitService.getCobraCodes

Retrieve a list of qualifying events and termination reasons found in the Cobra processing parameters.

BenefitService.getCobraEmployee

Retrieve information about employees who are COBRA enrollees, such as enrollment process, qualifying events, and payments.

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

BenefitService.getDependent

Retrieve dependent information for a single specified employee, regardless of their status.

BenefitService.getDependents

Retrieve dependent information for specified employees, regardless of their status.

BenefitService.getDisabilityPlanEnrollmentDetails

Retrieve coverage amounts and other enrollment details for group benefit plans of Offer Type "STD" (short-term disability) or "LTD" (long-term disability").

BenefitService.getEligibleFlexSpendingPlans

Return a list of FSA and HSA plans for which the specified employee is eligible.

BenefitService.getEmployeePremium

Return information about employee benefit plan billing rates.

BenefitService.getEmployeeRetirementSummary

Retrieve the details of the retirement benefits for an employee.

BenefitService.getEnrollInputList

Retrieve the required elements to be able to enroll the employee in a plan.

BenefitService.getEnrollmentPlanDetails

Return benefit plan information from the carrier, including the deductible, copay, and visit type.

BenefitService.getFlexPlans

Retrieve Employee Flexible Spending Account enrollment information.

BenefitService.getFSAReimbursements

Retrieve data about FSA plan reimbursements for specific employees and clients.

BenefitService.getGroupBenefitPlan

Retrieve Group Benefit Plan details.

BenefitService.getGroupBenefitRates

Retrieve billing rates and premium rates for a specified benefit plan.

BenefitService.getGroupBenefitTypes

Retrieve group benefit plan type codes and the setup information associated with them, for use in your benefit plan setup process.

BenefitService.getLifeEventCodeDetails

Retrieve information about a client's life event codes, or a specified life event code.

BenefitService.getMonthlyACAInfo

Return calculations of monthly ACA data for an employee.

BenefitService.getPaidTimeOff

Retrieve Employee PTO Register information.

BenefitService.getPaidTimeOffPlans

Retrieve PTO Benefit Plans for specified clients.

BenefitService.getPlanYearInfo

Return information about retirement, HSA, and Section 125 benefit plan years.

BenefitService.getPtoAbsenceCodes

Retrieve PTO absence codes for a client. If an absenceCode is specified, one absence code is returned.

BenefitService.getPtoAutoEnrollRules

Retrieve information about PTO auto enroll rules.

BenefitService.getPtoClasses

Retrieve all PTO classes.

BenefitService.getPtoPlanDetails

Retrieve information about a single PTO benefit plan.

BenefitService.getPtoRegisterTypes

Return a list of PTO register types for a client.

BenefitService.getPtoRequestsList

Return a list of all employees' leave requests.

BenefitService.getRetirementLoans

Retrieve Employee Retirement Loans information.

BenefitService.getRetirementPlan

Retrieve Retirement Plan Enrollment information for specified employees, including eligible plans or those that were waived or made inactive.

BenefitService.getSection125Plans

Retrieve information about Section 125 plans or Health Savings Account (HSA) plans. Both plan types are associated with Flexible Spending Accounts (FSAs). This endpoint retrieves information about the FSAs associated with these plans.

This endpoint also supports pagination for cases where more than 5000 records exist.

BenefitService.import401KData

Upload 401K import data, performs validations against the data, and then writes the new data to PrismHR. The response identifies those lines in the import data that did not pass validation, with error messages for each line. Rows that do pass validation are imported even if some rows contain errors.

BenefitService.retirementCensusExport

Return a CSV report file containing employee census information, including information about retirement benefit plans.

BenefitService.set401KMatchRules

Create or updates 401(k) match rules. Use the checksum from BenefitService.get401kMatchDetails.

BenefitService.setACAOfferedEmployees

Add data to the ACA Offered Employees form.

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

BenefitService.setBenefitGroupUserDefinedFields

Create or update user-defined benefit group fields for a specified client.

BenefitService.setBenefitAdjustments

Create or update benefit adjustments for an employee.

BenefitService.setBenefitRule

Set Benefit Rules for client.

Now supports rule creation for medical, dental, vision, life insurance, and short/long-term disability plans.

BenefitService.setClientBenefitPlanSetupDetails

Updates benefit plan setup for a particular client.

In prismhr-api, this replaces createBenefitPlanSetup and updateBenefitPlanSetup.

BenefitService.setDependent

Create a new dependent.

BenefitService.setDisabilityPlanEnrollmentDetails

Update coverage amounts and other enrollment details for group benefit plans of Offer Type "STD" (short-term disability) or "LTD" (long-term disability").

BenefitSerivce.setEmployeePtoAccrual

Start or stops the accrual of PTO for an employee.

BenefitService.setEnrollmentPlanDetails

Update benefit plan information from the carrier, including deductibles, copay amounts, and visit types.

BenefitService.setFlexPlan

Enroll a single employee in a flexible spending plan.

BenefitService.setGroupBenefitBillingRates

Set or updates billing rate details for the specified group benefit plan.

BenefitService.setGroupBenefitPlanDetails

Create or updates group benefit plan settings. Use the checksum from BenefitService.getGroupBenefitPlanDetails.

BenefitService.setGroupBenefitPremiumRates

Create or updates group benefit premium rate details. To obtain the checksum for this method, call BenefitService.getGroupBenefitRates.

BenefitService.setPtoAbsenceCode

Create or updates a single PTO absence code.

BenefitService.setPtoAutoEnrollRules

Create or updates PTO auto enroll rules. To update an existing rule set, use the checksum from BenefitService.getPtoAutoEnrollRules.

BenefitService.setPtoClass

Create a PTO class.

BenefitService.setPtoPlanDetails

Create a new or updates an existing PTO Benefit Plan.

To obtain the checksum for this method, call the BenefitService.getPtoPlan method.

BenefitService.setPtoRegisterType

Create or update a single PTO register type.

BenefitService.setRetirementLoan

Create or update employee retirement loan.

BenefitService.submitLifeEvent

Enroll an employee in a life event workflow.

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

BenefitService.updateBenefitPlanSetup

To grant web service users access to this method in the API, enter the Allowed Method “BenefitService.createBenefitPlanSetup” (see above).

As of API 1.20, this method now supports setup of retirement, flex, employer match, and HSA plans.

BenefitService.updateRetirementPlanElection

Update employee’s election details for a retirement plan.

BenefitService.updateRetirementPlanEnroll

Update employee’s Retirement Plan Enrollment details.