APIs for VBASoftware
VBASoftware (v1)
- application/json
- text/json
- application/*+json
References GroupDivision.Group_ID value on the parent record.
References GroupDivision.Division_ID value on the parent record.
Date when the contract becomes/became effective. 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.
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.
Indicates that the Group offers Member-level benfits. This means that the insured and dependents can enroll in separate coverage.
No longer in use. 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.
Premium Billing setting that holds the premiums paid through for a selection of contracted subscribers.
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.
Disability setting for totals calculating at the Member level.
- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/groups/{groupID}/divisions/{divisionID}/contracts
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://vbapi.vbasoftware.com/vbasoftware/groups/{groupID}/divisions/{divisionID}/contracts' \
-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",
"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"
}'No response example- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/groups/{groupID}/divisions/{divisionID}/contracts
- 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}/contracts?page=1&pageSize=100&sortBy=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'vbasoftware-database: string' \
-H 'x-api-key: YOUR_API_KEY_HERE'No response example- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/groups/{groupID}/divisions/{divisionID}/add-contract
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://vbapi.vbasoftware.com/vbasoftware/groups/{groupID}/divisions/{divisionID}/add-contract' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-H 'vbasoftware-database: string' \
-H 'x-api-key: YOUR_API_KEY_HERE' \
-d '{
"contract": {
"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"
},
"reenroll": true,
"reenrollPlan": true,
"reenrollRider": true,
"copyPlan": true,
"copyNetwork": true,
"copyTier": true,
"copyRider": true,
"reenrollRiderIDCode": true,
"copyPlanIDCode": true,
"copyNetworkIDCode": true,
"user_ID": "string",
"planMappings": [
{
"original_Plan_ID": "string",
"mapped_Plan_ID": "string"
}
]
}'No response example