APIs for VBASoftware
VBASoftware (v1)
- application/json
- text/json
- application/*+json
References the Subenrollment.Subscriber_ID value in the parent table.
References the Subenrollment.Group_ID value in the parent table.
References the Subenrollment.Division_ID value in the parent table.
References the Subenrollment.Group_Coverage_Start value in the parent table. Note: This field is marked as NOT NULL in the database and therefore required by the API.
References the Subenrollment.Start_Date value in the parent table. Note: This field is marked as NOT NULL in the database and therefore required by the API.
References the GroupContractPlan.Plan_ID value indicating which Plan this member is enrolling that is being offered.
Start date of Plan coverage. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Holds the date for the subscriber's application to disclose pre-existing conditions.
The Subscriber's 'Volume' within the selected plan on the enrollment. This will impact invoicing.
Date that the premiums have been paid through for this plan. The 'Paid Thru Exceeded' Ex Code will be applied to Claims adjudicated with a service date beyond this date.
The Subscriber's 'Tier' within the selected plan on the enrollment. This will impact adjudication and invoicing.
This option tells the system to calculate the 'Volume' using the Group volume rules. Checking this box will display an elipsis that when clicked will explain the volume calculation. Note: This field is marked as NOT NULL in the database and therefore required by the API.
- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/subscribers/{subscriberID}/enrollments/{groupID}/{divisionID}/{groupCoverageStart}/{startDate}/plans
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://vbapi.vbasoftware.com/vbasoftware/subscribers/{subscriberID}/enrollments/{groupID}/{divisionID}/{groupCoverageStart}/{startDate}/plans' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-H 'vbasoftware-database: string' \
-H 'x-api-key: YOUR_API_KEY_HERE' \
-d '{
"subscriber_ID": "string",
"group_ID": "string",
"division_ID": "string",
"group_Coverage_Start": "2019-08-24T14:15:22Z",
"start_Date": "2019-08-24T14:15:22Z",
"plan_ID": "string",
"plan_Start": "2019-08-24T14:15:22Z",
"application_Received_Date": "2019-08-24T14:15:22Z",
"dollar_Amount": 0.1,
"entry_Date": "2019-08-24T14:15:22Z",
"entry_User": "string",
"ltC_Daily_Benefit_Amount": 0.1,
"ltC_Lifetime_Max_Amount": 0.1,
"ltC_Lifetime_Max_Days": 0,
"ltC_Lifetime_Max_Years": 0,
"ltC_Monthly_Benefit_Amount": 0.1,
"paid_Through": "2019-08-24T14:15:22Z",
"plan_End": "2019-08-24T14:15:22Z",
"reason_ID": 0,
"tier": "st",
"update_Date": "2019-08-24T14:15:22Z",
"update_User": "string",
"use_Volume_Scale": true,
"writing_CommissionAgencyRep_Key": 0
}'No response example- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/subscribers/{subscriberID}/enrollments/{groupID}/{divisionID}/{groupCoverageStart}/{startDate}/plans
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://vbapi.vbasoftware.com/vbasoftware/subscribers/{subscriberID}/enrollments/{groupID}/{divisionID}/{groupCoverageStart}/{startDate}/plans?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/subscribers/{subscriberID}/plans
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://vbapi.vbasoftware.com/vbasoftware/subscribers/{subscriberID}/plans?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