APIs for VBASoftware
VBASoftware (v1)
- application/json
- text/json
- application/*+json
References Subscribers.Subscriber_ID value on the parent record.
Identifier assigned to the Group associated with this Flex account. This is automatically populated by right-clicking inside of the field and selecting 'Lookup' from the context menu.
Unique identifier assigned to the plan. This is automatically populated by right-clicking inside of the field and selecting 'Lookup' from the context menu.
Calendar year that is associated with the flex account. This is automatically populated by right-clicking inside of the field and selecting 'Lookup' from the context menu.
Date when the selected Flex account becomes/became active. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Indicates if this configuration would like to have flex claims auto created as part of the claims processing based on configured member responsibility amounts. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Identifies that the Flex account information is informational only. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Identifies if the amount enetered in to the Election field is a full or partial year election amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Specifies the Member's gross salary for the year associated with the Flex account.
Specifies the Member's net salary for the year associated with the Flex account.
References FlexVendorPurseStatus.Purse_Status for code list.
Date when the selected Flex account expires/expired. 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}/groups/{groupID}/plans/{planID}/flexes
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://vbapi.vbasoftware.com/vbasoftware/subscribers/{subscriberID}/groups/{groupID}/plans/{planID}/flexes' \
-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",
"plan_ID": "string",
"calendar_Year": "stri",
"effective_Date": "2019-08-24T14:15:22Z",
"auto_Create_Flex": true,
"cobrA_Rate": 0.1,
"card_Status": "string",
"custom_Election_Info_Only": true,
"election": 0.1,
"entry_Date": "2019-08-24T14:15:22Z",
"entry_User": "string",
"full_Election_For_Partial_Year": true,
"gross_Salary": 0.1,
"net_Salary": 0.1,
"purse_Status": "string",
"term_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/subscribers/{subscriberID}/groups/{groupID}/plans/{planID}/flexes
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://vbapi.vbasoftware.com/vbasoftware/subscribers/{subscriberID}/groups/{groupID}/plans/{planID}/flexes?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}/groups/{groupID}/plans/{planID}/flexes/{calendarYear}/{effectiveDate}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://vbapi.vbasoftware.com/vbasoftware/subscribers/{subscriberID}/groups/{groupID}/plans/{planID}/flexes/{calendarYear}/{effectiveDate}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'vbasoftware-database: string' \
-H 'x-api-key: YOUR_API_KEY_HERE'No response example