Groups

Create Groups

Creates a new Groups

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

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

Unique identifier for each Group.

account_Key
integer or null <int32>

Identifies the Account associated with this Group.

account_Manager
string or null <= 128 characters

Information field used in custom client reporting.

addOn_Rate_Option
string or null <= 8 characters

Determines whether a Group's AddOn Rates are combined and applied once (Additive) or applies rates separately, in a sequence (Sequential).

address
string or null <= 255 characters

Adderss of the Group.

address2
string or null <= 128 characters

Line 2 of the Group's address.

admin_COBRA
required
boolean

Indicates if this Group administers COBRA. 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

Notes if the claims for this Group should be Advice_To_Pay (flagged as unpaid when processed). Note: This field is marked as NOT NULL in the database and therefore required by the API.

apply_Ex_Code
required
boolean

Flag if adjudication should apply an Ex Code to a claim for this Group. Note: This field is marked as NOT NULL in the database and therefore required by the API.

auth_Not_Reqd_Override
required
boolean

Notes if this group allows Auth Required claims edit to be overridden and paid. Note: This field is marked as NOT NULL in the database and therefore required by the API.

billing_Age_Calc
string or null <= 1 characters

No longer in use. Replaced by Premium Billing module.

billing_Cycle_ID
string or null <= 2 characters

Identifies the bill cycle for this Group. This will be used when creating invoices.

billing_Due_Date_Range
integer or null <int32>

Used when Set_Billing_Due_Date is enabled.

billing_Due_Date_Range_Type
string or null <= 16 characters

Used when Set_Billing_Due_Date is enabled.

billing_Due_Date_Type
string or null <= 32 characters

Used when Set_Billing_Due_Date is enabled.

billing_Invoice_Create
integer or null <int32>

Indicates the group is included in invoice generation processes.

billing_Retro_Limit
integer or null <int32>

Indicates how many bills (based on billing cycles) should be interrogated to determine adjustments.

caseRate
number or null <double>

No longer in use.

check_Birthday
string or null <= 1 characters

Identifies whether date of birth edits are performed for this Group during adjudication.

city
string or null <= 25 characters

City of the Group's address.

claim_Days_Allowed
integer or null <int32>

No longer in use.

coPay_Max_Per_Date_Provider
required
boolean

Notes that this group calculates copay max (based on plan configuration) by provider rather than across the entire plan. Note: This field is marked as NOT NULL in the database and therefore required by the API.

commission_Lookback
integer or null <int32>

Notes the number of billing cycles to lookback when calculating commissions.

contact_Country_Code
string or null <= 8 characters

Country code of the Group's contact number.

contact_Email_Address
string or null <= 128 characters

Email address of the identified Group contact.

contact_Extension
string or null <= 6 characters

Extension number of the Group's contact.

contact_Phone
string or null <= 20 characters

Phone number of the Group's contact.

contact_Title
string or null <= 20 characters

Title of the Group's primary contact.

country_ID
string or null <= 8 characters

Identifier of the Groups's country.

county_Code
string or null <= 8 characters

County code of the Group address.

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.

default_EOB_Report
integer or null <int32>

Defines the default EOB report object from our core admin system. This is a developer setting.

default_Invoice_ReportDefinition_Key
integer or null <int32>

By default, indicates which Invoice report should be used for automation.

default_Process_by_Disability_Date
required
boolean

Process by Disability Date can be defined here to apply to all claims for this group rather than on a claim by claim basis (acts as a default). Note: This field is marked as NOT NULL in the database and therefore required by the API.

default_Roll_Up_Waiting_Period
required
boolean

Roll Up Waiting Period can be defined here to apply to all claims for this group rather than on a claim by claim basis (acts as a default). Note: This field is marked as NOT NULL in the database and therefore required by the API.

disability_Pay_Through_Day
integer or null <int32>

The day of the week that Paid Through is calculated for Disability premiums.

disable_COBRA_Auto_Select
required
boolean

This flag indicates that the Group COBRA premium will not be automatically populated during member disenrollment. Note: This field is marked as NOT NULL in the database and therefore required by the API.

disenroll_Date
string or null <date-time>

Date when the Group expires/expired.

distribution_Account_Key
integer or null <int32>

For Premium Distribution processing, this notes the Account for the source of distributed funds.

distribution_Payor_ID
string or null <= 20 characters

For Premium Distribution processing, this notes the Payor ID for the source of distributed funds.

duplicate_Claim_Override
required
boolean

Notes if this group allows Duplicate Claims to be overridden to be paid. Note: This field is marked as NOT NULL in the database and therefore required by the API.

election_Range
integer or null <int32>

Used for determining Flex Election.

election_Range_Type
string or null <= 16 characters

Used with Election_Range to determine the Flex Election.

employer_Size
string or null <= 8 characters

Information field used in custom client reporting.

entry_Date
string <date-time>

Date when the record was first added to the system.

entry_User
string or null <= 20 characters

User that first added the record to the system.

ex_Code
string or null <= 6 characters

The Ex Code applied during claims adjudication if "Apply_Ex_Code" is enabled.

fax
string or null <= 20 characters

Fax number of the Group.

fax_Country_Code
string or null <= 8 characters

Country code of the Group's fax number.

