Group Contracts

Create GroupContract

Creates a new GroupContract

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
groupID
required
string

Group ID

divisionID
required
string

Division ID

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
group_ID
required
string [ 1 .. 20 ] characters

References GroupDivision.Group_ID value on the parent record.

division_ID
required
string [ 1 .. 20 ] characters

References GroupDivision.Division_ID value on the parent record.

coverage_Start
required
string <date-time>

Date when the contract becomes/became effective. Note: This field is marked as NOT NULL in the database and therefore required by the API.

adult_Age
integer or null <int32>

Identifies the age at which dependents are considered to be adults. Student status information is required on the enrollment to allow claims to pay for a dependent whose age exceeds the age defined here.

advice_To_Pay
required
boolean

When this option is selected, adjudication to mark every claim as 'Advice to Pay' (ATP). Advice to Pay claims do not produce check records when processed. Note: This field is marked as NOT NULL in the database and therefore required by the API.

allow_Multi_Plan
string or null <= 1 characters

No longer in use.

benefit_At_Member
required
string = 1 characters

Indicates that the Group offers Member-level benfits. This means that the insured and dependents can enroll in separate coverage.

billing_Basis
string or null <= 1 characters

No longer in use.

billing_Cycle_ID
string or null <= 2 characters

No longer in use.

comm_Pct_Flag
required
boolean

No longer in use. Note: This field is marked as NOT NULL in the database and therefore required by the API.

comm_Per
string or null <= 1 characters

No longer in use.

commission
number or null <double>

No longer in use.

coverage_End
string or null <date-time>

Date when the contract expires/expired.

cutoff_Age
integer or null <int32>

Identifies the age at which dependents are no longer eligible for coverage. Adult Dependent information is required on the enrollment to allow claims to pay for a dependent whose age exceeds the age defined here.

entry_Date
string <date-time>

User that first added the record to the system.

entry_User
string or null <= 20 characters

Date when the record was first added to the system.

last_Billed
string or null <date-time>

No longer in use.

max_At_Subscriber
required
string = 1 characters

Disability setting for Subscriber-level maximums.

orig_Coverage_End
string or null <date-time>

No longer in use.

paid_Through
string or null <date-time>

Premium Billing setting that holds the premiums paid through for a selection of contracted subscribers.

payor_ID
string or null <= 20 characters

No longer in use.

policy_Number
string or null <= 32 characters

No longer in use.

reinsurer_Id
string or null <= 8 characters

No longer in use.

rider_At_Member
required
string = 1 characters

Indicates that the Group offers Member-level Riders.

salaried_Benefit
required
boolean

For Life & Disability clients, this designates that the subscribers on this contract as having salaried benefit. This impacts how STD and LTD claims are generated during claim creation. Note: This field is marked as NOT NULL in the database and therefore required by the API.

stop_Loss_Amt
number or null <double>

No longer in use.

total_At_Member
required
string = 1 characters

Disability setting for totals calculating at the Member level.

update_Date
string <date-time>

User that last updated the record in the system.

update_User
string or null <= 20 characters

Date when the record was last updated in the system.

Responses
200

Success

401

Unauthorized

