Subscriber Enrollments

Create SubEnrollment

Creates a new SubEnrollment

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
subscriberID
required
string

Subscriber ID

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
subscriber_ID
required
string [ 1 .. 9 ] characters

References Subscribers.Subscriber_ID value on the parent record.

group_ID
required
string [ 1 .. 20 ] characters

References the GroupContract.Group_ID value in the parent table.

division_ID
required
string [ 1 .. 20 ] characters

References the GroupContract.Division_ID value in the parent table.

group_Coverage_Start
required
string <date-time>

References the GroupContract.Coverage_Start value in the parent table.

start_Date
required
string <date-time>

Start date of Subenrollment coverage.

annual_Max
number or null <double>

Annual maximum for identified policy. [Informational Only]

date_Employed
string or null <date-time>

Start date of the Subscriber's employment.

eligibility_Date
string or null <date-time>

Date the Subscriber was eligible for coverage.

end_Date
string or null <date-time>

End date of Subenrollment coverage.

entry_Date
string <date-time>

Date when the record was first added to the system.

entry_User
string or null <= 50 characters

User that first added the record to the system.

lifetime_Max
number or null <double>

Lifetime maximum for indentified policy. [Informational Only]

original_Enrollment_Date
string or null <date-time>

Identifies the date the Enrollment began. This is useful if a new Group is added and insured Members have been covered under the Group Plan earlier than their start date with you.

paid_Through
string or null <date-time>

Date that the premiums have been paid through. This field will auto populate with the most recent closed invoice ‘Bill Thru’ date if 'Set Paid Thru' is set through the Control Panel. The 'Paid Thru Exceeded' Ex Code will be applied to Claims adjudicated with a service date beyond this date.

policy_Number
string or null <= 25 characters

Policy number issued from Insurer. [Informational Only]

term_Date
string or null <date-time>

Termination date of the Subscriber's employment.

update_Date
string <date-time>

Date when the record was last updated in the system.

update_User
string or null <= 50 characters

User that last updated the record in the system.

Responses
200

Success

401

Unauthorized

