APIs for VBASoftware
VBASoftware (v1)
- application/json
- text/json
- application/*+json
References GroupContractPlan.Group_ID value on the parent record.
References GroupContractPlan.Division_ID value on the parent record.
References GroupContractPlan.Coverage_Start value on the parent record. Note: This field is marked as NOT NULL in the database and therefore required by the API.
References GroupContractPlan.Plan_ID value on the parent record.
This is the rider being offered for this plan on this contract. The rider is pulled from the list of PlanBenefits with a Rider value = 1.
For disability claims this will work with the individual volume max for each payment and set a total max for all payments. The rest are not covered.
For flex, determines the Employee Contribution amount (or Pct if "Employee_Contribution_Pct" is flagged)
For flex, notes if the amount entered into "Employee_Contribution" is a percent or flat amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.
This is the minimum benefit assigned to each disability payment in all benefit calculations (working with volume minimum).
Indicates if a percent of salary should be used when determing this benefit amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.
For disability enrollment, this shows the weekly (for STD) or monthly (for LTD) benefit amount.
When using a salary based benefit, this indicates the max volume (benefit amount) for that calculation.
- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/groups/{groupID}/divisions/{divisionID}/contracts/{coverageStart}/plans/{planID}/riders
- 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/{coverageStart}/plans/{planID}/riders' \
-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",
"plan_ID": "string",
"benefit_Code": "string",
"combined_Volume_Max": 0.1,
"employee_Contribution": 0.1,
"employee_Contribution_Pct": true,
"entry_Date": "2019-08-24T14:15:22Z",
"entry_User": "string",
"funding_Indicator": "s",
"minimum_Benefit": 0.1,
"premium": 0.1,
"salary_Pct": 0.1,
"update_Date": "2019-08-24T14:15:22Z",
"update_User": "string",
"use_Salary_Pct": true,
"volume": 0.1,
"volume_Max": 0.1,
"volume_Min": 0.1
}'No response example- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/groups/{groupID}/divisions/{divisionID}/contracts/{coverageStart}/plans/{planID}/riders
- 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/{coverageStart}/plans/{planID}/riders?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}/contracts/{coverageStart}/plans/{planID}/riders/{benefitCode}
- 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/{coverageStart}/plans/{planID}/riders/{benefitCode}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'vbasoftware-database: string' \
-H 'x-api-key: YOUR_API_KEY_HERE'No response example