post/groups/{groupID}/divisions/{divisionID}/contracts
Request samples
{
  • "group_ID": "string",
  • "division_ID": "string",
  • "coverage_Start": "2019-08-24T14:15:22Z",
  • "adult_Age": 0,
  • "advice_To_Pay": true,
  • "allow_Multi_Plan": "s",
  • "benefit_At_Member": "s",
  • "billing_Basis": "s",
  • "billing_Cycle_ID": "st",
  • "comm_Pct_Flag": true,
  • "comm_Per": "s",
  • "commission": 0.1,
  • "coverage_End": "2019-08-24T14:15:22Z",
  • "cutoff_Age": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "last_Billed": "2019-08-24T14:15:22Z",
  • "max_At_Subscriber": "s",
  • "orig_Coverage_End": "2019-08-24T14:15:22Z",
  • "paid_Through": "2019-08-24T14:15:22Z",
  • "payor_ID": "string",
  • "policy_Number": "string",
  • "reinsurer_Id": "string",
  • "rider_At_Member": "s",
  • "salaried_Benefit": true,
  • "stop_Loss_Amt": 0.1,
  • "total_At_Member": "s",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List GroupContract

Lists all GroupContract for the given groupID and divisionID

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
groupID
required
string

Group ID

divisionID
required
string

Division 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/groups/{groupID}/divisions/{divisionID}/contracts
Request samples 
Response samples 
No sample
Add Next GroupContract Advanced API 
Adds the next GroupContract, starting the day after that existing contract. A VBAProcess object is returned representing the process state. See VBAProcess area for more information.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
divisionID
required
string
Division ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
object (GroupContract) 
 
reenroll
boolean
 
reenrollPlan
boolean
 
reenrollRider
boolean
 
copyPlan
boolean
 
copyNetwork
boolean
 
copyTier
boolean
 
copyRider
boolean
 
reenrollRiderIDCode
boolean
 
copyPlanIDCode
boolean
 
copyNetworkIDCode
boolean
 
user_ID
string or null
 
Array of objects or null (PlanMapping) 
 
Responses 
200
Success


401
Unauthorized


post/groups/{groupID}/divisions/{divisionID}/add-contract
Request samples 
{
  • "contract": {
    },
  • "reenroll": true,
  • "reenrollPlan": true,
  • "reenrollRider": true,
  • "copyPlan": true,
  • "copyNetwork": true,
  • "copyTier": true,
  • "copyRider": true,
  • "reenrollRiderIDCode": true,
  • "copyPlanIDCode": true,
  • "copyNetworkIDCode": true,
  • "user_ID": "string",
  • "planMappings": [
    ]
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Set GroupContract Coverage End Advanced API 
Changes the Coverage End for a contract. A VBAProcess object is returned representing the process state. See VBAProcess area for more information.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
divisionID
required
string
Division ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
group_ID
required
string  [ 1 .. 20 ] characters 
References GroupDivision.Group_ID value on the parent record.


 
division_ID
required
string  [ 1 .. 20 ] characters 
References GroupDivision.Division_ID value on the parent record.


 
coverage_Start
required
string <date-time> 
Date when the contract becomes/became effective. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
adult_Age
integer or null <int32> 
Identifies the age at which dependents are considered to be adults. Student status information is required on the enrollment to allow claims to pay for a dependent whose age exceeds the age defined here.


 
advice_To_Pay
required
boolean
When this option is selected, adjudication to mark every claim as 'Advice to Pay' (ATP). Advice to Pay claims do not produce check records when processed. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
allow_Multi_Plan
string or null  <= 1 characters 
No longer in use.


 
benefit_At_Member
required
string  = 1 characters 
Indicates that the Group offers Member-level benfits. This means that the insured and dependents can enroll in separate coverage.


 
billing_Basis
string or null  <= 1 characters 
No longer in use.


 
billing_Cycle_ID
string or null  <= 2 characters 
No longer in use.


 
comm_Pct_Flag
required
boolean
No longer in use. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
comm_Per
string or null  <= 1 characters 
No longer in use.


 
commission
number or null <double> 
No longer in use.


 
coverage_End
string or null <date-time> 
Date when the contract expires/expired.


 
cutoff_Age
integer or null <int32> 
Identifies the age at which dependents are no longer eligible for coverage. Adult Dependent information is required on the enrollment to allow claims to pay for a dependent whose age exceeds the age defined here.


 
entry_Date
string <date-time> 
User that first added the record to the system.


 
entry_User
string or null  <= 20 characters 
Date when the record was first added to the system.


 
last_Billed
string or null <date-time> 
No longer in use.


 
max_At_Subscriber
required
string  = 1 characters 
Disability setting for Subscriber-level maximums.


 
orig_Coverage_End
string or null <date-time> 
No longer in use.


 
paid_Through
string or null <date-time> 
Premium Billing setting that holds the premiums paid through for a selection of contracted subscribers.


 
payor_ID
string or null  <= 20 characters 
No longer in use.


 
policy_Number
string or null  <= 32 characters 
No longer in use.


 
reinsurer_Id
string or null  <= 8 characters 
No longer in use.


 
rider_At_Member
required
string  = 1 characters 
Indicates that the Group offers Member-level Riders.


 
salaried_Benefit
required
boolean
For Life & Disability clients, this designates that the subscribers on this contract as having salaried benefit. This impacts how STD and LTD claims are generated during claim creation. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
stop_Loss_Amt
number or null <double> 
No longer in use.


 
total_At_Member
required
string  = 1 characters 
Disability setting for totals calculating at the Member level.


 
update_Date
string <date-time> 
User that last updated the record in the system.


 
update_User
string or null  <= 20 characters 
Date when the record was last updated in the system.


 
Responses 
200
Success


401
Unauthorized


post/groups/{groupID}/divisions/{divisionID}/set-coverage
Request samples 
{
  • "group_ID": "string",
  • "division_ID": "string",
  • "coverage_Start": "2019-08-24T14:15:22Z",
  • "adult_Age": 0,
  • "advice_To_Pay": true,
  • "allow_Multi_Plan": "s",
  • "benefit_At_Member": "s",
  • "billing_Basis": "s",
  • "billing_Cycle_ID": "st",
  • "comm_Pct_Flag": true,
  • "comm_Per": "s",
  • "commission": 0.1,
  • "coverage_End": "2019-08-24T14:15:22Z",
  • "cutoff_Age": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "last_Billed": "2019-08-24T14:15:22Z",
  • "max_At_Subscriber": "s",
  • "orig_Coverage_End": "2019-08-24T14:15:22Z",
  • "paid_Through": "2019-08-24T14:15:22Z",
  • "payor_ID": "string",
  • "policy_Number": "string",
  • "reinsurer_Id": "string",
  • "rider_At_Member": "s",
  • "salaried_Benefit": true,
  • "stop_Loss_Amt": 0.1,
  • "total_At_Member": "s",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Change GroupContract Coverage Start Advanced API 
Changes the Coverage Start for a contract. A VBAProcess object is returned representing the process state. See VBAProcess area for more information.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
divisionID
required
string
Division ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
object (GroupContract) 
 
new_Coverage_Start
string <date-time> 
 
user_ID
string or null
 
disable_Enrollment_Update
boolean
 
Responses 
200
Success


401
Unauthorized


post/groups/{groupID}/divisions/{divisionID}/change-coverage-start
Request samples 
{
  • "contract": {
    },
  • "new_Coverage_Start": "2019-08-24T14:15:22Z",
  • "user_ID": "string",
  • "disable_Enrollment_Update": true
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
List VBA_GroupContract
Lists all VBA_GroupContract for the given groupID and divisionID


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
divisionID
required
string
Division ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/groups/{groupID}/divisions/{divisionID}/vba-contracts
Request samples 
Response samples 
No sample
Get GroupContract
Gets GroupContract


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
divisionID
required
string
Division ID


 
coverageStart
required
string <date-time> 
Coverage Start


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/groups/{groupID}/divisions/{divisionID}/contracts/{coverageStart}
Request samples 
Response samples 
No sample
Update GroupContract
Updates a specific GroupContract.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
divisionID
required
string
Division ID


 
coverageStart
required
string <date-time> 
Coverage Start


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
group_ID
required
string  [ 1 .. 20 ] characters 
References GroupDivision.Group_ID value on the parent record.


 
division_ID
required
string  [ 1 .. 20 ] characters 
References GroupDivision.Division_ID value on the parent record.


 
coverage_Start
required
string <date-time> 
Date when the contract becomes/became effective. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
adult_Age
integer or null <int32> 
Identifies the age at which dependents are considered to be adults. Student status information is required on the enrollment to allow claims to pay for a dependent whose age exceeds the age defined here.


 
advice_To_Pay
required
boolean
When this option is selected, adjudication to mark every claim as 'Advice to Pay' (ATP). Advice to Pay claims do not produce check records when processed. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
allow_Multi_Plan
string or null  <= 1 characters 
No longer in use.


 
benefit_At_Member
required
string  = 1 characters 
Indicates that the Group offers Member-level benfits. This means that the insured and dependents can enroll in separate coverage.


 
billing_Basis
string or null  <= 1 characters 
No longer in use.


 
billing_Cycle_ID
string or null  <= 2 characters 
No longer in use.


 
comm_Pct_Flag
required
boolean
No longer in use. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
comm_Per
string or null  <= 1 characters 
No longer in use.


 
commission
number or null <double> 
No longer in use.


 
coverage_End
string or null <date-time> 
Date when the contract expires/expired.


 
cutoff_Age
integer or null <int32> 
Identifies the age at which dependents are no longer eligible for coverage. Adult Dependent information is required on the enrollment to allow claims to pay for a dependent whose age exceeds the age defined here.


 
entry_Date
string <date-time> 
User that first added the record to the system.


 
entry_User
string or null  <= 20 characters 
Date when the record was first added to the system.


 
last_Billed
string or null <date-time> 
No longer in use.


 
max_At_Subscriber
required
string  = 1 characters 
Disability setting for Subscriber-level maximums.


 
orig_Coverage_End
string or null <date-time> 
No longer in use.


 
paid_Through
string or null <date-time> 
Premium Billing setting that holds the premiums paid through for a selection of contracted subscribers.


 
payor_ID
string or null  <= 20 characters 
No longer in use.


 
policy_Number
string or null  <= 32 characters 
No longer in use.


 
reinsurer_Id
string or null  <= 8 characters 
No longer in use.


 
rider_At_Member
required
string  = 1 characters 
Indicates that the Group offers Member-level Riders.


 
salaried_Benefit
required
boolean
For Life & Disability clients, this designates that the subscribers on this contract as having salaried benefit. This impacts how STD and LTD claims are generated during claim creation. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
stop_Loss_Amt
number or null <double> 
No longer in use.


 
total_At_Member
required
string  = 1 characters 
Disability setting for totals calculating at the Member level.


 
update_Date
string <date-time> 
User that last updated the record in the system.


 
update_User
string or null  <= 20 characters 
Date when the record was last updated in the system.


 
Responses 
200
Success


401
Unauthorized


put/groups/{groupID}/divisions/{divisionID}/contracts/{coverageStart}
Request samples 
{
  • "group_ID": "string",
  • "division_ID": "string",
  • "coverage_Start": "2019-08-24T14:15:22Z",
  • "adult_Age": 0,
  • "advice_To_Pay": true,
  • "allow_Multi_Plan": "s",
  • "benefit_At_Member": "s",
  • "billing_Basis": "s",
  • "billing_Cycle_ID": "st",
  • "comm_Pct_Flag": true,
  • "comm_Per": "s",
  • "commission": 0.1,
  • "coverage_End": "2019-08-24T14:15:22Z",
  • "cutoff_Age": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "last_Billed": "2019-08-24T14:15:22Z",
  • "max_At_Subscriber": "s",
  • "orig_Coverage_End": "2019-08-24T14:15:22Z",
  • "paid_Through": "2019-08-24T14:15:22Z",
  • "payor_ID": "string",
  • "policy_Number": "string",
  • "reinsurer_Id": "string",
  • "rider_At_Member": "s",
  • "salaried_Benefit": true,
  • "stop_Loss_Amt": 0.1,
  • "total_At_Member": "s",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete GroupContract
Deletes an GroupContract


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
divisionID
required
string
Division ID


 
coverageStart
required
string <date-time> 
Coverage Start


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/groups/{groupID}/divisions/{divisionID}/contracts/{coverageStart}
Request samples 
Create or Update Batch GroupContract
Create or Update multiple GroupContract 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
groupID
required
string
Group ID


 
divisionID
required
string
Division ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
group_ID
required
string  [ 1 .. 20 ] characters 
References GroupDivision.Group_ID value on the parent record.


 
division_ID
required
string  [ 1 .. 20 ] characters 
References GroupDivision.Division_ID value on the parent record.


 
coverage_Start
required
string <date-time> 
Date when the contract becomes/became effective. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
adult_Age
integer or null <int32> 
Identifies the age at which dependents are considered to be adults. Student status information is required on the enrollment to allow claims to pay for a dependent whose age exceeds the age defined here.


 
advice_To_Pay
required
boolean
When this option is selected, adjudication to mark every claim as 'Advice to Pay' (ATP). Advice to Pay claims do not produce check records when processed. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
allow_Multi_Plan
string or null  <= 1 characters 
No longer in use.


 
benefit_At_Member
required
string  = 1 characters 
Indicates that the Group offers Member-level benfits. This means that the insured and dependents can enroll in separate coverage.


 
billing_Basis
string or null  <= 1 characters 
No longer in use.


 
billing_Cycle_ID
string or null  <= 2 characters 
No longer in use.


 
comm_Pct_Flag
required
boolean
No longer in use. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
comm_Per
string or null  <= 1 characters 
No longer in use.


 
commission
number or null <double> 
No longer in use.


 
coverage_End
string or null <date-time> 
Date when the contract expires/expired.


 
cutoff_Age
integer or null <int32> 
Identifies the age at which dependents are no longer eligible for coverage. Adult Dependent information is required on the enrollment to allow claims to pay for a dependent whose age exceeds the age defined here.


 
entry_Date
string <date-time> 
User that first added the record to the system.


 
entry_User
string or null  <= 20 characters 
Date when the record was first added to the system.


 
last_Billed
string or null <date-time> 
No longer in use.


 
max_At_Subscriber
required
string  = 1 characters 
Disability setting for Subscriber-level maximums.


 
orig_Coverage_End
string or null <date-time> 
No longer in use.


 
paid_Through
string or null <date-time> 
Premium Billing setting that holds the premiums paid through for a selection of contracted subscribers.


 
payor_ID
string or null  <= 20 characters 
No longer in use.


 
policy_Number
string or null  <= 32 characters 
No longer in use.


 
reinsurer_Id
string or null  <= 8 characters 
No longer in use.


 
rider_At_Member
required
string  = 1 characters 
Indicates that the Group offers Member-level Riders.


 
salaried_Benefit
required
boolean
For Life & Disability clients, this designates that the subscribers on this contract as having salaried benefit. This impacts how STD and LTD claims are generated during claim creation. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
stop_Loss_Amt
number or null <double> 
No longer in use.


 
total_At_Member
required
string  = 1 characters 
Disability setting for totals calculating at the Member level.


 
update_Date
string <date-time> 
User that last updated the record in the system.


 
update_User
string or null  <= 20 characters 
Date when the record was last updated in the system.


 
Responses 
207
Success


401
Unauthorized


put/groups/{groupID}/divisions/{divisionID}/contracts-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}