Group Flexes

Create GroupFlex

Creates a new GroupFlex

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
groupID
required
string

Group ID

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
group_ID
required
string [ 1 .. 20 ] characters

References Groups.Group_ID value on the parent record.

plan_ID
required
string [ 1 .. 20 ] characters

References the Plans.Plan_ID on the parent record. Must be a plan with a plan type flagged as Flex.

calendar_Year
required
string [ 1 .. 4 ] characters

The numeric calendar year for this flex period. For example, 2022.

contribution_Amount
number or null <double>

This is the employer contribution amount.

contribution_Pct
required
boolean

Indicates if the amount entered in "Contribution_Amount" is a percent or flat amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.

contribution_Pct_Type
string or null <= 16 characters

When "Contribution_Pct" is used, this notes what the contribution percentage is based upon: EMPELE - % of Employee Contribution, SALNET - % of Employee Net Salary, SALGROSS - % of Employee Gross Salary.

contribution_Schedule
string or null <= 32 characters

References ContributionSchedule.Contribution_Schedule to define the employer contribution schedule for this flex offering.

effective_Date
required
string <date-time>

The effective date for this flex period. Note: This field is marked as NOT NULL in the database and therefore required by the API.

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.

first_Contribution_Date
string or null <date-time>

Notes the date that is the start date that employer contribution schedule will build upon to lay out the contributions for the flex period.

first_Payment_Date
string or null <date-time>

Notes the date that is the start date that payment schedule will build upon to lay out the payment for the flex period.

first_Reimburse_Date
string or null <date-time>

Notes the date that is the start date that reimbursement schedule will build upon to lay out the reimbursments for the flex period.

flex_Vendor
string or null <= 32 characters

For EDI processing and integrations, notes the external flex vendor used for procesisng (typically card swipes).

grace_Period
integer or null <int32>

The grace period value based on "Grace_Period_Type" for how long you have to process a flex claim after the term date.

grace_Period_Type
string or null <= 16 characters

Combined with "Grace_Period", notes the grace period in: D - Days or M - Months.

max_Election
number or null <double>

The Max Election a member can enter for this offering.

minimum_Payment
number or null <double>

The minimum payment that can be applied during flex claims processing.

payment_Schedule
string or null <= 32 characters

References PaymentSchedule.Payment_Schedule to define the payment schedule for this flex offering.

reimburse_Schedule
string or null <= 32 characters

References ReimburseSchedule.Reimburse_Schedule to define the reimbursement schedule for this flex offering.

rollover_Amount
number or null <double>

The amount of flex contribution that can be rolled over to a subsquent flex offering on this same group.

submit_Period
integer or null <int32>

The submit period value based on "Submit_Period_Type" for how long you have to submit a flex claim after the term date.

submit_Period_Type
string or null <= 16 characters

Combined with "Submit_Period", notes the submission period in: D - Days or M - Months.

term_Date
required
string <date-time>

