APIs for VBASoftware
VBASoftware (v1)
- application/json
- text/json
- application/*+json
Unique identifier for each Volume configuration. Note: This field is marked as NOT NULL in the database and therefore required by the API.
When configuration is Benefit specific, fill this in. When empty, applies to entire Group/Division/Plan.
Based on volume type, this settings determines the volume. Note: This field is marked as NOT NULL in the database and therefore required by the API.
When configuration is Division specific, fill this in. When empty, applies to the entire Group.
When configuration is Plan specific, fill this in. When empty, applies to entire Group/Division.
Based on volume type, this settings determines the volume. Note: This field is marked as NOT NULL in the database and therefore required by the API.
This is a User definable field to name the volume being entered.
Based on volume type, this settings determines the volume.
Based on volume type, this settings determines the volume.
This value indicates what setting is used to calculate volume. The fileds that reference this setting are noted and drive the specific volume type. Reference VBASoftware application documentation for detailed explanation.
- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/groups/{groupID}/volumes
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://vbapi.vbasoftware.com/vbasoftware/groups/{groupID}/volumes' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-H 'vbasoftware-database: string' \
-H 'x-api-key: YOUR_API_KEY_HERE' \
-d '{
"groupVolume_Key": 0,
"benefit_Code": "string",
"dist_Volume_Amount": 0.1,
"dist_Volume_Pct": true,
"division_ID": "string",
"effective_Date": "2019-08-24T14:15:22Z",
"entry_Date": "2019-08-24T14:15:22Z",
"entry_User": "string",
"gI_Volume_Max": 0.1,
"gI_Volume_Min": 0.1,
"group_ID": "string",
"plan_ID": "string",
"term_Date": "2019-08-24T14:15:22Z",
"update_Date": "2019-08-24T14:15:22Z",
"update_User": "string",
"use_Dist_Volume": true,
"volume": 0.1,
"volume_ID": "string",
"volume_Max": 0.1,
"volume_Min": 0.1,
"volume_Round_Precision": 0,
"volume_Round_Type": "string",
"volume_Type": "string",
"volume_Type_From": 0,
"volume_Type_Pct": 0.1,
"volume_Type_Thru": 0
}'No response example- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/groups/{groupID}/volumes
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://vbapi.vbasoftware.com/vbasoftware/groups/{groupID}/volumes?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-volumes-nested
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://vbapi.vbasoftware.com/vbasoftware/groups-volumes-nested?groupID=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'vbasoftware-database: string' \
-H 'x-api-key: YOUR_API_KEY_HERE'No response example