APIs for VBASoftware
VBASoftware (v1)
Download OpenAPI description
Languages
Servers
VBAPI VBASoftware
https://vbapi.vbasoftware.com/vbasoftware/
Bodyrequired
- application/json
- text/json
- application/*+json
References GroupContract.Group_ID value on the parent record.
References GroupContract.Division_ID value on the parent record.
References GroupContract.Coverage_Start value on the parent record. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Identifies the banking account associated with the selected contract.
When this option is selected, adjudication to mark every claim as 'Advice to Pay' (ATP). Advice to Pay claims do not produce check records when processed. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Indicates if interest is to be calculated for this contract plan during check processing. Note: This field is marked as NOT NULL in the database and therefore required by the API.
For ACH payments, Indicates if interest is to be calculated for this contract plan during check processing. Note: This field is marked as NOT NULL in the database and therefore required by the API.
For ACH payments, If interest is to be calculated, this value determines the minimum interest that can be applied. Any interst calculated below this number is ignored.
For ACH payments, Indicates if interest is to be calculated by: N - In Network or O - Out of Network. Leave this blank if interest applies to both.
For ACH payments, Flag indicating if interest should be calculated on adjustment claims. Note: This field is marked as NOT NULL in the database and therefore required by the API.
For ACH payments, Indicates what field will be used for interest calculation: B - Billed Amount, A - Allowed Amount or P - Paid Amount.
For ACH payments, Indicates the interest percentage to be applied during interest calculations.
For ACH payments, This is the frequency of "Calc_Interest_Prompt_Pay_Type" for determining if interest is applicable.
For ACH payments, This is the "Calc_Interest_Prompt_Pay_Freq" in number of: D - Days, M - Months or Y - Years.
If interest is to be calculated, this value determines the minimum interest that can be applied. Any interst calculated below this number is ignored.
Indicates if interest is to be calculated by: N - In Network or O - Out of Network. Leave this blank if interest applies to both.
Flag indicating if interest should be calculated on adjustment claims. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Indicates what field will be used for interest calculation: B - Billed Amount, A - Allowed Amount or P - Paid Amount.
Indicates the interest percentage to be applied during interest calculations.
This is the frequency of "Calc_Interest_Prompt_Pay_Type" for determining if interest is applicable.
This is the "Calc_Interest_Prompt_Pay_Freq" in number of: D - Days, M - Months or Y - Years.
For flex, determines the Dependent Contribution amount (or Pct if "Dependent_Contribution_Pct" is flagged)
For flex, notes if the amount entered into "Dependent_Contribution" is a percent or flat amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.
This is the day number of the week that disability claims created through the disability advisor will run through. This allows a disability claim with an ETD that ends in the middle of a week to be pushed through the end of that week if needed.
For flex, determines the Employee Contribution amount (or Pct if "Employee_Contribution_Pct" is flagged)
For flex, notes if the amount entered into "Employee_Contribution" is a percent or flat amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.
This is the age of the subscribers on the day based on "End_Coverage_Age_Type" before benefits are no longer eligible.
The type of age in years entered in "End_Coverage_Age" by type: EXACTDATE - Age Exact Date, BEGINMONTH - Age at Beginning of month, ENDMONTH - Age at End of month, BEGINYEAR - Age at the beginning of the year, or ENDYEAR - Age at the End of the year.
Indicates a federal exemption as part of the selected contract. Note: This field is marked as NOT NULL in the database and therefore required by the API.
indicates a medicare exemption as part of the selected contract. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Indicates a social security exemption as part of the selected contract. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Indicates a state exemption as part of the selected contract. Note: This field is marked as NOT NULL in the database and therefore required by the API.
For disability claims, this indicates the minimum benefit (weekly for STD plans or monthly for LTD plans).
Premium Billing setting that holds the premiums paid through for a selection of contracted subscribers.
Notes if Disability Claims should Prorate the FICA tax based on the disability payment duration. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Information fields used to hold RX information on this Contract Plan for reporting and interfaces.
Information fields used to hold RX information on this Contract Plan for reporting and interfaces.
Information fields used to hold RX information on this Contract Plan for reporting and interfaces.
Information fields used to hold RX information on this Contract Plan for reporting and interfaces.
Information fields used to hold RX information on this Contract Plan for reporting and interfaces.
Information fields used to hold RX information on this Contract Plan for reporting and interfaces.
Flag to indicate if this plan on this contract is a retirement plan. This is information only. Note: This field is marked as NOT NULL in the database and therefore required by the API.
If "Use_Salary_Pct" option is enabled, this indicatres the percent of salary.
Indicates if the tax day limitations are by day or calendar months. The database default for this field is '1'. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Used on the front end to indicate if the plan options should be shown to the user, has not backend functional impact. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Indicates that disability should be based upon salary percentage. 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}/divisions/{divisionID}/contracts/{coverageStart}/plans
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://vbapi.vbasoftware.com/vbasoftware/groups/{groupID}/divisions/{divisionID}/contracts/{coverageStart}/plans' \
-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",
"division_ID": "string",
"coverage_Start": "2019-08-24T14:15:22Z",
"plan_ID": "string",
"account_Key": 0,
"advice_To_Pay": true,
"bpl": "string",
"billing_Basis": "s",
"calc_Interest": true,
"calc_Interest_ACH": true,
"calc_Interest_ACH_Min": 0.1,
"calc_Interest_ACH_Network_Option": "string",
"calc_Interest_ACH_On_Adj": true,
"calc_Interest_ACH_Option": "string",
"calc_Interest_ACH_Pct": 0.1,
"calc_Interest_ACH_Prompt_Pay_Freq": 0,
"calc_Interest_ACH_Prompt_Pay_Type": "s",
"calc_Interest_Min": 0.1,
"calc_Interest_Network_Option": "string",
"calc_Interest_On_Adj": true,
"calc_Interest_Option": "string",
"calc_Interest_Pct": 0.1,
"calc_Interest_Prompt_Pay_Freq": 0,
"calc_Interest_Prompt_Pay_Type": "s",
"dependent_Contribution": 0.1,
"dependent_Contribution_Pct": true,
"disability_Pay_Through_Day": 0,
"employee_Contribution": 0.1,
"employee_Contribution_Pct": true,
"end_Coverage_Age": 0,
"end_Coverage_Age_Type": "string",
"entry_Date": "2019-08-24T14:15:22Z",
"entry_User": "string",
"exempt_Federal": true,
"exempt_Medicare": true,
"exempt_SocSec": true,
"exempt_State": true,
"federal_Tax_Day_Limit": 0,
"federal_Wage_Limit": 0.1,
"locator": "string",
"medicare_Tax_Day_Limit": 0,
"medicare_Wage_Limit": 0.1,
"minimum_Benefit": 0.1,
"paid_Through": "2019-08-24T14:15:22Z",
"payor_ID": "string",
"prorate_FICA": true,
"rX_BIN": "string",
"rX_CS_Contact": "string",
"rX_CS_Phone": "string",
"rX_GRP": "string",
"rX_Name": "string",
"rX_PCN": "string",
"retirement_Plan": true,
"salary_Pct": 0.1,
"socSec_Tax_Day_Limit": 0,
"socSec_Wage_Limit": 0.1,
"state_Tax_Day_Limit": 0,
"state_Wage_Limit": 0.1,
"tax_Day_Limit_Type": 0,
"update_Date": "2019-08-24T14:15:22Z",
"update_User": "string",
"use_Plan_Options": true,
"use_Salary_Pct": true,
"volume": 0.1,
"volume_Max": 0.1,
"volume_Min": 0.1,
"pay_To_Subscriber_Payee_ID": "string"
}'Response
No response example- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/groups/{groupID}/divisions/{divisionID}/contracts/{coverageStart}/plans
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://vbapi.vbasoftware.com/vbasoftware/groups/{groupID}/divisions/{divisionID}/contracts/{coverageStart}/plans?page=1&pageSize=100&sortBy=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'vbasoftware-database: string' \
-H 'x-api-key: YOUR_API_KEY_HERE'Response
No response example- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/groups/{groupID}/divisions/{divisionID}/plans-no-contracts
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://vbapi.vbasoftware.com/vbasoftware/groups/{groupID}/divisions/{divisionID}/plans-no-contracts' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'vbasoftware-database: string' \
-H 'x-api-key: YOUR_API_KEY_HERE'Response
No response example