The term date for this flex period. 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/groups/{groupID}/flexes
Request samples
{
  • "group_ID": "string",
  • "plan_ID": "string",
  • "calendar_Year": "stri",
  • "contribution_Amount": 0.1,
  • "contribution_Pct": true,
  • "contribution_Pct_Type": "string",
  • "contribution_Schedule": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "first_Contribution_Date": "2019-08-24T14:15:22Z",
  • "first_Payment_Date": "2019-08-24T14:15:22Z",
  • "first_Reimburse_Date": "2019-08-24T14:15:22Z",
  • "flex_Vendor": "string",
  • "grace_Period": 0,
  • "grace_Period_Type": "string",
  • "max_Election": 0.1,
  • "minimum_Payment": 0.1,
  • "payment_Schedule": "string",
  • "reimburse_Schedule": "string",
  • "rollover_Amount": 0.1,
  • "submit_Period": 0,
  • "submit_Period_Type": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List GroupFlex

Lists all GroupFlex for the given groupID

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
groupID
required
string

Group 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/groups/{groupID}/flexes
Request samples 
Response samples 
No sample
Get GroupFlex
Gets GroupFlex


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
planID
required
string
Plan ID


 
calendarYear
required
string
Calendar Year


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/groups/{groupID}/flexes/{planID}/{calendarYear}
Request samples 
Response samples 
No sample
Update GroupFlex
Updates a specific GroupFlex.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
planID
required
string
Plan ID


 
calendarYear
required
string
Calendar Year


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
group_ID
required
string  [ 1 .. 20 ] characters 
References Groups.Group_ID value on the parent record.


 
plan_ID
required
string  [ 1 .. 20 ] characters 
References the Plans.Plan_ID on the parent record. Must be a plan with a plan type flagged as Flex.


 
calendar_Year
required
string  [ 1 .. 4 ] characters 
The numeric calendar year for this flex period. For example, 2022.


 
contribution_Amount
number or null <double> 
This is the employer contribution amount.


 
contribution_Pct
required
boolean
Indicates if the amount entered in "Contribution_Amount" is a percent or flat amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
contribution_Pct_Type
string or null  <= 16 characters 
When "Contribution_Pct" is used, this notes what the contribution percentage is based upon: EMPELE - % of Employee Contribution, SALNET - % of Employee Net Salary, SALGROSS - % of Employee Gross Salary.


 
contribution_Schedule
string or null  <= 32 characters 
References ContributionSchedule.Contribution_Schedule to define the employer contribution schedule for this flex offering.


 
effective_Date
required
string <date-time> 
The effective date for this flex period. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
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.


 
first_Contribution_Date
string or null <date-time> 
Notes the date that is the start date that employer contribution schedule will build upon to lay out the contributions for the flex period.


 
first_Payment_Date
string or null <date-time> 
Notes the date that is the start date that payment schedule will build upon to lay out the payment for the flex period.


 
first_Reimburse_Date
string or null <date-time> 
Notes the date that is the start date that reimbursement schedule will build upon to lay out the reimbursments for the flex period.


 
flex_Vendor
string or null  <= 32 characters 
For EDI processing and integrations, notes the external flex vendor used for procesisng (typically card swipes).


 
grace_Period
integer or null <int32> 
The grace period value based on "Grace_Period_Type" for how long you have to process a flex claim after the term date.


 
grace_Period_Type
string or null  <= 16 characters 
Combined with "Grace_Period", notes the grace period in: D - Days or M - Months.


 
max_Election
number or null <double> 
The Max Election a member can enter for this offering.


 
minimum_Payment
number or null <double> 
The minimum payment that can be applied during flex claims processing.


 
payment_Schedule
string or null  <= 32 characters 
References PaymentSchedule.Payment_Schedule to define the payment schedule for this flex offering.


 
reimburse_Schedule
string or null  <= 32 characters 
References ReimburseSchedule.Reimburse_Schedule to define the reimbursement schedule for this flex offering.


 
rollover_Amount
number or null <double> 
The amount of flex contribution that can be rolled over to a subsquent flex offering on this same group.


 
submit_Period
integer or null <int32> 
The submit period value based on "Submit_Period_Type" for how long you have to submit a flex claim after the term date.


 
submit_Period_Type
string or null  <= 16 characters 
Combined with "Submit_Period", notes the submission period in: D - Days or M - Months.


 
term_Date
required
string <date-time> 
The term date for this flex period. 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/groups/{groupID}/flexes/{planID}/{calendarYear}
Request samples 
{
  • "group_ID": "string",
  • "plan_ID": "string",
  • "calendar_Year": "stri",
  • "contribution_Amount": 0.1,
  • "contribution_Pct": true,
  • "contribution_Pct_Type": "string",
  • "contribution_Schedule": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "first_Contribution_Date": "2019-08-24T14:15:22Z",
  • "first_Payment_Date": "2019-08-24T14:15:22Z",
  • "first_Reimburse_Date": "2019-08-24T14:15:22Z",
  • "flex_Vendor": "string",
  • "grace_Period": 0,
  • "grace_Period_Type": "string",
  • "max_Election": 0.1,
  • "minimum_Payment": 0.1,
  • "payment_Schedule": "string",
  • "reimburse_Schedule": "string",
  • "rollover_Amount": 0.1,
  • "submit_Period": 0,
  • "submit_Period_Type": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete GroupFlex
Deletes an GroupFlex


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
planID
required
string
Plan ID


 
calendarYear
required
string
Calendar Year


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/groups/{groupID}/flexes/{planID}/{calendarYear}
Request samples 
Create or Update Batch GroupFlex
Create or Update multiple GroupFlex 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
groupID
required
string
Group ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
group_ID
required
string  [ 1 .. 20 ] characters 
References Groups.Group_ID value on the parent record.


 
plan_ID
required
string  [ 1 .. 20 ] characters 
References the Plans.Plan_ID on the parent record. Must be a plan with a plan type flagged as Flex.


 
calendar_Year
required
string  [ 1 .. 4 ] characters 
The numeric calendar year for this flex period. For example, 2022.


 
contribution_Amount
number or null <double> 
This is the employer contribution amount.


 
contribution_Pct
required
boolean
Indicates if the amount entered in "Contribution_Amount" is a percent or flat amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
contribution_Pct_Type
string or null  <= 16 characters 
When "Contribution_Pct" is used, this notes what the contribution percentage is based upon: EMPELE - % of Employee Contribution, SALNET - % of Employee Net Salary, SALGROSS - % of Employee Gross Salary.


 
contribution_Schedule
string or null  <= 32 characters 
References ContributionSchedule.Contribution_Schedule to define the employer contribution schedule for this flex offering.


 
effective_Date
required
string <date-time> 
The effective date for this flex period. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
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.


 
first_Contribution_Date
string or null <date-time> 
Notes the date that is the start date that employer contribution schedule will build upon to lay out the contributions for the flex period.


 
first_Payment_Date
string or null <date-time> 
Notes the date that is the start date that payment schedule will build upon to lay out the payment for the flex period.


 
first_Reimburse_Date
string or null <date-time> 
Notes the date that is the start date that reimbursement schedule will build upon to lay out the reimbursments for the flex period.


 
flex_Vendor
string or null  <= 32 characters 
For EDI processing and integrations, notes the external flex vendor used for procesisng (typically card swipes).


 
grace_Period
integer or null <int32> 
The grace period value based on "Grace_Period_Type" for how long you have to process a flex claim after the term date.


 
grace_Period_Type
string or null  <= 16 characters 
Combined with "Grace_Period", notes the grace period in: D - Days or M - Months.


 
max_Election
number or null <double> 
The Max Election a member can enter for this offering.


 
minimum_Payment
number or null <double> 
The minimum payment that can be applied during flex claims processing.


 
payment_Schedule
string or null  <= 32 characters 
References PaymentSchedule.Payment_Schedule to define the payment schedule for this flex offering.


 
reimburse_Schedule
string or null  <= 32 characters 
References ReimburseSchedule.Reimburse_Schedule to define the reimbursement schedule for this flex offering.


 
rollover_Amount
number or null <double> 
The amount of flex contribution that can be rolled over to a subsquent flex offering on this same group.


 
submit_Period
integer or null <int32> 
The submit period value based on "Submit_Period_Type" for how long you have to submit a flex claim after the term date.


 
submit_Period_Type
string or null  <= 16 characters 
Combined with "Submit_Period", notes the submission period in: D - Days or M - Months.


 
term_Date
required
string <date-time> 
The term date for this flex period. 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/groups/{groupID}/flexes-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}