APIs for VBASoftware
VBASoftware (v1)
- application/json
- text/json
- application/*+json
References the Plans.Plan_ID on the parent record. Must be a plan with a plan type flagged as Flex.
The numeric calendar year for this flex period. For example, 2022.
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.
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.
References ContributionSchedule.Contribution_Schedule to define the employer contribution schedule for this flex offering.
The effective date for this flex period. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Notes the date that is the start date that employer contribution schedule will build upon to lay out the contributions for the flex period.
Notes the date that is the start date that payment schedule will build upon to lay out the payment for the flex period.
Notes the date that is the start date that reimbursement schedule will build upon to lay out the reimbursments for the flex period.
For EDI processing and integrations, notes the external flex vendor used for procesisng (typically card swipes).
The grace period value based on "Grace_Period_Type" for how long you have to process a flex claim after the term date.
Combined with "Grace_Period", notes the grace period in: D - Days or M - Months.
The minimum payment that can be applied during flex claims processing.
References PaymentSchedule.Payment_Schedule to define the payment schedule for this flex offering.
References ReimburseSchedule.Reimburse_Schedule to define the reimbursement schedule for this flex offering.
The amount of flex contribution that can be rolled over to a subsquent flex offering on this same group.
The submit period value based on "Submit_Period_Type" for how long you have to submit a flex claim after the term date.
Combined with "Submit_Period", notes the submission period in: D - Days or M - Months.
The term date for this flex period. Note: This field is marked as NOT NULL in the database and therefore required by the API.
- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/groups/{groupID}/flexes
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
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"
}'No response example- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/groups/{groupID}/flexes
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://vbapi.vbasoftware.com/vbasoftware/groups/{groupID}/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/groups/{groupID}/flexes/{planID}/{calendarYear}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://vbapi.vbasoftware.com/vbasoftware/groups/{groupID}/flexes/{planID}/{calendarYear}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'vbasoftware-database: string' \
-H 'x-api-key: YOUR_API_KEY_HERE'No response example