APIs for VBASoftware
VBASoftware (v1)
Download OpenAPI description
Languages
Servers
VBAPI VBASoftware
https://vbapi.vbasoftware.com/vbasoftware/
- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/groups/{groupID}/divisions/{divisionID}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://vbapi.vbasoftware.com/vbasoftware/groups/{groupID}/divisions/{divisionID}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'vbasoftware-database: string' \
-H 'x-api-key: YOUR_API_KEY_HERE'Response
No response exampleBodyrequired
- application/json
- text/json
- application/*+json
Unique Division identifier assigned inside this Group. This ID must be unique within the Group ID.
References the FundingAccount.Account_Key that holds the ACH information for this Division for any ACH processing.
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.
This flag tells adjudication to not error if no authorization is found on claims that require authorization. Note: This field is marked as NOT NULL in the database and therefore required by the API.
When utilizing the Auto-Term process, notes the adjustment reason applied to premiums impacted by a retro term.
When utilizing the Auto-Term process, indicates the Term Reason to apply if COBRA is being enrolled.
Points to the Division ID that is the COBRA Division for this Division. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Information field for custom client reporting. Note: This field is marked as NOT NULL in the database and therefore required by the API.
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.
When disenrolling a member and reenrolling into COBRA, this indicates the default reason attached to the disenroll.
For reports in the "INV" Report_Category, this provides the user with the list of invoice reports they can set as the default report using for automated invoice generation.
Indicates the day of the week the paid through is set when using automatic paid through dates.
This notes that the Division has been terminated and what date. An active Division has a NULL value here.
References the PayorAccount.Account_Key value in parent table.
References the PayorAccount.Payor_ID value in parent table.
This flag tells adjudication to ignore Duplicate Claims Processing logic if enabled. Note: This field is marked as NOT NULL in the database and therefore required by the API.
For Disability tax calculations, this indicates if the Division is exempt from taking Federal taxes on the claim payments. Note: This field is marked as NOT NULL in the database and therefore required by the API.
For Disability tax calculations, this indicates if the Division is exempt from taking Medicare taxes on the claim payments. Note: This field is marked as NOT NULL in the database and therefore required by the API.
For Disability tax calculations, this indicates if the Division is exempt from taking Social Security taxes on the claim payments. Note: This field is marked as NOT NULL in the database and therefore required by the API.
For Disability tax calculations, this indicates if the Division is exempt from taking State taxes on the claim payments. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Notes if the employer matches FICA (lowers that tax to 0) during claims adjudication. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Notes if this Division is part of tax reporting and should have its data sent for W2 generation. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Indicates the grace period for invoice generation for this Division. This value works with "Invoice_Grace_Period_Type" to determine duration.
When a grace period is applied to an invoice that impacts "Paid Through", the affected claims will apply this Ex Code.
Based on "Invoice_Grace_Period", this is the Days, Weeks, Months or Years that grace period extends.
Indiciates the level of invoicing done by premium billing. There are 3 levels you can configure: S - Subscriber level invoicing (meaning an invoice per enrolled Subscriber), D - Division level invoicing (meaning an invoice per Division with all enrolled Subscribers in that Division on that Invoice), and G - Group level invoicing (meaning an invoice for the whole group with all enrolled Subscribers on the same invoice).
When generating Division level invoices through premium biling, this is the Address on that invoice.
When generating Division level invoices through premium biling, this is the Address 2 on that invoice.
When generating Division level invoices through premium biling, this is the City on that invoice.
When generating Division level invoices through premium biling, this is the Phone Number Country Code on that invoice.
When generating Division level invoices through premium biling, this is the Country ID on that invoice.
When generating Division level invoices through premium biling, this is the Name on that invoice.
When generating Division level invoices through premium biling, this is the Phone Number on that invoice.
When generating Division level invoices through premium biling, this is the State on that invoice.
When generating Division level invoices through premium biling, this is the Zip Code on that invoice.
For Life & Disability clients, this holds the issue state for processing taxes and reporting.
For Life & Disability clients, this is the default Mail To setting applied to claims created through the advisor wizards. Note: This field is marked as NOT NULL in the database and therefore required by the API.
This is the first start date (original effective date) of the Division inside this group. This date should be equal to or earlier than the first GroupContact.Coverage_Start date attached to this Division.
This is the Ex Code applied if COB is identified during adjudciation and Other Insurance information is used during processing.
This is the paid through date for any Division level invoices through premium billing. This can be manually set or updated by the system.
Information field for custom client reporting.
For processing that uses the Pay To Account, this referneces the FundingAccount.Account_Key for that process.
The Ex Code applied during claims adjudication if "Pend_Flag" is enabled.
Notes that this Division should have a pend code (Ex Code) applied during claims processing for any claims for this Division.
Notes if this division should have disability deductions pro-rated during claims processing. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Indicates the type of prorating to calculate against. If calculating against flat deduction types only, set to F, to apply prorating to Percentage based deductions, set to P, if applying prorating on all deduction types, set to B.
No longer in use. Replaces by the full reinsurance module.
Notes if this division should have the paid through set as part of satisfying a premium bill. Note: This field is marked as NOT NULL in the database and therefore required by the API.
No longer in use. Replaces by the full reinsurance module.
Indicates if the tax day limitations are by day or calendar months. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Limits the deduction types that can be selected on disability claims to use the GroupDivisionDeductionType list. Note: This field is marked as NOT NULL in the database and therefore required by the API.
- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/groups/{groupID}/divisions/{divisionID}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://vbapi.vbasoftware.com/vbasoftware/groups/{groupID}/divisions/{divisionID}' \
-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",
"division_ID": "string",
"acH_Account_Key": 0,
"account_Key": 0,
"address": "string",
"address2": "string",
"adult_Age": 0,
"agri_Tax_Return": "str",
"auth_Not_Reqd_Override": true,
"brokerage": "string",
"cobrA_Auto_Term_Adj_Reason": 0,
"cobrA_Auto_Term_Reason": 0,
"cobrA_Division": true,
"coE_Network": true,
"caseRate": 0.1,
"city": "string",
"claim_Days_Allowed": 0,
"class_Description": "string",
"class_ID": "string",
"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_COBRA_Reason": 0,
"default_Invoice_ReportDefinition_Key": 0,
"disability_Pay_Through_Day": 0,
"disenroll_Date": "2019-08-24T14:15:22Z",
"distribution_Account_Key": 0,
"distribution_Payor_ID": "string",
"duplicate_Claim_Override": true,
"entry_Date": "2019-08-24T14:15:22Z",
"entry_User": "string",
"exempt_Federal": true,
"exempt_Medicare": true,
"exempt_SocSec": true,
"exempt_State": true,
"ficA_Employer_Match": true,
"fax": "string",
"fax_Country_Code": "string",
"federal_ID": "string",
"federal_Tax_Day_Limit": 0,
"federal_Wage_Limit": 0.1,
"generate_W2": true,
"groupDivisionCaptive": "string",
"invoice_Grace_Period": 0,
"invoice_Grace_Period_Ex_Code": "string",
"invoice_Grace_Period_Type": "string",
"invoice_Level": "s",
"invoice_Remit_Address1": "string",
"invoice_Remit_Address2": "string",
"invoice_Remit_City": "string",
"invoice_Remit_Country_Code": "string",
"invoice_Remit_Country_ID": "string",
"invoice_Remit_Name": "string",
"invoice_Remit_Phone_Number": "string",
"invoice_Remit_State": "st",
"invoice_Remit_Zip_Code": "string",
"issue_State": "st",
"mail_To_Default": true,
"medicare_Tax_Day_Limit": 0,
"medicare_Wage_Limit": 0.1,
"name": "string",
"notes": "string",
"numberLives": 0,
"original_Date": "2019-08-24T14:15:22Z",
"other_Insurance_ExCode": "string",
"paid_Through": "2019-08-24T14:15:22Z",
"participationIncentive_ID": "string",
"pay_To_Account": 0,
"payor_ID": "string",
"pend_Ex_Code": "string",
"pend_Flag": "s",
"phone": "string",
"phone_Country_Code": "string",
"premium_Location": "string",
"primary_Contact": "string",
"prorate_Deduction": true,
"prorate_Deduction_Type": "string",
"reference_Based_Pricing": "s",
"region_Code": "string",
"reinsurance_Option": "string",
"seerData": 0,
"set_Paid_Through": true,
"socSec_Tax_Day_Limit": 0,
"socSec_Wage_Limit": 0.1,
"spec_Deductible": "string",
"state": "st",
"state_Tax_Day_Limit": 0,
"state_Wage_Limit": 0.1,
"tax_Day_Limit_Type": 0,
"transplantElite": "string",
"update_Date": "2019-08-24T14:15:22Z",
"update_User": "string",
"use_Restricted_Deductions": true,
"zip_Code": "string"
}'Response
No response example- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/groups/{groupID}/divisions/{divisionID}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
'https://vbapi.vbasoftware.com/vbasoftware/groups/{groupID}/divisions/{divisionID}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'vbasoftware-database: string' \
-H 'x-api-key: YOUR_API_KEY_HERE'