Skip to content

Create Groups

Request

Creates a new Groups

Security
apiKeyAuth and bearerAuth
Headers
vbasoftware-databasestringrequired

Target database

Bodyapplication/jsonrequired
group_IDstring, [ 1 .. 20 ] charactersrequired

Unique identifier for each Group.

account_Keyinteger or null, (int32)

Identifies the Account associated with this Group.

account_Managerstring or null, <= 128 characters

Information field used in custom client reporting.

addOn_Rate_Optionstring 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).

addressstring or null, <= 255 characters

Adderss of the Group.

address2string or null, <= 128 characters

Line 2 of the Group's address.

admin_COBRAbooleanrequired

Indicates if this Group administers COBRA. Note: This field is marked as NOT NULL in the database and therefore required by the API.

adult_Ageinteger 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_Paybooleanrequired

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_Codebooleanrequired

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_Overridebooleanrequired

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_Calcstring or null, <= 1 characters

No longer in use. Replaced by Premium Billing module.

billing_Cycle_IDstring or null, <= 2 characters

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

billing_Due_Date_Rangeinteger or null, (int32)

Used when Set_Billing_Due_Date is enabled.

billing_Due_Date_Range_Typestring or null, <= 16 characters

Used when Set_Billing_Due_Date is enabled.

billing_Due_Date_Typestring or null, <= 32 characters

Used when Set_Billing_Due_Date is enabled.

billing_Invoice_Createinteger or null, (int32)

Indicates the group is included in invoice generation processes.

billing_Retro_Limitinteger or null, (int32)

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

caseRatenumber or null, (double)

No longer in use.

check_Birthdaystring or null, <= 1 characters

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

citystring or null, <= 25 characters

City of the Group's address.

claim_Days_Allowedinteger or null, (int32)

No longer in use.

coPay_Max_Per_Date_Providerbooleanrequired

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_Lookbackinteger or null, (int32)

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

contact_Country_Codestring or null, <= 8 characters

Country code of the Group's contact number.

contact_Email_Addressstring or null, <= 128 characters

Email address of the identified Group contact.

contact_Extensionstring or null, <= 6 characters

Extension number of the Group's contact.

contact_Phonestring or null, <= 20 characters

Phone number of the Group's contact.

contact_Titlestring or null, <= 20 characters

Title of the Group's primary contact.

country_IDstring or null, <= 8 characters

Identifier of the Groups's country.

county_Codestring or null, <= 8 characters

County code of the Group address.

cutoff_Ageinteger 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_Reportinteger or null, (int32)

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

default_Invoice_ReportDefinition_Keyinteger or null, (int32)

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

default_Process_by_Disability_Datebooleanrequired

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_Periodbooleanrequired

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_Dayinteger or null, (int32)

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

disable_COBRA_Auto_Selectbooleanrequired

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_Datestring or null, (date-time)

Date when the Group expires/expired.

distribution_Account_Keyinteger or null, (int32)

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

distribution_Payor_IDstring or null, <= 20 characters

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

duplicate_Claim_Overridebooleanrequired

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_Rangeinteger or null, (int32)

Used for determining Flex Election.

election_Range_Typestring or null, <= 16 characters

Used with Election_Range to determine the Flex Election.

employer_Sizestring or null, <= 8 characters

Information field used in custom client reporting.

entry_Datestring, (date-time)

Date when the record was first added to the system.

entry_Userstring or null, <= 20 characters

User that first added the record to the system.

ex_Codestring or null, <= 6 characters

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

faxstring or null, <= 20 characters

Fax number of the Group.

fax_Country_Codestring or null, <= 8 characters

Country code of the Group's fax number.

federal_IDstring or null, <= 20 characters

Federal tax identifier of the Group.

generate_Adjustmentsstring or null, <= 1 characters

No longer in use. Replaced by Premium Billing module.

generate_Invoicesstring or null, <= 1 characters

No longer in use. Replaced by Premium Billing module.

group_Accountinteger or null, (int32)

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

individual_Billingbooleanrequired

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

individual_Cyclebooleanrequired

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

individual_Datesbooleanrequired

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

inv_Grace_Periodinteger 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_Typestring or null, <= 1 characters

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

invoice_Enrolled_Byinteger or null, (int32)

Used to determine eligiblity during invoice generation for enrolled members.

invoice_Enrolled_Thruinteger or null, (int32)

Used to determine eligiblity during invoice generation for enrolled members.

issue_Statestring or null, <= 2 characters

Identifies the sate in which the Group is insured.

namestring or null, <= 50 characters

Name of the Group.

notesstring or null

No longer in use, replaced by Notes Service.

open_Closed_Enrollmentbooleanrequired

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_Datestring or null, (date-time)

Date when the Group becomes/became active.

paid_Throughstring or null, (date-time)

Date through which the Group premium has been paid.

paperlessbooleanrequired

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_Accountinteger or null, (int32)

The Pay To Account used for external payments.

payor_IDstring or null, <= 20 characters

Identifier of the Payor associated with the Group.

phonestring or null, <= 20 characters

Phone number of the Group.

phone_Country_Codestring or null, <= 8 characters

Country code of the Group's phone number.

prepaid_Groupbooleanrequired

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_Contactstring or null, <= 25 characters

Primary contact of the Group.

producerstring or null, <= 128 characters

Information field used in custom client reporting.

prorate_Deductionbooleanrequired

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_Typestring or null, <= 10 characters

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

rX_BINstring or null, <= 64 characters

Information field used in custom client reporting.

rX_CS_Contactstring or null, <= 128 characters

Information field used in custom client reporting.

rX_CS_Phonestring or null, <= 32 characters

Information field used in custom client reporting.

rX_GRPstring or null, <= 64 characters

Information field used in custom client reporting.

rX_Namestring or null, <= 512 characters

Information field used in custom client reporting.

rX_PCNstring or null, <= 64 characters

Information field used in custom client reporting.

reason_IDinteger or null, (int32)

No longer in use.

region_Codestring or null, <= 32 characters

Region Code for this group (locality).

renewal_Completion_Datestring or null, (date-time)

Information field used in custom client reporting.

renewal_Datestring or null, (date-time)

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

self_Adminbooleanrequired

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_Datebooleanrequired

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.

statestring or null, <= 2 characters

State of the Group's address.

subscriber_ID_Prefixstring or null, <= 3 characters

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

subscriber_ID_Suffixstring or null, <= 3 characters

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

total_Employeesinteger or null, (int32)

Information field used in custom client reporting.

uC_Percentstring or null, <= 8 characters

Identifies the Usual and Customary percentage of the Group.

update_Datestring, (date-time)

Date when the record was last updated in the system.

update_Userstring or null, <= 20 characters

User that last updated the record in the system.

use_Employer_Stateboolean 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_Codestring or null, <= 32 characters

Zip code of the Group's address.

auto_Apply_Retro_Adjboolean
hide_Non_Applicable_Retro_Adjboolean
logo_Filestring or null
generate_PremDist_Afterstring or null, (date-time)
curl -i -X POST \
  https://vbapi.vbasoftware.com/vbasoftware/groups \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'vbasoftware-database: string' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "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",
    "auto_Apply_Retro_Adj": true,
    "hide_Non_Applicable_Retro_Adj": true,
    "logo_File": "string",
    "generate_PremDist_After": "2019-08-24T14:15:22Z"
  }'

Responses

Success

Bodyapplication/json
dataobject
errorobject
debugobject
Response
{ "data": { … }, "error": { … }, "debug": { … } }