federal_ID
string or null <= 20 characters

Federal tax identifier of the Group.

generate_Adjustments
string or null <= 1 characters

No longer in use. Replaced by Premium Billing module.

generate_Invoices
string or null <= 1 characters

No longer in use. Replaced by Premium Billing module.

group_Account
integer or null <int32>

Holds the account reference for the Employer Account. Not used in processing.

individual_Billing
required
boolean

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

individual_Cycle
required
boolean

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

individual_Dates
required
boolean

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

inv_Grace_Period
integer or null <int32>

The grace period value based on "Grace_Period_Type" for how long you have to process an invoice after the term date.

inv_Grace_Period_Type
string or null <= 1 characters

Works with Grace_Period to determine how long after term date an invoice can be processed.

invoice_Enrolled_By
integer or null <int32>

Used to determine eligiblity during invoice generation for enrolled members.

invoice_Enrolled_Thru
integer or null <int32>

Used to determine eligiblity during invoice generation for enrolled members.

issue_State
string or null <= 2 characters

Identifies the sate in which the Group is insured.

name
string or null <= 50 characters

Name of the Group.

notes
string or null

No longer in use, replaced by Notes Service.

open_Closed_Enrollment
required
boolean

Information field used in custom client reporting. Note: This field is marked as NOT NULL in the database and therefore required by the API.

original_Date
string or null <date-time>

Date when the Group becomes/became active.

paid_Through
string or null <date-time>

Date through which the Group premium has been paid.

paperless
required
boolean

Notes if this Group is Paperless (this overrides the individual member settings from VBAGateway). Used in process automation. Note: This field is marked as NOT NULL in the database and therefore required by the API.

pay_To_Account
integer or null <int32>

The Pay To Account used for external payments.

payor_ID
string or null <= 20 characters

Identifier of the Payor associated with the Group.

phone
string or null <= 20 characters

Phone number of the Group.

phone_Country_Code
string or null <= 8 characters

Country code of the Group's phone number.

prepaid_Group
required
boolean

Information field used in custom client reporting. Note: This field is marked as NOT NULL in the database and therefore required by the API.

primary_Contact
string or null <= 25 characters

Primary contact of the Group.

producer
string or null <= 128 characters

Information field used in custom client reporting.

prorate_Deduction
required
boolean

Notes if the disability deductions should be prorated during adjudication. Note: This field is marked as NOT NULL in the database and therefore required by the API.

prorate_Deduction_Type
string or null <= 10 characters

For Disability, notes the Deduction Type to have prorate applied.

rX_BIN
string or null <= 64 characters

Information field used in custom client reporting.

rX_CS_Contact
string or null <= 128 characters

Information field used in custom client reporting.

rX_CS_Phone
string or null <= 32 characters

Information field used in custom client reporting.

rX_GRP
string or null <= 64 characters

Information field used in custom client reporting.

rX_Name
string or null <= 512 characters

Information field used in custom client reporting.

rX_PCN
string or null <= 64 characters

Information field used in custom client reporting.

reason_ID
integer or null <int32>

No longer in use.

region_Code
string or null <= 32 characters

Region Code for this group (locality).

renewal_Completion_Date
string or null <date-time>

Information field used in custom client reporting.

renewal_Date
string or null <date-time>

The last renewal date for this Group. Used in custom reporting. Not used in processing.

self_Admin
required
boolean

Notes if this group has Self-Admin billing. Note: This field is marked as NOT NULL in the database and therefore required by the API.

set_Billing_Due_Date
required
boolean

Indicates if the system should calculate the Due Date on an invoice based on Billing_Due_Date settings. By default the due date is the "Bill Thru" on an invoice, this gives the option to change that calculation. Note: This field is marked as NOT NULL in the database and therefore required by the API.

state
string or null <= 2 characters

State of the Group's address.

subscriber_ID_Prefix
string or null <= 3 characters

The automatically applied Subscriber ID prefix when using auto generated IDs.

subscriber_ID_Suffix
string or null <= 3 characters

The automatically applied Subscriber ID suffix when using auto generated IDs.

total_Employees
integer or null <int32>

Information field used in custom client reporting.

uC_Percent
string or null <= 8 characters

Identifies the Usual and Customary percentage of the Group.

update_Date
string <date-time>

Date when the record was last updated in the system.

update_User
string or null <= 20 characters

User that last updated the record in the system.

use_Employer_State
boolean or null

Notes if Employe State, not Subscriber State, should be used in invoice generation. Note: The database will apply a default value of False for this field if a value is not provided.

zip_Code
string or null <= 32 characters

Zip code of the Group's address.

Responses
200

Success

401

Unauthorized

