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.
User defined Plan Year value for this accumulator period. Should denote the values in From_Date and Thru_Date. Example: Plan Year "CY2009" would be 1/1/2009 - 12/31/2009.
If an Ex_Code should be applied when a claim is identified for carry over, place that here.
If this Plan Year is specific to a Plan Type, you would denote that here. Normally no value is set for standard accumulation.
Indicates if this Plan Year has 4th quarter carry-over. Note: This field is marked as NOT NULL in the database and therefore required by the API.
When accumulators are carried over they are bucketed into a single Benefit Code (typically a shell Benefit Code to catch the carry-over dollars).
Indicates if carry-over applies to Deductible. Note: This field is marked as NOT NULL in the database and therefore required by the API.
If this Plan Year has 4th quarter carrry-over, this would indiate the dates, inside From_Date and Thru_Date, that signify the 4th quarter carry-over period.
Indicates if the carry-over applies to Member level accumulators. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Indicates if carry-over applies to Out of Pocket. Note: This field is marked as NOT NULL in the database and therefore required by the API.
If Out of Pocket carry-over is flagged, this identifies what constitutes Out of Pocket (Deductible, Co-Ins, Co-Pay).
Indicates which Plan Year these carry-over accumulators will carry over to (typically a plan year on the other side of the carry-over period).
Indicates if the carry-over applies to the entire Family for accumulators. Note: This field is marked as NOT NULL in the database and therefore required by the API.
If this Plan Year has 4th quarter carrry-over, this would indiate the dates, inside From_Date and Thru_Date, that signify the 4th quarter carry-over period.
- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/groups/{groupID}/divisions/{divisionID}/plan-years
- 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}/plan-years' \
-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",
"plan_Year": "string",
"entry_Date": "2019-08-24T14:15:22Z",
"entry_User": "string",
"ex_Code": "string",
"from_Date": "2019-08-24T14:15:22Z",
"plan_Type": "string",
"qtr4_Accum": true,
"qtr4_Benefit_Code": "string",
"qtr4_Deductible": true,
"qtr4_From_Date": "2019-08-24T14:15:22Z",
"qtr4_Member": true,
"qtr4_Out_Of_Pocket": true,
"qtr4_Out_Of_Pocket_Type": "string",
"qtr4_PlanYear": "string",
"qtr4_Subscriber": true,
"qtr4_Thru_Date": "2019-08-24T14:15:22Z",
"thru_Date": "2019-08-24T14:15:22Z",
"update_Date": "2019-08-24T14:15:22Z",
"update_User": "string"
}'No response example- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/groups/{groupID}/divisions/{divisionID}/plan-years
- 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}/plan-years?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}/plan-years/{planYear}
- 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}/plan-years/{planYear}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'vbasoftware-database: string' \
-H 'x-api-key: YOUR_API_KEY_HERE'No response example