API Reference

Create New Hire Enrollment

post
https://example.com/wep/companies//enrollment/newhire

Create New Hire Enrollment. \

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required

Company Id

Body Params

New Hire Enrollment Entity

BenEnrollmentCreateNH_v20 - to create New Hire Enrollment

int32
enum

Benefit Enrollment Ref Type.

Members:

  • 1 - Employee ( Employee. )
  • 2 - Onboarding ( Onboarding. )

Allowed:
int32 | null
required

Id of Employee or Onboarding.

int32
enum

Benefit Enrollment Email Type.

Members:

  • 0 - WorkEmail ( Work Email. )
  • 1 - PersonalEmail ( Personal Email. )
  • 2 - CustomEmail ( Custom Email. )

Allowed:
string | null

Email address, when EmailType is set to Custom Email.
Data type is validated and must be 10

string | null

Name of the enrollment. It will be visible in the list of enrollments.

date-time | null

Set a date when you want to send a Pre-Enrollment email. If left empty, Pre-Enrollment email will not be sent.
Data type is validated and must be Number

date-time | null
required

The date when communication to the employee is sent and enrollment starts.
Data type is validated and must be Number

string | null

Enter number of days before soft deadline (if exists, if not then hard deadline), when an email reminder should be sent to employee. You can specify multiple reminders by separating number of days by comma, e.g. 1,3,5.

date-time | null

This is the end date that appears on the employee communications. Changes can be made up to the hard end date.
Data type is validated and must be Number

date-time | null
required

This is the date after which the employees won’t be able to do changes and when the deductions are actually created for the employees if Turn Elections into Deductions is set to Yes.
Data type is validated and must be Number

boolean | null

If this is set to true, the process will automatically create employee's deductions from the elections once the hard deadline is passed. Default value is TRUE.

boolean | null

Select if you want to show how much employer contributes to each benefit generally per month. Default value is TRUE.

boolean | null

If this is set to true, the EE will have to sign the confirmation document before he can complete his side of the enrollment process. Default value is TRUE.

boolean | null

It this is set to true, so each Voluntary Benefits rule will have “# of Allowed Plans” set to 1, and the “# of Allowed Plans” for the entire “Voluntary Benefits” group will be their sum. Otherwise, it will be 99. Default value is FALSE.

Headers
string
required
Defaults to 2.0

The requested API version

string
Defaults to 2.0

The requested API version

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated about 11 hours ago

Language
Credentials
Bearer
jwt
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/json
text/plain

Updated about 11 hours ago