APIs for VBASoftware
VBASoftware (v1)
- application/json
- text/json
- application/*+json
Checking this option indicates that the benefit is covered only when services are rendered as the result of an accident. On the Claim Entry screen, there are options to that specify that a claim is the result of an accident. If a claim is processed against this Benefit Code without one of the accident options picked on the claim, the claim will automatically 'Deny' or 'Pend' based on the Ex Code defined on the VBA Control Panel.
When checked, if the PlanBenefit_Override_Network_ID is filled out on companydata and the claim is currently out of network, change the Network ID to the PlanBenefit Override Network ID value. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Total annual amount that the Plan will pay both In Network and Out of Network.
Total annual amount that the Member pays both In Network and Out of Network.
Applies the In-Network Co-Insurance amount toward the satisfaction of the Out-of-Network Co-Insurance maximum. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Applies the Out-of-Network Co-Insurance amount toward the satisfaction of the In-Network Co-Insurance maximum. Note: This field is marked as NOT NULL in the database and therefore required by the API.
When active, this will let the system know to limit the amount of co-insurance that applies to IN from OON by the Max. Note: This field is marked as NOT NULL in the database and therefore required by the API.
The max with which the co-insurance is limited by when CoIns_Out To In Limit is selected.
This option is informational only. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Identifies whether the Benefit Code is covered for this Plan. This can be populated from the 'Plan' screen. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Checking this option indicates that the Benefit is covered only when services are rendered by an In-Network provider. If a claim is processed against this Benefit Code as Out of Network, the claim will apply the “Covered In-Network Only“ Ex Code defined on the VBA Control Panel.
Applies the In-Network deductible amount toward the satisfaction of the Out-of-Network deductible. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Applies the Out-of-Network deductible amount toward the satisfaction of the In-Network deductible. Note: This field is marked as NOT NULL in the database and therefore required by the API.
When active, this will let the system know to limit the amount of deductible that applies to IN from OON by the Max. Note: This field is marked as NOT NULL in the database and therefore required by the API.
The max with which the deducible is limited by when Ded_Out To In Limit is selected.
This flag determines if adjudication calculates the Deductible before the CoPay is calculated. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Identifies whether the Benefit Code is excluded for this Plan. This can be populated from the 'Plan' screen. Note: This field is marked as NOT NULL in the database and therefore required by the API.
This option is informational only. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Indicates that the Plan Benefit amount is included in the Plan level Maximum calculations. If this option is not specified, the Benefit is treated as a carve-out and will calculate to its own total.
Indicates that the Plan Benefit amount is included in the Plan level Co-Insurance calculations. If this option is not specified, the Benefit is treated as a carve-out and will calculate to its own total.
Indicates that the Plan Benefit amount is included in the Plan level Deductible calculations. If this option is not specified, the Benefit is treated as a carve-out and will calculate to its own total.
Indicates that the Plan Benefit amount is included in the Plan level Out of Pocket calculations. If this option is not specified, the Benefit is treated as a carve-out and will calculate to its own total.
Indicates if this benefits applies to the Elimination Period for claims processed under this plan. This value would only apply if the Plan itself is configured with an Elimination Period. This indicator will be ON by default so that the user has to specifically exclude. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Indicates if this benefit applies to the waiting period. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Indicates it Inflation calculation should be applied Note: This field is marked as NOT NULL in the database and therefore required by the API.
Not sure about this, but I think what I want is to have one benefit defined on any plan that has a LTC Plan_Type. You can only have one and must have one. This is like the STD or LTD benefit on disability. Its the benefit we use to do all the base benefit payment stuff. Note: This field is marked as NOT NULL in the database and therefore required by the API.
The start of the selection range for members taking this plan and choosing their daily benefit.
The increment of each option in the range between the from and thru. If empty, the member can manually select a value between the from / thru range.
The end of the selection range for members taking this plan and choosing their daily benefit.
This is the type of daily benefit defined for this plan. The values are: A - a flat daily benefit enforced by the plan. B - member selected value utilizing the daily benefit range/increment settings.
identify that this is an inflation benefit. Would still use Covered/Rider to determine if the inflation offering is optional or not. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Indicates if the inflation interest is simple (0) or compunded (1). Note: This field is marked as NOT NULL in the database and therefore required by the API.
this is the value for the Inflation_Frequency_Type (i.e. 1 Year, 30 Days, 6 Months, etc.)
indicates when the Inflation_Frequency is calculated from: GROUP - Group Anniversary Enroll DIV - Division Anniversary Enroll MEMBER - Member Anniversary Enroll PLAN - Initial Plan Enroll
Indicates the frequency of inflation increases. The values are: D - Days M - Months Y - Years
This value is based on Inflation_Limit_Type. For A, this is the flat cap on inflation. For B, this is the multiple of Limit defined as a cap (i.e. 2 for 2x limit or 2.5 for 2.5x limit)
the type of limit cap. This filed only shows if Inflation_Type = B. The 2 options are: A - Flat Cap B - Multipl of Limit
drop down list of inflation types that change options that can be filled in. The choices would be: A - Simple Inflation B - Inflation With Cap C - Inflation No Cap
The selectable range of days the member can pick for calculations based on days.
The selectable range of days the member can pick for calculations based on days.
the increment of options the user can select within the max range. Empty value here means it is a free from entry of max between the range.
Lifetime Max calculation type and will dicatate the max rules applied. Valid values are: STANDARD - DBM x 365 days x Lifetime Max Years selected LMDAYS - DBM x Lifetime Max Days selected FLAT - Lifetime Max Amount selected and not based on calculation LMMONTHS - MBA x 12 Months x Lifetime Max Years selected
the selectable range of years the member can pick for calculations based on years.
the selectable range of years the member can pick for calculations based on years.
The start of the selection range for members taking this plan and choosing their monthly benefit.
The increment of each option in the range between the from and thru. If empty, the member can manually select a value between the from / thru range.
The end of the selection range for members taking this plan and choosing their monthly benefit.
This is the type of monthly benefit defined for this plan. The values are: A - a flat monthly benefit enforced by the plan. B - member selected value utilizing the monthly benefit range/increment settings.
This is the benefit code that this benefit will be a Pct of.
Indicates if this Benefit Code is shared across multiple members of the family AND can be used in Lifetime Max calculations to determine if the same benefit across multiple plans (same plan type) could apply together. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Indicates if we should use this benefit DBA configuration rather than the Plan DBA. Note: This field is marked as NOT NULL in the database and therefore required by the API.
This indicates if the PlanBenefit level LBM logic should be used rather thant he parent Plan LBM settings. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Indicates if we should use this benefit MBA configuration rather than the Plan MBA. Note: This field is marked as NOT NULL in the database and therefore required by the API.
This is an indicator for whether this PlanBenefit will utilize the Daily Benefit Amount or the Monthly Benefit Amount.
identifies that this benefit amount is calculated as a percent of another benefit Note: This field is marked as NOT NULL in the database and therefore required by the API.
Total lifetime amount that the Plan will pay both In Network and Out of Network.
Total lifetime amount that the Member pays both In Network and Out of Network.
This option is informational only. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Total deductible amount for the Member both In Network and Out of Network.
Applies the In-Network Out-of-Pocket amount toward the satisfaction of the Out-of-Network Out-of-Pocket maximum. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Applies the Out-of-Network Out-of-Pocket amount toward the satisfaction of the In-Network Out-of-Pocket maximum. Note: This field is marked as NOT NULL in the database and therefore required by the API.
When active, this will let the system know to limit the amount of out of pocket that applies to IN from OON by the Max. Note: This field is marked as NOT NULL in the database and therefore required by the API.
The max with which the out of pocket is limited by when OOP_Out To In Limit is selected.
This option is informational only. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Indicates that the selected Benefit applies to Primary Care Physician only. If a claim is processed against this Benefit Code without a PCP, the claim will apply the “PCP Only“ Ex Code defined on the VBA Control Panel. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Identifies if this Benefit is a parent benefit for purposes of cascading benefits. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Assigns an Ex Code that can be applied to adjudicated Subscriber claims.
While active, the assigned Ex Code will be applied to any adjudicated Subscriber claims.
Identifies whether the Benefit Code is a rider for this Plan. This can be populated from the 'Plan' screen. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Total deductible amount for the Family both In Network and Out of Network.
Indicates that the Plan Benefit Co-Insurance amounts will abide by the Plan level amounts. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Indicates that the Plan Benefit Deductible amounts will abide by the Plan level amounts. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Indicates that the Plan Benefit Maximums will abide by the Plan level amounts. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Indicates that the Plan Benefit Out of Pocket amounts will abide by the Plan level amounts. Note: This field is marked as NOT NULL in the database and therefore required by the API.
- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/plans/{planID}/benefits
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://vbapi.vbasoftware.com/vbasoftware/plans/{planID}/benefits' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-H 'vbasoftware-database: string' \
-H 'x-api-key: YOUR_API_KEY_HERE' \
-d '{
"plan_ID": "string",
"benefit_Code": "string",
"accident_Only": "s",
"always_Pay_In_Network": true,
"annual_Max": 0.1,
"annual_Max_Member": 0.1,
"annual_Max_Net": 0.1,
"annual_Max_Net_Member": 0.1,
"annual_Max_OON": 0.1,
"annual_Max_OON_Member": 0.1,
"coIns_In_To_Out": true,
"coIns_Max_Mem": 0.1,
"coIns_Max_Net_Mem": 0.1,
"coIns_Max_Net_Sub": 0.1,
"coIns_Max_OON_Mem": 0.1,
"coIns_Max_OON_Sub": 0.1,
"coIns_Max_Sub": 0.1,
"coIns_Out_To_In": true,
"coIns_Out_To_In_Limit": true,
"coIns_Out_To_In_Limit_Max": 0.1,
"coverage_24Hour": true,
"covered": "s",
"covered_In_Net_Only": "s",
"ded_In_To_Out": true,
"ded_Out_To_In": true,
"ded_Out_To_In_Limit": true,
"ded_Out_To_In_Limit_Max": 0.1,
"deductible_Before_CoPay": true,
"effective_Date": "2019-08-24T14:15:22Z",
"entry_Date": "2019-08-24T14:15:22Z",
"entry_User": "string",
"excluded": "s",
"hospital_1stDay": true,
"include_Amt_In_Plan": "s",
"include_CoIns_In_Plan": "s",
"include_Ded_In_Plan": "s",
"include_OOP_In_Plan": "s",
"ltC_Applies_To_Elimination_Period": true,
"ltC_Applies_To_WP": true,
"ltC_Apply_Inflation": true,
"ltC_Base_Benefit": true,
"ltC_Daily_Benefit": 0.1,
"ltC_Daily_Benefit_Range_From": 0.1,
"ltC_Daily_Benefit_Range_Increment": 0.1,
"ltC_Daily_Benefit_Range_Thru": 0.1,
"ltC_Daily_Benefit_Type": "string",
"ltC_Inflation_Benefit": true,
"ltC_Inflation_Compound": true,
"ltC_Inflation_Frequency": 0,
"ltC_Inflation_Frequency_Start": "string",
"ltC_Inflation_Frequency_Type": "string",
"ltC_Inflation_Limit": 0.1,
"ltC_Inflation_Limit_Type": "string",
"ltC_Inflation_Pct": 0.1,
"ltC_Inflation_Type": "string",
"ltC_Lifetime_Max_Days_From": 0,
"ltC_Lifetime_Max_Days_Thru": 0,
"ltC_Lifetime_Max_From": 0.1,
"ltC_Lifetime_Max_Increment": 0.1,
"ltC_Lifetime_Max_Thru": 0.1,
"ltC_Lifetime_Max_Type": "string",
"ltC_Lifetime_Max_Years_From": 0,
"ltC_Lifetime_Max_Years_Thru": 0,
"ltC_Monthly_Benefit": 0.1,
"ltC_Monthly_Benefit_Range_From": 0.1,
"ltC_Monthly_Benefit_Range_Increment": 0.1,
"ltC_Monthly_Benefit_Range_Thru": 0.1,
"ltC_Monthly_Benefit_Type": "string",
"ltC_Pct_Of_Benefit": 0.1,
"ltC_Pct_Of_Benefit_Code": "string",
"ltC_Shared_Benefit": true,
"ltC_Use_Benefit_DBA": true,
"ltC_Use_Benefit_Lifetime_Max": true,
"ltC_Use_Benefit_MBA": true,
"ltC_Use_Benefit_Type": "string",
"ltC_Use_Pct_Of_Benefit": true,
"lifetime_Max": 0.1,
"lifetime_Max_Member": 0.1,
"lifetime_Max_Net": 0.1,
"lifetime_Max_Net_Member": 0.1,
"lifetime_Max_OON": 0.1,
"lifetime_Max_OON_Member": 0.1,
"maternity": true,
"member_Ded_OON": 0.1,
"member_Ded_PPO": 0.1,
"member_Deductible": 0.1,
"ooP_Calc_Option": "string",
"ooP_In_To_Out": true,
"ooP_Max_Mem": 0.1,
"ooP_Max_Net_Mem": 0.1,
"ooP_Max_Net_Sub": 0.1,
"ooP_Max_OON_Mem": 0.1,
"ooP_Max_OON_Sub": 0.1,
"ooP_Max_Sub": 0.1,
"ooP_Out_To_In": true,
"ooP_Out_To_In_Limit": true,
"ooP_Out_To_In_Limit_Max": 0.1,
"occupational": true,
"pcP_Only": true,
"parent_Benefit": true,
"pend_Ex_Code": "string",
"pend_Flag": "s",
"rider": "s",
"subscriber_Ded_OON": 0.1,
"subscriber_Ded_PPO": 0.1,
"subscriber_Deductible": 0.1,
"term_Date": "2019-08-24T14:15:22Z",
"update_Date": "2019-08-24T14:15:22Z",
"update_User": "string",
"use_Plan_CoIns": "s",
"use_Plan_Ded": "s",
"use_Plan_Max": "s",
"use_Plan_OOP": "s",
"exclude_From_Surcharge": true
}'No response example- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/plans/{planID}/benefits
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://vbapi.vbasoftware.com/vbasoftware/plans/{planID}/benefits' \
-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/plans/{planID}/benefits/{benefitCode}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://vbapi.vbasoftware.com/vbasoftware/plans/{planID}/benefits/{benefitCode}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'vbasoftware-database: string' \
-H 'x-api-key: YOUR_API_KEY_HERE'No response example