Subscriber Flex

Create SubscriberFlex

Creates a new SubscriberFlex

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
subscriberID
required
string

Subscriber ID

groupID
required
string

Group ID

planID
required
string

Plan ID

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
subscriber_ID
required
string [ 1 .. 9 ] characters

References Subscribers.Subscriber_ID value on the parent record.

group_ID
required
string [ 1 .. 20 ] characters

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.

plan_ID
required
string [ 1 .. 20 ] characters

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
required
string [ 1 .. 4 ] characters

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.

effective_Date
required
string <date-time>

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.

auto_Create_Flex
required
boolean

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.

cobrA_Rate
number or null <double>

Identifies the COBRA rate of the Flex account.

card_Status
string or null <= 32 characters

Identifies the status of the Member's Flex account card.

custom_Election_Info_Only
required
boolean

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.

election
number or null <double>

Specifies the Member's election amount toward the Flex account.

entry_Date
string <date-time>

Date when the record was first added to the system.

entry_User
string or null <= 20 characters

User that first added the record to the system.

full_Election_For_Partial_Year
required
boolean

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.

gross_Salary
number or null <double>

Specifies the Member's gross salary for the year associated with the Flex account.

net_Salary
number or null <double>

Specifies the Member's net salary for the year associated with the Flex account.

purse_Status
string or null <= 32 characters

References FlexVendorPurseStatus.Purse_Status for code list.

term_Date
required
string <date-time>

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.

update_Date
string <date-time>

Date when the record was last updated in the system.

update_User
string or null <= 20 characters

User that last updated the record in the system.

Responses
200

Success

401

Unauthorized

post/subscribers/{subscriberID}/groups/{groupID}/plans/{planID}/flexes
Request samples
{
  • "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"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List SubscriberFlex

Lists all SubscriberFlex for the given subscriberID and groupID and planID

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
subscriberID
required
string

Subscriber ID

groupID
required
string

Group ID

planID
required
string

Plan ID

query Parameters
page
integer <int32>
Default: 1

Page

pageSize
integer <int32>
Default: 100

Page Size

sortBy
string

Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., 'Property1:desc,Property2:asc,Property3:asc' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/subscribers/{subscriberID}/groups/{groupID}/plans/{planID}/flexes
Request samples 
Response samples 
No sample
Get SubscriberFlex
Gets SubscriberFlex


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
groupID
required
string
Group ID


 
planID
required
string
Plan ID


 
calendarYear
required
string
Calendar Year


 
effectiveDate
required
string <date-time> 
Effective Date


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/subscribers/{subscriberID}/groups/{groupID}/plans/{planID}/flexes/{calendarYear}/{effectiveDate}
Request samples 
Response samples 
No sample
Update SubscriberFlex
Updates a specific SubscriberFlex.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
groupID
required
string
Group ID


 
planID
required
string
Plan ID


 
calendarYear
required
string
Calendar Year


 
effectiveDate
required
string <date-time> 
Effective Date


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
subscriber_ID
required
string  [ 1 .. 9 ] characters 
References Subscribers.Subscriber_ID value on the parent record.


 
group_ID
required
string  [ 1 .. 20 ] characters 
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.


 
plan_ID
required
string  [ 1 .. 20 ] characters 
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
required
string  [ 1 .. 4 ] characters 
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.


 
effective_Date
required
string <date-time> 
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.


 
auto_Create_Flex
required
boolean
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.


 
cobrA_Rate
number or null <double> 
Identifies the COBRA rate of the Flex account.


 
card_Status
string or null  <= 32 characters 
Identifies the status of the Member's Flex account card.


 
custom_Election_Info_Only
required
boolean
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.


 
election
number or null <double> 
Specifies the Member's election amount toward the Flex account.


 
entry_Date
string <date-time> 
Date when the record was first added to the system.


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system.


 
full_Election_For_Partial_Year
required
boolean
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.


 
gross_Salary
number or null <double> 
Specifies the Member's gross salary for the year associated with the Flex account.


 
net_Salary
number or null <double> 
Specifies the Member's net salary for the year associated with the Flex account.


 
purse_Status
string or null  <= 32 characters 
References FlexVendorPurseStatus.Purse_Status for code list.


 
term_Date
required
string <date-time> 
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.


 
update_Date
string <date-time> 
Date when the record was last updated in the system.


 
update_User
string or null  <= 20 characters 
User that last updated the record in the system.


 
Responses 
200
Success


401
Unauthorized


put/subscribers/{subscriberID}/groups/{groupID}/plans/{planID}/flexes/{calendarYear}/{effectiveDate}
Request samples 
{
  • "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"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete SubscriberFlex
Deletes an SubscriberFlex


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
groupID
required
string
Group ID


 
planID
required
string
Plan ID


 
calendarYear
required
string
Calendar Year


 
effectiveDate
required
string <date-time> 
Effective Date


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/subscribers/{subscriberID}/groups/{groupID}/plans/{planID}/flexes/{calendarYear}/{effectiveDate}
Request samples 
Create or Update Batch SubscriberFlex
Create or Update multiple SubscriberFlex at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
groupID
required
string
Group ID


 
planID
required
string
Plan ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
subscriber_ID
required
string  [ 1 .. 9 ] characters 
References Subscribers.Subscriber_ID value on the parent record.


 
group_ID
required
string  [ 1 .. 20 ] characters 
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.


 
plan_ID
required
string  [ 1 .. 20 ] characters 
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
required
string  [ 1 .. 4 ] characters 
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.


 
effective_Date
required
string <date-time> 
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.


 
auto_Create_Flex
required
boolean
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.


 
cobrA_Rate
number or null <double> 
Identifies the COBRA rate of the Flex account.


 
card_Status
string or null  <= 32 characters 
Identifies the status of the Member's Flex account card.


 
custom_Election_Info_Only
required
boolean
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.


 
election
number or null <double> 
Specifies the Member's election amount toward the Flex account.


 
entry_Date
string <date-time> 
Date when the record was first added to the system.


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system.


 
full_Election_For_Partial_Year
required
boolean
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.


 
gross_Salary
number or null <double> 
Specifies the Member's gross salary for the year associated with the Flex account.


 
net_Salary
number or null <double> 
Specifies the Member's net salary for the year associated with the Flex account.


 
purse_Status
string or null  <= 32 characters 
References FlexVendorPurseStatus.Purse_Status for code list.


 
term_Date
required
string <date-time> 
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.


 
update_Date
string <date-time> 
Date when the record was last updated in the system.


 
update_User
string or null  <= 20 characters 
User that last updated the record in the system.


 
Responses 
207
Success


401
Unauthorized


put/subscribers/{subscriberID}/groups/{groupID}/plans/{planID}/flexes-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}