post/subscribers/{subscriberID}/enrollments
Request samples
{
  • "subscriber_ID": "string",
  • "group_ID": "string",
  • "division_ID": "string",
  • "group_Coverage_Start": "2019-08-24T14:15:22Z",
  • "start_Date": "2019-08-24T14:15:22Z",
  • "annual_Max": 0.1,
  • "date_Employed": "2019-08-24T14:15:22Z",
  • "eligibility_Date": "2019-08-24T14:15:22Z",
  • "end_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "lifetime_Max": 0.1,
  • "original_Enrollment_Date": "2019-08-24T14:15:22Z",
  • "paid_Through": "2019-08-24T14:15:22Z",
  • "policy_Number": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List SubEnrollment

Lists all SubEnrollment for the given subscriberID

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
subscriberID
required
string

Subscriber ID

query Parameters
page
integer <int32>
Default: 1

Page

pageSize
integer <int32>
Default: 100

Page Size

sortBy
string

Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., 'Property1:desc,Property2:asc,Property3:asc' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/subscribers/{subscriberID}/enrollments
Request samples 
Response samples 
No sample
Get SubEnrollment
Gets a SubEnrollment for the given subscriberID, groupID, divisionID, groupCoverageStart, and startDate


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
groupID
required
string
Group ID


 
divisionID
required
string
Division ID


 
groupCoverageStart
required
string <date-time> 
Group Coverage Start


 
startDate
required
string <date-time> 
Start Date


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/subscribers/{subscriberID}/enrollments/{groupID}/{divisionID}/{groupCoverageStart}/{startDate}
Request samples 
Response samples 
No sample
Update SubEnrollment
Updates a SubEnrollment with the given subscriberID, groupID, divisionID, groupCoverageStart, and startDate


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
groupID
required
string
Group ID


 
divisionID
required
string
Division ID


 
groupCoverageStart
required
string <date-time> 
Group Coverage Start


 
startDate
required
string <date-time> 
Start Date


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
subscriber_ID
required
string  [ 1 .. 9 ] characters 
References Subscribers.Subscriber_ID value on the parent record.


 
group_ID
required
string  [ 1 .. 20 ] characters 
References the GroupContract.Group_ID value in the parent table.


 
division_ID
required
string  [ 1 .. 20 ] characters 
References the GroupContract.Division_ID value in the parent table.


 
group_Coverage_Start
required
string <date-time> 
References the GroupContract.Coverage_Start value in the parent table.


 
start_Date
required
string <date-time> 
Start date of Subenrollment coverage.


 
annual_Max
number or null <double> 
Annual maximum for identified policy. [Informational Only]


 
date_Employed
string or null <date-time> 
Start date of the Subscriber's employment.


 
eligibility_Date
string or null <date-time> 
Date the Subscriber was eligible for coverage.


 
end_Date
string or null <date-time> 
End date of Subenrollment coverage.


 
entry_Date
string <date-time> 
Date when the record was first added to the system.


 
entry_User
string or null  <= 50 characters 
User that first added the record to the system.


 
lifetime_Max
number or null <double> 
Lifetime maximum for indentified policy. [Informational Only]


 
original_Enrollment_Date
string or null <date-time> 
Identifies the date the Enrollment began. This is useful if a new Group is added and insured Members have been covered under the Group Plan earlier than their start date with you.


 
paid_Through
string or null <date-time> 
Date that the premiums have been paid through. This field will auto populate with the most recent closed invoice ‘Bill Thru’ date if 'Set Paid Thru' is set through the Control Panel. The 'Paid Thru Exceeded' Ex Code will be applied to Claims adjudicated with a service date beyond this date.


 
policy_Number
string or null  <= 25 characters 
Policy number issued from Insurer. [Informational Only]


 
term_Date
string or null <date-time> 
Termination date of the Subscriber's employment.


 
update_Date
string <date-time> 
Date when the record was last updated in the system.


 
update_User
string or null  <= 50 characters 
User that last updated the record in the system.


 
Responses 
200
Success


401
Unauthorized


put/subscribers/{subscriberID}/enrollments/{groupID}/{divisionID}/{groupCoverageStart}/{startDate}
Request samples 
{
  • "subscriber_ID": "string",
  • "group_ID": "string",
  • "division_ID": "string",
  • "group_Coverage_Start": "2019-08-24T14:15:22Z",
  • "start_Date": "2019-08-24T14:15:22Z",
  • "annual_Max": 0.1,
  • "date_Employed": "2019-08-24T14:15:22Z",
  • "eligibility_Date": "2019-08-24T14:15:22Z",
  • "end_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "lifetime_Max": 0.1,
  • "original_Enrollment_Date": "2019-08-24T14:15:22Z",
  • "paid_Through": "2019-08-24T14:15:22Z",
  • "policy_Number": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete SubEnrollment
Deletes a SubEnrollment with the given subscriberID, groupID, divisionID, groupCoverageStart, and startDate


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
groupID
required
string
Group ID


 
divisionID
required
string
Division ID


 
groupCoverageStart
required
string <date-time> 
Group Coverage Start


 
startDate
required
string <date-time> 
Start Date


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/subscribers/{subscriberID}/enrollments/{groupID}/{divisionID}/{groupCoverageStart}/{startDate}
Request samples 
Modify SubEnrollment
Modify an existing Subenrollment changing the table keys which forces downstream table updates.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Original Subscriber ID


 
groupID
required
string
Original Group ID


 
divisionID
required
string
Original Division ID


 
groupCoverageStart
required
string <date-time> 
Original Group Coverage Start


 
startDate
required
string <date-time> 
Original Start Date


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
subscriber_ID
required
string  [ 1 .. 9 ] characters 
References Subscribers.Subscriber_ID value on the parent record.


 
group_ID
required
string  [ 1 .. 20 ] characters 
References the GroupContract.Group_ID value in the parent table.


 
division_ID
required
string  [ 1 .. 20 ] characters 
References the GroupContract.Division_ID value in the parent table.


 
group_Coverage_Start
required
string <date-time> 
References the GroupContract.Coverage_Start value in the parent table.


 
start_Date
required
string <date-time> 
Start date of Subenrollment coverage.


 
annual_Max
number or null <double> 
Annual maximum for identified policy. [Informational Only]


 
date_Employed
string or null <date-time> 
Start date of the Subscriber's employment.


 
eligibility_Date
string or null <date-time> 
Date the Subscriber was eligible for coverage.


 
end_Date
string or null <date-time> 
End date of Subenrollment coverage.


 
entry_Date
string <date-time> 
Date when the record was first added to the system.


 
entry_User
string or null  <= 50 characters 
User that first added the record to the system.


 
lifetime_Max
number or null <double> 
Lifetime maximum for indentified policy. [Informational Only]


 
original_Enrollment_Date
string or null <date-time> 
Identifies the date the Enrollment began. This is useful if a new Group is added and insured Members have been covered under the Group Plan earlier than their start date with you.


 
paid_Through
string or null <date-time> 
Date that the premiums have been paid through. This field will auto populate with the most recent closed invoice ‘Bill Thru’ date if 'Set Paid Thru' is set through the Control Panel. The 'Paid Thru Exceeded' Ex Code will be applied to Claims adjudicated with a service date beyond this date.


 
policy_Number
string or null  <= 25 characters 
Policy number issued from Insurer. [Informational Only]


 
term_Date
string or null <date-time> 
Termination date of the Subscriber's employment.


 
update_Date
string <date-time> 
Date when the record was last updated in the system.


 
update_User
string or null  <= 50 characters 
User that last updated the record in the system.


 
Responses 
200
Success


401
Unauthorized


put/subscribers/{subscriberID}/enrollments-modify/{groupID}/{divisionID}/{groupCoverageStart}/{startDate}
Request samples 
{
  • "subscriber_ID": "string",
  • "group_ID": "string",
  • "division_ID": "string",
  • "group_Coverage_Start": "2019-08-24T14:15:22Z",
  • "start_Date": "2019-08-24T14:15:22Z",
  • "annual_Max": 0.1,
  • "date_Employed": "2019-08-24T14:15:22Z",
  • "eligibility_Date": "2019-08-24T14:15:22Z",
  • "end_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "lifetime_Max": 0.1,
  • "original_Enrollment_Date": "2019-08-24T14:15:22Z",
  • "paid_Through": "2019-08-24T14:15:22Z",
  • "policy_Number": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Create or Update Batch SubEnrollment
Create or Update multiple SubEnrollment at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
subscriber_ID
required
string  [ 1 .. 9 ] characters 
References Subscribers.Subscriber_ID value on the parent record.


 
group_ID
required
string  [ 1 .. 20 ] characters 
References the GroupContract.Group_ID value in the parent table.


 
division_ID
required
string  [ 1 .. 20 ] characters 
References the GroupContract.Division_ID value in the parent table.


 
group_Coverage_Start
required
string <date-time> 
References the GroupContract.Coverage_Start value in the parent table.


 
start_Date
required
string <date-time> 
Start date of Subenrollment coverage.


 
annual_Max
number or null <double> 
Annual maximum for identified policy. [Informational Only]


 
date_Employed
string or null <date-time> 
Start date of the Subscriber's employment.


 
eligibility_Date
string or null <date-time> 
Date the Subscriber was eligible for coverage.


 
end_Date
string or null <date-time> 
End date of Subenrollment coverage.


 
entry_Date
string <date-time> 
Date when the record was first added to the system.


 
entry_User
string or null  <= 50 characters 
User that first added the record to the system.


 
lifetime_Max
number or null <double> 
Lifetime maximum for indentified policy. [Informational Only]


 
original_Enrollment_Date
string or null <date-time> 
Identifies the date the Enrollment began. This is useful if a new Group is added and insured Members have been covered under the Group Plan earlier than their start date with you.


 
paid_Through
string or null <date-time> 
Date that the premiums have been paid through. This field will auto populate with the most recent closed invoice ‘Bill Thru’ date if 'Set Paid Thru' is set through the Control Panel. The 'Paid Thru Exceeded' Ex Code will be applied to Claims adjudicated with a service date beyond this date.


 
policy_Number
string or null  <= 25 characters 
Policy number issued from Insurer. [Informational Only]


 
term_Date
string or null <date-time> 
Termination date of the Subscriber's employment.


 
update_Date
string <date-time> 
Date when the record was last updated in the system.


 
update_User
string or null  <= 50 characters 
User that last updated the record in the system.


 
Responses 
207
Success


401
Unauthorized


put/subscribers/{subscriberID}/enrollments-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}
Set SubEnrollment Paid Through
Sets the Paid Through value on the Subenrollment based on existing Premium Billing paid invoices.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
groupID
required
string
Group ID


 
divisionID
required
string
Division ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
202
Accepted


401
Unauthorized


post/subscribers/{subscriberID}/enrollments/{groupID}/{divisionID}/set-paid-through
Request samples