APIs for VBASoftware
- Create or Update Batch Plans
VBASoftware (v1)
- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/plans/{planID}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
'https://vbapi.vbasoftware.com/vbasoftware/plans/{planID}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'vbasoftware-database: string' \
-H 'x-api-key: YOUR_API_KEY_HERE'- application/json
- text/json
- application/*+json
Total In-Network and Out of Network annual maximum the plan will pay out for the Familiy.
In-Network annual maximum that the plan will pay out for the Familiy.
Out of Network annual maximum that the plan will pay out for the Familiy.
Indicates if this plan allows auto-creation of Flex claims based on Group level configuration for flex auto-creation. Note: This field is marked as NOT NULL in the database and therefore required by the API.
No longer in use. All captiation logic and processing now resides in the capitation tables. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Default cash value when Policy & Forfeiture is used in enrollment.
Indicates whether In-Network Coinsurance amounts apply toward the satisfaction of Out of Network amounts. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Indicates whether Out of Network CoInsurance amounts apply toward the satisfaction of the In-Network amounts. 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.
Claim UCR percentage provided by Context. Required for Context claim edits and repricing.
Out of network claim UCR percentage provided by context. Required for Context claim edits and repricing.
Fee Selector provided by Context. Required for Context claim edits and repricing.
Out of network fee selector provided by context. Required for Context claim edits and repricing.
Medicare percentage provided by Context. Required for Context claim edits and repricing.
Out of network Medicare percentage provided by context. Required for Context claim edits and repricing.
Password provided by Context. Required for Context claim edits and repricing.
Payor type provided by context. Required for Context claim edits and repricing.
Out of network Payor type provided by context. Required for Context claim edits and repricing.
Percentage of change provided by context. Required for Context claim edits and repricing.
Out of network percentage of change provided by context. Required for Context claim edits and repricing.
When using Context4, the Plan Price is never allowed to exceed the Billed Price, it'll set it to the Billed Price. Note: This field is marked as NOT NULL in the database and therefore required by the API.
User ID provided by Context. Required for Context claim edits and repricing.
URL provided by Context. Required for Context claim edits and repricing.
URL delete provided by Context. Required for Context claim edits and repricing.
Indicates whether In-Network Deductible amounts apply toward the satisfaction of Out of Network amounts. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Indicates whether Out of Network Deductible amounts apply toward the satisfaction of In-Network amounts. 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.
Deault extended term value assigned in Policy & Forfeiture when used in enrollment.
Specifies that the number of Member level Coinsurance amounts should be used to satisfy the Family level Coinsurance amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Number of Members that must satisfy the Member level deductible before the Family level amount is considered met.
Specifies that the number of Member level deductible amounts should be used to satisfy the Family level deductible. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Number of Members that must satisfy the Member level deductible before the Family level amount is considered met.
Specifies that the number of Member level Out of Pocket amounts should be used to satisfy the Family level Out of Pocket amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Number of Members that must satisfy the Member level Out of Pocket before the Family level Out of Pocket is considered met.
Information field used in reporting to identify this plan as Flex Advance Fund. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Indicates what type of Flex account to be associated with the plan.
Default forfeiture status assigned when Policy & Forteiture is used in enrollment.
Waiting Period after an illness for Disability plans to start coverage.
Indicates whether the Disability plan includes a waiting period.
Waiting Period after an injury for Disability plans to start coverage.
Indicates if this Plan has Elimination Period rules. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Indicates if Waiver of Premium rules should apply for this plan. 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.
This is the elimination period value based on Elimination_Period_Type.
Indicates if the elimination period is per claim. By default the elimination period is per plan/policy. Note: This field is marked as NOT NULL in the database and therefore required by the API.
This is the type of Elimination Period rule to apply for this Plan. Values are: A - Calendar Days B - Service Days C - Special Service Days (one day equals a week of elimination period)
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.
Indicates if plans of the same plan type, and both flagged as joint policy, can share a "Total" lifetime max between both plans as long as both plans have selected a shared benefit. Note: This field is marked as NOT NULL in the database and therefore required by the API.
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 type/rules for LTC waiver of premium. Current Values are: A - 1st day of following month B - day of eligibility approval C - joint waiver D - survivorship waiver
Total lifetime amount that the Plan will pay both In Network and Out of Network for the Familiy.
Lifetime amount that the Plan will pay In Network for the Familiy.
Lifetime amount that the Plan will pay Out of Network for the Familiy.
Specifies the required age for maturity of policy inside enrollment.
Defines the age type for maturity based upon birth date or anniversary of enrollment.
Maximum number of weeks the specified Plan will pay Disability.
Indicates whether the waiting period is included in the Max Disability Weeks.
Total deductible amount to be credited back to each Member during adjudication.
Out of Network deductible amount to be credited back to each Member during adjudication.
In-Network deductible amount to be credited back to each Member during adjudication.
Total In-Network and Out of Network annual maximum the plan will pay out per Member.
In-Network annual maximum that the plan will pay out per Member.
Out of Network annual maximum that the plan will pay out per Member.
Total deductible amount for the Member both In Network and Out of Network.
Total In-Network and Out of Network lifetime maximum that the plan will pay out per Member.
In-Network lifetime maximum that the plan will pay out per Member.
Out of Network lifetime that the plan will pay out per Member.
Indicates whether In-Network Out of Pocket amounts apply toward the satisfaction of Out of Network amounts. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Total In-Network and Out of Network Out of Pocket maximum for the Member.
Total In-Network and Out of Network Out of Pocket maximum for the Family.
Indicates whether Out of Network Out of Pocket amounts apply toward the satisfaction of In-Network amounts. 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.
Identifies the Ex Code that will be applied based upon the Pend_Flag field.
Specifies if an Ex Code will be assigned, which will apply to all claims adjudicated for this plan. The Ex Code can be an informational, denial, or pend code. All ExCodes impact adjudication.
Identifies the Type of Plan (medical, dental, etc.). Keep in mind that Accumulators are tied to 'Plan Type' not the plan itself.
Defines the type of grace period. Restricted to units of days.
Default policy status assigned when Policy & Forteiture is used in enrollment.
Identifies the Ex Code that will be applied to disability claims falling within the provided range.
No longer in use. Pre-Ex processing has been moved to a more detailed structure in PlanPrex tables.
Defines a range of days that is determined by comparing the start date of the plan and the disability date. If a disability claim falls within this defined range, the specified Ex Code will be applied to that claim.
No longer in use. Pre-Ex processing has been moved to a more detailed structure in PlanPrex tables.
Determines the QPA Method to be used for claims under this Plan
Deault paid up value when Policy & Forfeiture is used in enrollment.
No longer in use. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Total deductible amount to be credited back to the Subscriber during adjudication.
Out of Network deductible amount to be credited back to the Subscriber during adjudication.
In-Network deductible amount to be credited back to the Subscriber during adjudication.
Total deductible amount for the Family both In Network and Out of Network.
Indicates whether the COB should be used. Note: This field is marked as NOT NULL in the database and therefore required by the API.
This field is not currently used - future-proofing support for additional options
Flag for enabling Visium integration. Note: This field is marked as NOT NULL in the database and therefore required by the API.
This field is not currently used - future-proofing for additional custom parameters
- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/plans-batch
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
https://vbapi.vbasoftware.com/vbasoftware/plans-batch \
-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",
"annual_Max": 0.1,
"annual_Max_Net": 0.1,
"annual_Max_OON": 0.1,
"auto_Create_Flex": true,
"cobrA_Plan_Type_Desc": "string",
"coB_Savings_Max": 0.1,
"coB_Type": "string",
"capitated": true,
"cash_Value_Default": 0,
"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,
"context4_ClmUcrPct": 0,
"context4_ClmUcrPct_OON": 0,
"context4_FeeSelector": "string",
"context4_FeeSelector_OON": "string",
"context4_MedicarePct": 0,
"context4_MedicarePct_OON": 0,
"context4_Password": "string",
"context4_PayorType": "string",
"context4_PayorType_OON": "string",
"context4_PctOfChg": 0,
"context4_PctOfChg_OON": 0,
"context4_PlanPriceNotGreaterBilledFg": true,
"context4_UserID": "string",
"context4_WebURI": "string",
"context4_WebURI_Delete": "string",
"currency_ID": "string",
"ded_In_To_Out": true,
"ded_Out_To_In": true,
"ded_Out_To_In_Limit": true,
"ded_Out_To_In_Limit_Max": 0.1,
"description": "string",
"entry_Date": "2019-08-24T14:15:22Z",
"entry_User": "string",
"extended_Term_Default": 0,
"family_Level_Co_Ins": true,
"family_Level_Co_Ins_Member": 0,
"family_Level_Ded": true,
"family_Level_Ded_Member": 0,
"family_Level_OOP": true,
"family_Level_OOP_Member": 0,
"flex_Advance_Fund": true,
"flex_Type": "string",
"forfeiture_Status_Default": "string",
"illness_Ex_Code": "string",
"illness_Waiting_Period": 0,
"include_Waiting_Period": true,
"injury_Ex_Code": "string",
"injury_Waiting_Period": 0,
"ltC_Apply_Elimination_Period": true,
"ltC_Apply_Waiver_Of_Premium": 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_Elimination_Period": 0,
"ltC_Elimination_Period_Per_Claim": true,
"ltC_Elimination_Period_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_Joint_Policy": true,
"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_Waiver_Of_Premium_Type": "string",
"lifetime_Max": 0.1,
"lifetime_Max_Net": 0.1,
"lifetime_Max_OON": 0.1,
"maturity_Age": 0,
"maturity_Age_Type": "string",
"max_Disability_Weeks": 0,
"max_Includes_Waiting_Period": true,
"mem_Ded_Credit": 0.1,
"mem_Ded_Credit_OON": 0.1,
"mem_Ded_Credit_PPO": 0.1,
"member_Annual_Max": 0.1,
"member_Annual_Max_Net": 0.1,
"member_Annual_Max_OON": 0.1,
"member_Ded_OON": 0.1,
"member_Ded_PPO": 0.1,
"member_Deductible": 0.1,
"member_Lifetime_Max": 0.1,
"member_Lifetime_Max_Net": 0.1,
"member_Lifetime_Max_OON": 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,
"payment_Interval": 0,
"payor_ID": "string",
"pend_Ex_Code": "string",
"pend_Flag": "s",
"plan_Document_URL": "string",
"plan_Type": "string",
"policy_Forfeiture_Grace_Period": 0,
"policy_Forfeiture_Grace_Period_Type": "s",
"policy_Status_Default": "string",
"preEx_Ex_Code": "string",
"preEx_From": 0,
"preEx_Range": 0,
"preEx_Thru": 0,
"qpA_Method": "s",
"reduced_Paid_Up_Default": 0,
"remove_Member_Amount_Edit": true,
"situs_State": "st",
"sub_Ded_Credit": 0.1,
"sub_Ded_Credit_OON": 0.1,
"sub_Ded_Credit_PPO": 0.1,
"subscriber_Ded_OON": 0.1,
"subscriber_Ded_PPO": 0.1,
"subscriber_Deductible": 0.1,
"survivor_Benefit": 0,
"update_Date": "2019-08-24T14:15:22Z",
"update_User": "string",
"use_COB_Savings": true,
"visium_Criteria_Key": 0,
"visium_Edit": true,
"visium_Setting_ID": "string",
"talon_Edit": true,
"talon_Criteria_Key": 0,
"clearity_Plan": true,
"clearity_Criteria_Key": 0
}
]'No response example