post/groups
Request samples
{
  • "group_ID": "string",
  • "account_Key": 0,
  • "account_Manager": "string",
  • "addOn_Rate_Option": "string",
  • "address": "string",
  • "address2": "string",
  • "admin_COBRA": true,
  • "adult_Age": 0,
  • "advice_To_Pay": true,
  • "apply_Ex_Code": true,
  • "auth_Not_Reqd_Override": true,
  • "billing_Age_Calc": "s",
  • "billing_Cycle_ID": "st",
  • "billing_Due_Date_Range": 0,
  • "billing_Due_Date_Range_Type": "string",
  • "billing_Due_Date_Type": "string",
  • "billing_Invoice_Create": 0,
  • "billing_Retro_Limit": 0,
  • "caseRate": 0.1,
  • "check_Birthday": "s",
  • "city": "string",
  • "claim_Days_Allowed": 0,
  • "coPay_Max_Per_Date_Provider": true,
  • "commission_Lookback": 0,
  • "contact_Country_Code": "string",
  • "contact_Email_Address": "string",
  • "contact_Extension": "string",
  • "contact_Phone": "string",
  • "contact_Title": "string",
  • "country_ID": "string",
  • "county_Code": "string",
  • "cutoff_Age": 0,
  • "default_EOB_Report": 0,
  • "default_Invoice_ReportDefinition_Key": 0,
  • "default_Process_by_Disability_Date": true,
  • "default_Roll_Up_Waiting_Period": true,
  • "disability_Pay_Through_Day": 0,
  • "disable_COBRA_Auto_Select": true,
  • "disenroll_Date": "2019-08-24T14:15:22Z",
  • "distribution_Account_Key": 0,
  • "distribution_Payor_ID": "string",
  • "duplicate_Claim_Override": true,
  • "election_Range": 0,
  • "election_Range_Type": "string",
  • "employer_Size": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "ex_Code": "string",
  • "fax": "string",
  • "fax_Country_Code": "string",
  • "federal_ID": "string",
  • "generate_Adjustments": "s",
  • "generate_Invoices": "s",
  • "group_Account": 0,
  • "individual_Billing": true,
  • "individual_Cycle": true,
  • "individual_Dates": true,
  • "inv_Grace_Period": 0,
  • "inv_Grace_Period_Type": "s",
  • "invoice_Enrolled_By": 0,
  • "invoice_Enrolled_Thru": 0,
  • "issue_State": "st",
  • "name": "string",
  • "notes": "string",
  • "open_Closed_Enrollment": true,
  • "original_Date": "2019-08-24T14:15:22Z",
  • "paid_Through": "2019-08-24T14:15:22Z",
  • "paperless": true,
  • "pay_To_Account": 0,
  • "payor_ID": "string",
  • "phone": "string",
  • "phone_Country_Code": "string",
  • "prepaid_Group": true,
  • "primary_Contact": "string",
  • "producer": "string",
  • "prorate_Deduction": true,
  • "prorate_Deduction_Type": "string",
  • "rX_BIN": "string",
  • "rX_CS_Contact": "string",
  • "rX_CS_Phone": "string",
  • "rX_GRP": "string",
  • "rX_Name": "string",
  • "rX_PCN": "string",
  • "reason_ID": 0,
  • "region_Code": "string",
  • "renewal_Completion_Date": "2019-08-24T14:15:22Z",
  • "renewal_Date": "2019-08-24T14:15:22Z",
  • "self_Admin": true,
  • "set_Billing_Due_Date": true,
  • "state": "st",
  • "subscriber_ID_Prefix": "str",
  • "subscriber_ID_Suffix": "str",
  • "total_Employees": 0,
  • "uC_Percent": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "use_Employer_State": true,
  • "zip_Code": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List Groups

Lists all Groups

SecurityapiKeyAuth and bearerAuth
Request
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
Request samples 
Response samples 
No sample
Get Groups
Gets Groups


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/groups/{groupID}
Request samples 
Response samples 
No sample
Update Groups
Updates a specific Groups.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
group_ID
required
string  [ 1 .. 20 ] characters 
Unique identifier for each Group.


 
account_Key
integer or null <int32> 
Identifies the Account associated with this Group.


 
account_Manager
string or null  <= 128 characters 
Information field used in custom client reporting.


 
addOn_Rate_Option
string or null  <= 8 characters 
Determines whether a Group's AddOn Rates are combined and applied once (Additive) or applies rates separately, in a sequence (Sequential).


 
address
string or null  <= 255 characters 
Adderss of the Group.


 
address2
string or null  <= 128 characters 
Line 2 of the Group's address.


 
admin_COBRA
required
boolean
Indicates if this Group administers COBRA. 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
Notes if the claims for this Group should be Advice_To_Pay (flagged as unpaid when processed). Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
apply_Ex_Code
required
boolean
Flag if adjudication should apply an Ex Code to a claim for this Group. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
auth_Not_Reqd_Override
required
boolean
Notes if this group allows Auth Required claims edit to be overridden and paid. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
billing_Age_Calc
string or null  <= 1 characters 
No longer in use. Replaced by Premium Billing module.


 
billing_Cycle_ID
string or null  <= 2 characters 
Identifies the bill cycle for this Group. This will be used when creating invoices.


 
billing_Due_Date_Range
integer or null <int32> 
Used when Set_Billing_Due_Date is enabled.


 
billing_Due_Date_Range_Type
string or null  <= 16 characters 
Used when Set_Billing_Due_Date is enabled.


 
billing_Due_Date_Type
string or null  <= 32 characters 
Used when Set_Billing_Due_Date is enabled.


 
billing_Invoice_Create
integer or null <int32> 
Indicates the group is included in invoice generation processes.


 
billing_Retro_Limit
integer or null <int32> 
Indicates how many bills (based on billing cycles) should be interrogated to determine adjustments.


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


 
check_Birthday
string or null  <= 1 characters 
Identifies whether date of birth edits are performed for this Group during adjudication.


 
city
string or null  <= 25 characters 
City of the Group's address.


 
claim_Days_Allowed
integer or null <int32> 
No longer in use.


 
coPay_Max_Per_Date_Provider
required
boolean
Notes that this group calculates copay max (based on plan configuration) by provider rather than across the entire plan. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
commission_Lookback
integer or null <int32> 
Notes the number of billing cycles to lookback when calculating commissions.


 
contact_Country_Code
string or null  <= 8 characters 
Country code of the Group's contact number.


 
contact_Email_Address
string or null  <= 128 characters 
Email address of the identified Group contact.


 
contact_Extension
string or null  <= 6 characters 
Extension number of the Group's contact.


 
contact_Phone
string or null  <= 20 characters 
Phone number of the Group's contact.


 
contact_Title
string or null  <= 20 characters 
Title of the Group's primary contact.


 
country_ID
string or null  <= 8 characters 
Identifier of the Groups's country.


 
county_Code
string or null  <= 8 characters 
County code of the Group address.


 
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.


 
default_EOB_Report
integer or null <int32> 
Defines the default EOB report object from our core admin system. This is a developer setting.


 
default_Invoice_ReportDefinition_Key
integer or null <int32> 
By default, indicates which Invoice report should be used for automation.


 
default_Process_by_Disability_Date
required
boolean
Process by Disability Date can be defined here to apply to all claims for this group rather than on a claim by claim basis (acts as a default). Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
default_Roll_Up_Waiting_Period
required
boolean
Roll Up Waiting Period can be defined here to apply to all claims for this group rather than on a claim by claim basis (acts as a default). Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
disability_Pay_Through_Day
integer or null <int32> 
The day of the week that Paid Through is calculated for Disability premiums.


 
disable_COBRA_Auto_Select
required
boolean
This flag indicates that the Group COBRA premium will not be automatically populated during member disenrollment. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
disenroll_Date
string or null <date-time> 
Date when the Group expires/expired.


 
distribution_Account_Key
integer or null <int32> 
For Premium Distribution processing, this notes the Account for the source of distributed funds.


 
distribution_Payor_ID
string or null  <= 20 characters 
For Premium Distribution processing, this notes the Payor ID for the source of distributed funds.


 
duplicate_Claim_Override
required
boolean
Notes if this group allows Duplicate Claims to be overridden to be paid. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
election_Range
integer or null <int32> 
Used for determining Flex Election.


 
election_Range_Type
string or null  <= 16 characters 
Used with Election_Range to determine the Flex Election.


 
employer_Size
string or null  <= 8 characters 
Information field used in custom client reporting.


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


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


 
ex_Code
string or null  <= 6 characters 
The Ex Code applied during claims adjudication if "Apply_Ex_Code" is enabled.


 
fax
string or null  <= 20 characters 
Fax number of the Group.


 
fax_Country_Code
string or null  <= 8 characters 
Country code of the Group's fax number.


 
federal_ID
string or null  <= 20 characters 
Federal tax identifier of the Group.


 
generate_Adjustments
string or null  <= 1 characters 
No longer in use. Replaced by Premium Billing module.


 
generate_Invoices
string or null  <= 1 characters 
No longer in use. Replaced by Premium Billing module.


 
group_Account
integer or null <int32> 
Holds the account reference for the Employer Account. Not used in processing.


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


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


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


 
inv_Grace_Period
integer or null <int32> 
The grace period value based on "Grace_Period_Type" for how long you have to process an invoice after the term date.


 
inv_Grace_Period_Type
string or null  <= 1 characters 
Works with Grace_Period to determine how long after term date an invoice can be processed.


 
invoice_Enrolled_By
integer or null <int32> 
Used to determine eligiblity during invoice generation for enrolled members.


 
invoice_Enrolled_Thru
integer or null <int32> 
Used to determine eligiblity during invoice generation for enrolled members.


 
issue_State
string or null  <= 2 characters 
Identifies the sate in which the Group is insured.


 
name
string or null  <= 50 characters 
Name of the Group.


 
notes
string or null
No longer in use, replaced by Notes Service.


 
open_Closed_Enrollment
required
boolean
Information field used in custom client reporting. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
original_Date
string or null <date-time> 
Date when the Group becomes/became active.


 
paid_Through
string or null <date-time> 
Date through which the Group premium has been paid.


 
paperless
required
boolean
Notes if this Group is Paperless (this overrides the individual member settings from VBAGateway). Used in process automation. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
pay_To_Account
integer or null <int32> 
The Pay To Account used for external payments.


 
payor_ID
string or null  <= 20 characters 
Identifier of the Payor associated with the Group.


 
phone
string or null  <= 20 characters 
Phone number of the Group.


 
phone_Country_Code
string or null  <= 8 characters 
Country code of the Group's phone number.


 
prepaid_Group
required
boolean
Information field used in custom client reporting. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
primary_Contact
string or null  <= 25 characters 
Primary contact of the Group.


 
producer
string or null  <= 128 characters 
Information field used in custom client reporting.


 
prorate_Deduction
required
boolean
Notes if the disability deductions should be prorated during adjudication. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
prorate_Deduction_Type
string or null  <= 10 characters 
For Disability, notes the Deduction Type to have prorate applied.


 
rX_BIN
string or null  <= 64 characters 
Information field used in custom client reporting.


 
rX_CS_Contact
string or null  <= 128 characters 
Information field used in custom client reporting.


 
rX_CS_Phone
string or null  <= 32 characters 
Information field used in custom client reporting.


 
rX_GRP
string or null  <= 64 characters 
Information field used in custom client reporting.


 
rX_Name
string or null  <= 512 characters 
Information field used in custom client reporting.


 
rX_PCN
string or null  <= 64 characters 
Information field used in custom client reporting.


 
reason_ID
integer or null <int32> 
No longer in use.


 
region_Code
string or null  <= 32 characters 
Region Code for this group (locality).


 
renewal_Completion_Date
string or null <date-time> 
Information field used in custom client reporting.


 
renewal_Date
string or null <date-time> 
The last renewal date for this Group. Used in custom reporting. Not used in processing.


 
self_Admin
required
boolean
Notes if this group has Self-Admin billing. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
set_Billing_Due_Date
required
boolean
Indicates if the system should calculate the Due Date on an invoice based on Billing_Due_Date settings. By default the due date is the "Bill Thru" on an invoice, this gives the option to change that calculation. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
state
string or null  <= 2 characters 
State of the Group's address.


 
subscriber_ID_Prefix
string or null  <= 3 characters 
The automatically applied Subscriber ID prefix when using auto generated IDs.


 
subscriber_ID_Suffix
string or null  <= 3 characters 
The automatically applied Subscriber ID suffix when using auto generated IDs.


 
total_Employees
integer or null <int32> 
Information field used in custom client reporting.


 
uC_Percent
string or null  <= 8 characters 
Identifies the Usual and Customary percentage of the Group.


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


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


 
use_Employer_State
boolean or null
Notes if Employe State, not Subscriber State, should be used in invoice generation. Note: The database will apply a default value of False for this field if a value is not provided.


 
zip_Code
string or null  <= 32 characters 
Zip code of the Group's address.


 
Responses 
200
Success


401
Unauthorized


put/groups/{groupID}
Request samples 
{
  • "group_ID": "string",
  • "account_Key": 0,
  • "account_Manager": "string",
  • "addOn_Rate_Option": "string",
  • "address": "string",
  • "address2": "string",
  • "admin_COBRA": true,
  • "adult_Age": 0,
  • "advice_To_Pay": true,
  • "apply_Ex_Code": true,
  • "auth_Not_Reqd_Override": true,
  • "billing_Age_Calc": "s",
  • "billing_Cycle_ID": "st",
  • "billing_Due_Date_Range": 0,
  • "billing_Due_Date_Range_Type": "string",
  • "billing_Due_Date_Type": "string",
  • "billing_Invoice_Create": 0,
  • "billing_Retro_Limit": 0,
  • "caseRate": 0.1,
  • "check_Birthday": "s",
  • "city": "string",
  • "claim_Days_Allowed": 0,
  • "coPay_Max_Per_Date_Provider": true,
  • "commission_Lookback": 0,
  • "contact_Country_Code": "string",
  • "contact_Email_Address": "string",
  • "contact_Extension": "string",
  • "contact_Phone": "string",
  • "contact_Title": "string",
  • "country_ID": "string",
  • "county_Code": "string",
  • "cutoff_Age": 0,
  • "default_EOB_Report": 0,
  • "default_Invoice_ReportDefinition_Key": 0,
  • "default_Process_by_Disability_Date": true,
  • "default_Roll_Up_Waiting_Period": true,
  • "disability_Pay_Through_Day": 0,
  • "disable_COBRA_Auto_Select": true,
  • "disenroll_Date": "2019-08-24T14:15:22Z",
  • "distribution_Account_Key": 0,
  • "distribution_Payor_ID": "string",
  • "duplicate_Claim_Override": true,
  • "election_Range": 0,
  • "election_Range_Type": "string",
  • "employer_Size": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "ex_Code": "string",
  • "fax": "string",
  • "fax_Country_Code": "string",
  • "federal_ID": "string",
  • "generate_Adjustments": "s",
  • "generate_Invoices": "s",
  • "group_Account": 0,
  • "individual_Billing": true,
  • "individual_Cycle": true,
  • "individual_Dates": true,
  • "inv_Grace_Period": 0,
  • "inv_Grace_Period_Type": "s",
  • "invoice_Enrolled_By": 0,
  • "invoice_Enrolled_Thru": 0,
  • "issue_State": "st",
  • "name": "string",
  • "notes": "string",
  • "open_Closed_Enrollment": true,
  • "original_Date": "2019-08-24T14:15:22Z",
  • "paid_Through": "2019-08-24T14:15:22Z",
  • "paperless": true,
  • "pay_To_Account": 0,
  • "payor_ID": "string",
  • "phone": "string",
  • "phone_Country_Code": "string",
  • "prepaid_Group": true,
  • "primary_Contact": "string",
  • "producer": "string",
  • "prorate_Deduction": true,
  • "prorate_Deduction_Type": "string",
  • "rX_BIN": "string",
  • "rX_CS_Contact": "string",
  • "rX_CS_Phone": "string",
  • "rX_GRP": "string",
  • "rX_Name": "string",
  • "rX_PCN": "string",
  • "reason_ID": 0,
  • "region_Code": "string",
  • "renewal_Completion_Date": "2019-08-24T14:15:22Z",
  • "renewal_Date": "2019-08-24T14:15:22Z",
  • "self_Admin": true,
  • "set_Billing_Due_Date": true,
  • "state": "st",
  • "subscriber_ID_Prefix": "str",
  • "subscriber_ID_Suffix": "str",
  • "total_Employees": 0,
  • "uC_Percent": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "use_Employer_State": true,
  • "zip_Code": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete Groups
Deletes an Groups


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/groups/{groupID}
Request samples 
Create or Update Batch Groups
Create or Update multiple Groups at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
group_ID
required
string  [ 1 .. 20 ] characters 
Unique identifier for each Group.


 
account_Key
integer or null <int32> 
Identifies the Account associated with this Group.


 
account_Manager
string or null  <= 128 characters 
Information field used in custom client reporting.


 
addOn_Rate_Option
string or null  <= 8 characters 
Determines whether a Group's AddOn Rates are combined and applied once (Additive) or applies rates separately, in a sequence (Sequential).


 
address
string or null  <= 255 characters 
Adderss of the Group.


 
address2
string or null  <= 128 characters 
Line 2 of the Group's address.


 
admin_COBRA
required
boolean
Indicates if this Group administers COBRA. 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
Notes if the claims for this Group should be Advice_To_Pay (flagged as unpaid when processed). Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
apply_Ex_Code
required
boolean
Flag if adjudication should apply an Ex Code to a claim for this Group. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
auth_Not_Reqd_Override
required
boolean
Notes if this group allows Auth Required claims edit to be overridden and paid. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
billing_Age_Calc
string or null  <= 1 characters 
No longer in use. Replaced by Premium Billing module.


 
billing_Cycle_ID
string or null  <= 2 characters 
Identifies the bill cycle for this Group. This will be used when creating invoices.


 
billing_Due_Date_Range
integer or null <int32> 
Used when Set_Billing_Due_Date is enabled.


 
billing_Due_Date_Range_Type
string or null  <= 16 characters 
Used when Set_Billing_Due_Date is enabled.


 
billing_Due_Date_Type
string or null  <= 32 characters 
Used when Set_Billing_Due_Date is enabled.


 
billing_Invoice_Create
integer or null <int32> 
Indicates the group is included in invoice generation processes.


 
billing_Retro_Limit
integer or null <int32> 
Indicates how many bills (based on billing cycles) should be interrogated to determine adjustments.


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


 
check_Birthday
string or null  <= 1 characters 
Identifies whether date of birth edits are performed for this Group during adjudication.


 
city
string or null  <= 25 characters 
City of the Group's address.


 
claim_Days_Allowed
integer or null <int32> 
No longer in use.


 
coPay_Max_Per_Date_Provider
required
boolean
Notes that this group calculates copay max (based on plan configuration) by provider rather than across the entire plan. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
commission_Lookback
integer or null <int32> 
Notes the number of billing cycles to lookback when calculating commissions.


 
contact_Country_Code
string or null  <= 8 characters 
Country code of the Group's contact number.


 
contact_Email_Address
string or null  <= 128 characters 
Email address of the identified Group contact.


 
contact_Extension
string or null  <= 6 characters 
Extension number of the Group's contact.


 
contact_Phone
string or null  <= 20 characters 
Phone number of the Group's contact.


 
contact_Title
string or null  <= 20 characters 
Title of the Group's primary contact.


 
country_ID
string or null  <= 8 characters 
Identifier of the Groups's country.


 
county_Code
string or null  <= 8 characters 
County code of the Group address.


 
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.


 
default_EOB_Report
integer or null <int32> 
Defines the default EOB report object from our core admin system. This is a developer setting.


 
default_Invoice_ReportDefinition_Key
integer or null <int32> 
By default, indicates which Invoice report should be used for automation.


 
default_Process_by_Disability_Date
required
boolean
Process by Disability Date can be defined here to apply to all claims for this group rather than on a claim by claim basis (acts as a default). Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
default_Roll_Up_Waiting_Period
required
boolean
Roll Up Waiting Period can be defined here to apply to all claims for this group rather than on a claim by claim basis (acts as a default). Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
disability_Pay_Through_Day
integer or null <int32> 
The day of the week that Paid Through is calculated for Disability premiums.


 
disable_COBRA_Auto_Select
required
boolean
This flag indicates that the Group COBRA premium will not be automatically populated during member disenrollment. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
disenroll_Date
string or null <date-time> 
Date when the Group expires/expired.


 
distribution_Account_Key
integer or null <int32> 
For Premium Distribution processing, this notes the Account for the source of distributed funds.


 
distribution_Payor_ID
string or null  <= 20 characters 
For Premium Distribution processing, this notes the Payor ID for the source of distributed funds.


 
duplicate_Claim_Override
required
boolean
Notes if this group allows Duplicate Claims to be overridden to be paid. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
election_Range
integer or null <int32> 
Used for determining Flex Election.


 
election_Range_Type
string or null  <= 16 characters 
Used with Election_Range to determine the Flex Election.


 
employer_Size
string or null  <= 8 characters 
Information field used in custom client reporting.


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


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


 
ex_Code
string or null  <= 6 characters 
The Ex Code applied during claims adjudication if "Apply_Ex_Code" is enabled.


 
fax
string or null  <= 20 characters 
Fax number of the Group.


 
fax_Country_Code
string or null  <= 8 characters 
Country code of the Group's fax number.


 
federal_ID
string or null  <= 20 characters 
Federal tax identifier of the Group.


 
generate_Adjustments
string or null  <= 1 characters 
No longer in use. Replaced by Premium Billing module.


 
generate_Invoices
string or null  <= 1 characters 
No longer in use. Replaced by Premium Billing module.


 
group_Account
integer or null <int32> 
Holds the account reference for the Employer Account. Not used in processing.


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


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


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


 
inv_Grace_Period
integer or null <int32> 
The grace period value based on "Grace_Period_Type" for how long you have to process an invoice after the term date.


 
inv_Grace_Period_Type
string or null  <= 1 characters 
Works with Grace_Period to determine how long after term date an invoice can be processed.


 
invoice_Enrolled_By
integer or null <int32> 
Used to determine eligiblity during invoice generation for enrolled members.


 
invoice_Enrolled_Thru
integer or null <int32> 
Used to determine eligiblity during invoice generation for enrolled members.


 
issue_State
string or null  <= 2 characters 
Identifies the sate in which the Group is insured.


 
name
string or null  <= 50 characters 
Name of the Group.


 
notes
string or null
No longer in use, replaced by Notes Service.


 
open_Closed_Enrollment
required
boolean
Information field used in custom client reporting. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
original_Date
string or null <date-time> 
Date when the Group becomes/became active.


 
paid_Through
string or null <date-time> 
Date through which the Group premium has been paid.


 
paperless
required
boolean
Notes if this Group is Paperless (this overrides the individual member settings from VBAGateway). Used in process automation. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
pay_To_Account
integer or null <int32> 
The Pay To Account used for external payments.


 
payor_ID
string or null  <= 20 characters 
Identifier of the Payor associated with the Group.


 
phone
string or null  <= 20 characters 
Phone number of the Group.


 
phone_Country_Code
string or null  <= 8 characters 
Country code of the Group's phone number.


 
prepaid_Group
required
boolean
Information field used in custom client reporting. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
primary_Contact
string or null  <= 25 characters 
Primary contact of the Group.


 
producer
string or null  <= 128 characters 
Information field used in custom client reporting.


 
prorate_Deduction
required
boolean
Notes if the disability deductions should be prorated during adjudication. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
prorate_Deduction_Type
string or null  <= 10 characters 
For Disability, notes the Deduction Type to have prorate applied.


 
rX_BIN
string or null  <= 64 characters 
Information field used in custom client reporting.


 
rX_CS_Contact
string or null  <= 128 characters 
Information field used in custom client reporting.


 
rX_CS_Phone
string or null  <= 32 characters 
Information field used in custom client reporting.


 
rX_GRP
string or null  <= 64 characters 
Information field used in custom client reporting.


 
rX_Name
string or null  <= 512 characters 
Information field used in custom client reporting.


 
rX_PCN
string or null  <= 64 characters 
Information field used in custom client reporting.


 
reason_ID
integer or null <int32> 
No longer in use.


 
region_Code
string or null  <= 32 characters 
Region Code for this group (locality).


 
renewal_Completion_Date
string or null <date-time> 
Information field used in custom client reporting.


 
renewal_Date
string or null <date-time> 
The last renewal date for this Group. Used in custom reporting. Not used in processing.


 
self_Admin
required
boolean
Notes if this group has Self-Admin billing. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
set_Billing_Due_Date
required
boolean
Indicates if the system should calculate the Due Date on an invoice based on Billing_Due_Date settings. By default the due date is the "Bill Thru" on an invoice, this gives the option to change that calculation. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
state
string or null  <= 2 characters 
State of the Group's address.


 
subscriber_ID_Prefix
string or null  <= 3 characters 
The automatically applied Subscriber ID prefix when using auto generated IDs.


 
subscriber_ID_Suffix
string or null  <= 3 characters 
The automatically applied Subscriber ID suffix when using auto generated IDs.


 
total_Employees
integer or null <int32> 
Information field used in custom client reporting.


 
uC_Percent
string or null  <= 8 characters 
Identifies the Usual and Customary percentage of the Group.


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


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


 
use_Employer_State
boolean or null
Notes if Employe State, not Subscriber State, should be used in invoice generation. Note: The database will apply a default value of False for this field if a value is not provided.


 
zip_Code
string or null  <= 32 characters 
Zip code of the Group's address.


 
Responses 
207
Success


401
Unauthorized


put/groups-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}
Group Disenroll Advanced API 
Disenrolls a Group and/or Division.  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


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
user_ID
required
string  [ 1 .. 20 ] characters 
The user for which this request is executed on behalf of.


 
group_ID
required
string  [ 1 .. 20 ] characters 
The Group ID you would like to perform the disenroll.  You can use the List Groups API (https://vbapi.vbasoftware.com/vbasoftware/groups) to get the values you need.


 
division_ID
string or null  <= 20 characters 
The Division ID to be disenrolled if you intend to disenroll only a specific Division.  Leave this blank if you intend to disenroll all Divisions in a group.  You can use the List GroupDivisions API (https://vbapi.vbasoftware.com/vbasoftware/groups/{groupID}/divisions) to get the values you need.


 
disenroll_Date
required
string <date-time> 
The Disenroll Date for this disenroll process.


 
term_Date
string or null <date-time> 
Term Date is an informational field used in some reports.  It doesn't impact the process but is often populated with the same value as the Disenroll Date.


 
reason_ID
required
integer <int32> 
Reason ID is the reson for this disenroll.  You can get a list of valid Reason IDs from the List Reasons API (https://vbapi.vbasoftware.com/vbasoftware/reasons).


 
disenrollFamily
required
integer <int32> 
The DisenrollFamily indicator lets the Disenroll process know exactly how to perform the Disenroll.  You can get a list of valid DisenrollFamily values from the List Disenrollment Family Options API (https://vbapi.vbasoftware.com/vbasoftware/disenroll-family-options).


 
terminateAuth
required
boolean
The TerminateAuth flag lets us know if Auths approved or requested beyond the Disenroll Date should be cancelled.


 
disenrollFuture
required
integer <int32> 
The DisenrollFuture indicator will tell us how to handle any future enrollments beyond the Disenroll Date related to this disenroll.  The valid values are:
2 - Disenroll Future Enrollments
3 - Do Not Disenroll any Future Enrollments


 
groupDisenroll
required
boolean
The flag is required and is set based on the disenroll you are performing.  Set this value to true if you intend to Disenroll the Group.  If you send in Divisioni_ID to disenroll a specific Division, this flag will then disenroll the group and the division sent but not other divisions.


 
Responses 
200
Success


401
Unauthorized


post/groups/{groupID}/disenroll
Request samples 
{
  • "user_ID": "string",
  • "group_ID": "string",
  • "division_ID": "string",
  • "disenroll_Date": "2019-08-24T14:15:22Z",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "reason_ID": 0,
  • "disenrollFamily": 0,
  • "terminateAuth": true,
  • "disenrollFuture": 0,
  • "groupDisenroll": true
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Group Reenroll Advanced API 
Re-enrolls a Group and/or Division.  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


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
user_ID
required
string  [ 1 .. 20 ] characters 
The user for which this request is executed on behalf of.


 
subscriber_ID
string or null
 
member_Seq
string or null
 
group_ID
string or null
 
division_ID
string or null
 
reenrollFamily
integer or null <int32> 
 
subscriber
boolean
 
start_Date
string or null <date-time> 
 
reenrollCOBRA
boolean
 
resetAuth
boolean
 
disenroll_Date
string or null <date-time> 
 
cobraDivision
string or null
 
cobraCovStart
string or null <date-time> 
 
cobraStart
string or null <date-time> 
 
cobraEnd
string or null <date-time> 
 
cobraReason
integer or null <int32> 
 
generateInvoice
boolean
 
invoiceDate
string or null <date-time> 
 
groupReenroll
boolean
 
resetGroupDisenroll
boolean
 
reenrollAll
boolean
 
Array of objects or null (COBRAPlanCriteria) 
 
memberSeqCriterias
Array of strings or null
 
Responses 
200
Success


401
Unauthorized


post/groups/{groupID}/reenroll
Request samples 
{
  • "user_ID": "string",
  • "subscriber_ID": "string",
  • "member_Seq": "string",
  • "group_ID": "string",
  • "division_ID": "string",
  • "reenrollFamily": 0,
  • "subscriber": true,
  • "start_Date": "2019-08-24T14:15:22Z",
  • "reenrollCOBRA": true,
  • "resetAuth": true,
  • "disenroll_Date": "2019-08-24T14:15:22Z",
  • "cobraDivision": "string",
  • "cobraCovStart": "2019-08-24T14:15:22Z",
  • "cobraStart": "2019-08-24T14:15:22Z",
  • "cobraEnd": "2019-08-24T14:15:22Z",
  • "cobraReason": 0,
  • "generateInvoice": true,
  • "invoiceDate": "2019-08-24T14:15:22Z",
  • "groupReenroll": true,
  • "resetGroupDisenroll": true,
  • "reenrollAll": true,
  • "cobraPlanCriterias": [
    ],
  • "memberSeqCriterias": [
    ]
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Get Group enrollment summary information Advanced API 
Gets Group enrollment summary for the given group id. 


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/groups/{groupID}/enrollment-summary
Request samples 
Response samples 
No sample
Get Group ID Card Selections
Gets Group ID Card Selections


SecurityapiKeyAuth and bearerAuth 
Request 
query Parameters
groupID
string
Group ID


 
divisionID
string
Division ID


 
planID
string
Plan ID


 
relationship
string
Relationship


 
asOfDate
required
string <date-time> 
As of Date


 
flexVendor
string
Flex Vendor


 
page
integer <int32> 
 Default:  1
Page Index


 
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/id-card-selection
Request samples 
Response samples 
No sample