APIs for VBASoftware
/
Create or Update Batch Gr...
VBASoftware (v1)
Download OpenAPI description
Languages
Servers
VBAPI VBASoftware
https://vbapi.vbasoftware.com/vbasoftware/
- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/groups/{groupID}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
'https://vbapi.vbasoftware.com/vbasoftware/groups/{groupID}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'vbasoftware-database: string' \
-H 'x-api-key: YOUR_API_KEY_HERE'Body
- application/json
- text/json
- application/*+json
Determines whether a Group's AddOn Rates are combined and applied once (Additive) or applies rates separately, in a sequence (Sequential).
Indicates if this Group administers COBRA. Note: This field is marked as NOT NULL in the database and therefore required by the API.
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.
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.
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.
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.
Identifies the bill cycle for this Group. This will be used when creating invoices.
Indicates the group is included in invoice generation processes.
Indicates how many bills (based on billing cycles) should be interrogated to determine adjustments.
Identifies whether date of birth edits are performed for this Group during adjudication.
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.
Notes the number of billing cycles to lookback when calculating commissions.
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.
Defines the default EOB report object from our core admin system. This is a developer setting.
By default, indicates which Invoice report should be used for automation.
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.
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.
The day of the week that Paid Through is calculated for Disability premiums.
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.
For Premium Distribution processing, this notes the Account for the source of distributed funds.
For Premium Distribution processing, this notes the Payor ID for the source of distributed funds.
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.
Used with Election_Range to determine the Flex Election.
The Ex Code applied during claims adjudication if "Apply_Ex_Code" is enabled.
No longer in use. Replaced by Premium Billing module.
Holds the account reference for the Employer Account. Not used in processing.
No longer in use. Note: This field is marked as NOT NULL in the database and therefore required by the API.
No longer in use. Note: This field is marked as NOT NULL in the database and therefore required by the API.
No longer in use. Note: This field is marked as NOT NULL in the database and therefore required by the API.
The grace period value based on "Grace_Period_Type" for how long you have to process an invoice after the term date.
Works with Grace_Period to determine how long after term date an invoice can be processed.
Used to determine eligiblity during invoice generation for enrolled members.
Used to determine eligiblity during invoice generation for enrolled members.
Information field used in custom client reporting. Note: This field is marked as NOT NULL in the database and therefore required by the API.
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.
Information field used in custom client reporting. Note: This field is marked as NOT NULL in the database and therefore required by the API.
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.
For Disability, notes the Deduction Type to have prorate applied.
The last renewal date for this Group. Used in custom reporting. Not used in processing.
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.
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.
The automatically applied Subscriber ID prefix when using auto generated IDs.
The automatically applied Subscriber ID suffix when using auto generated IDs.
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.
- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/groups-batch
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
https://vbapi.vbasoftware.com/vbasoftware/groups-batch \
-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"
}
]'Response
No response exampleBody
- application/json
- text/json
- application/*+json
The user for which this request is executed on behalf of.
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.
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.
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 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).
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).
The TerminateAuth flag lets us know if Auths approved or requested beyond the Disenroll Date should be cancelled.
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
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.
- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/groups/{groupID}/disenroll
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://vbapi.vbasoftware.com/vbasoftware/groups/{groupID}/disenroll' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-H 'vbasoftware-database: string' \
-H 'x-api-key: YOUR_API_KEY_HERE' \
-d '{
"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
No response example