Skip to content

Create GroupFlex

Request

Creates a new GroupFlex

Security
apiKeyAuth and bearerAuth
Path
groupIDstringrequired

Group ID

Headers
vbasoftware-databasestringrequired

Target database

Bodyapplication/jsonrequired
group_IDstring, [ 1 .. 20 ] charactersrequired

References Groups.Group_ID value on the parent record.

plan_IDstring, [ 1 .. 20 ] charactersrequired

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

calendar_Yearstring, [ 1 .. 4 ] charactersrequired

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

contribution_Amountnumber or null, (double)

This is the employer contribution amount.

contribution_Pctbooleanrequired

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_Typestring 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_Schedulestring or null, <= 32 characters

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

effective_Datestring, (date-time)required

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_Datestring, (date-time)

Date when the record was first added to the system.

entry_Userstring or null, <= 20 characters

User that first added the record to the system.

first_Contribution_Datestring 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_Datestring 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_Datestring 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_Vendorstring or null, <= 32 characters

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

grace_Periodinteger 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_Typestring or null, <= 16 characters

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

max_Electionnumber or null, (double)

The Max Election a member can enter for this offering.

minimum_Paymentnumber or null, (double)

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

payment_Schedulestring or null, <= 32 characters

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

reimburse_Schedulestring or null, <= 32 characters

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

rollover_Amountnumber or null, (double)

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

submit_Periodinteger 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_Typestring or null, <= 16 characters

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

term_Datestring, (date-time)required

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_Datestring, (date-time)

Date when the record was last updated in the system.

update_Userstring or null, <= 20 characters

User that last updated the record in the system.

curl -i -X POST \
  'https://vbapi.vbasoftware.com/vbasoftware/groups/{groupID}/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 '{
    "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"
  }'

Responses

Success

Bodyapplication/json
dataobject
errorobject
debugobject
Response
{
  "data": { … },
  "error": { … },
  "debug": { … }
}