Plan Accumulators

Create Plan Accumulator

Creates a new Plan Accumulator

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
planID
required
string

Plan ID

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
plan_ID
required
string [ 1 .. 20 ] characters

References the Plans.Plan_ID for this Added Accumulator.

accum_Name
required
string [ 1 .. 10 ] characters

Unique identifier for this Added Accumulator. This value must also be unique of any Benefit_Code value in BenefitCodes.Benefit_Code.

annual_Max
number or null <double>

Total annual amount that the Plan will pay both In Network and Out of Network.

annual_Max_Member
number or null <double>

Total annual amount that the Plan will pay both In Network and Out of Network.

annual_Max_Net
number or null <double>

Annual amount that the Plan will pay In Network.

annual_Max_Net_Member
number or null <double>

Annual amount that the Plan will pay In Network.

annual_Max_OON
number or null <double>

Annual amount that the Plan will pay Out of Network.

annual_Max_OON_Member
number or null <double>

Annual amount that the Plan will pay Out of Network.

coIns_Max_Mem
number or null <double>

Total Co-Insurance amount for the Member.

coIns_Max_Net_Mem
number or null <double>

In Network Co-Insurance amount for the Member.

coIns_Max_Net_Sub
number or null <double>

In Network Co-Insurance amount for the Family.

coIns_Max_OON_Mem
number or null <double>

Out of Network Co-Insurance amount for the Member.

coIns_Max_OON_Sub
number or null <double>

Out of Network Co-Insurance amount for the Family.

coIns_Max_Sub
number or null <double>

Total Co-Insurance amount for the Family.

entry_Date
string <date-time>

Date when the record was first added to the system.

entry_User
string or null <= 20 characters

User that first added the record to the system.

lifetime_Max
number or null <double>

Total lifetime amount that the Plan will pay both In Network and Out of Network.

lifetime_Max_Member
number or null <double>

Total lifetime amount that the Plan will pay both In Network and Out of Network.

lifetime_Max_Net
number or null <double>

Lifetime amount that the Plan will pay In Network.

lifetime_Max_Net_Member
number or null <double>

Lifetime amount that the Plan will pay In Network.

lifetime_Max_OON
number or null <double>

Lifetime amount that the Plan will pay Out of Network.

lifetime_Max_OON_Member
number or null <double>

Lifetime amount that the Plan will pay Out of Network.

member_Ded_OON
number or null <double>

Out of Network deductible amount for the Member.

member_Ded_PPO
number or null <double>

In Network deductible amount for the Member.

member_Deductible
number or null <double>

Total deductible amount for the Member.

ooP_Max_Mem
number or null <double>

Total Out of Pocket amount for the Member.

ooP_Max_Net_Mem
number or null <double>

In Network Out of Pocket amount for the Member.

ooP_Max_Net_Sub
number or null <double>

In Network Out of Pocket amount for the Family.

ooP_Max_OON_Mem
number or null <double>

Out of Network Out of Pocket amount for the Member.

ooP_Max_OON_Sub
number or null <double>

Out of Network Out of Pocket amount for the Family.

ooP_Max_Sub
number or null <double>

Total Out of Pocket amount for the Family.

subscriber_Ded_OON
number or null <double>

Out of Network deductible amount for the Family.

subscriber_Ded_PPO
number or null <double>

In Network deductible amount for the Family.

subscriber_Deductible
number or null <double>

Total deductible amount for the Family.

update_Date
string <date-time>

Date when the record was last updated in the system.

update_User
string or null <= 20 characters

User that last updated the record in the system.

Responses
200

Success

401

Unauthorized

post/plans/{planID}/accumulators
Request samples
{
  • "plan_ID": "string",
  • "accum_Name": "string",
  • "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_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,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "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,
  • "member_Ded_OON": 0.1,
  • "member_Ded_PPO": 0.1,
  • "member_Deductible": 0.1,
  • "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,
  • "subscriber_Ded_OON": 0.1,
  • "subscriber_Ded_PPO": 0.1,
  • "subscriber_Deductible": 0.1,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List Plan Accumulator

Lists all Plan Accumulator given a specific Plan ID

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
planID
required
string

Plan ID

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/plans/{planID}/accumulators
Request samples 
Response samples 
No sample
Get Plan Accumulator
Gets Plan Accumulator


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
planID
required
string
Plan ID


 
accumName
required
string
Accum Name


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/plans/{planID}/accumulators/{accumName}
Request samples 
Response samples 
No sample
Update Plan Accumulator
Updates a specific Plan Accumulator.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
planID
required
string
Plan ID


 
accumName
required
string
Accum Name


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
plan_ID
required
string  [ 1 .. 20 ] characters 
References the Plans.Plan_ID for this Added Accumulator.


 
accum_Name
required
string  [ 1 .. 10 ] characters 
Unique identifier for this Added Accumulator. This value must also be unique of any Benefit_Code value in BenefitCodes.Benefit_Code.


 
annual_Max
number or null <double> 
Total annual amount that the Plan will pay both In Network and Out of Network.


 
annual_Max_Member
number or null <double> 
Total annual amount that the Plan will pay both In Network and Out of Network.


 
annual_Max_Net
number or null <double> 
Annual amount that the Plan will pay In Network.


 
annual_Max_Net_Member
number or null <double> 
Annual amount that the Plan will pay In Network.


 
annual_Max_OON
number or null <double> 
Annual amount that the Plan will pay Out of Network.


 
annual_Max_OON_Member
number or null <double> 
Annual amount that the Plan will pay Out of Network.


 
coIns_Max_Mem
number or null <double> 
Total Co-Insurance amount for the Member.


 
coIns_Max_Net_Mem
number or null <double> 
In Network Co-Insurance amount for the Member.


 
coIns_Max_Net_Sub
number or null <double> 
In Network Co-Insurance amount for the Family.


 
coIns_Max_OON_Mem
number or null <double> 
Out of Network Co-Insurance amount for the Member.


 
coIns_Max_OON_Sub
number or null <double> 
Out of Network Co-Insurance amount for the Family.


 
coIns_Max_Sub
number or null <double> 
Total Co-Insurance amount for the Family.


 
entry_Date
string <date-time> 
Date when the record was first added to the system.


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system.


 
lifetime_Max
number or null <double> 
Total lifetime amount that the Plan will pay both In Network and Out of Network.


 
lifetime_Max_Member
number or null <double> 
Total lifetime amount that the Plan will pay both In Network and Out of Network.


 
lifetime_Max_Net
number or null <double> 
Lifetime amount that the Plan will pay In Network.


 
lifetime_Max_Net_Member
number or null <double> 
Lifetime amount that the Plan will pay In Network.


 
lifetime_Max_OON
number or null <double> 
Lifetime amount that the Plan will pay Out of Network.


 
lifetime_Max_OON_Member
number or null <double> 
Lifetime amount that the Plan will pay Out of Network.


 
member_Ded_OON
number or null <double> 
Out of Network deductible amount for the Member.


 
member_Ded_PPO
number or null <double> 
In Network deductible amount for the Member.


 
member_Deductible
number or null <double> 
Total deductible amount for the Member.


 
ooP_Max_Mem
number or null <double> 
Total Out of Pocket amount for the Member.


 
ooP_Max_Net_Mem
number or null <double> 
In Network Out of Pocket amount for the Member.


 
ooP_Max_Net_Sub
number or null <double> 
In Network Out of Pocket amount for the Family.


 
ooP_Max_OON_Mem
number or null <double> 
Out of Network Out of Pocket amount for the Member.


 
ooP_Max_OON_Sub
number or null <double> 
Out of Network Out of Pocket amount for the Family.


 
ooP_Max_Sub
number or null <double> 
Total Out of Pocket amount for the Family.


 
subscriber_Ded_OON
number or null <double> 
Out of Network deductible amount for the Family.


 
subscriber_Ded_PPO
number or null <double> 
In Network deductible amount for the Family.


 
subscriber_Deductible
number or null <double> 
Total deductible amount for the Family.


 
update_Date
string <date-time> 
Date when the record was last updated in the system.


 
update_User
string or null  <= 20 characters 
User that last updated the record in the system.


 
Responses 
200
Success


401
Unauthorized


put/plans/{planID}/accumulators/{accumName}
Request samples 
{
  • "plan_ID": "string",
  • "accum_Name": "string",
  • "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_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,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "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,
  • "member_Ded_OON": 0.1,
  • "member_Ded_PPO": 0.1,
  • "member_Deductible": 0.1,
  • "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,
  • "subscriber_Ded_OON": 0.1,
  • "subscriber_Ded_PPO": 0.1,
  • "subscriber_Deductible": 0.1,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete Plan Accumulator
Deletes an Plan Accumulator


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
planID
required
string
Plan ID


 
accumName
required
string
Accum Name


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/plans/{planID}/accumulators/{accumName}
Request samples 
Create or Update Batch Plan Accumulator
Create or Update multiple Plan Accumulator at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
planID
required
string
Plan ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
plan_ID
required
string  [ 1 .. 20 ] characters 
References the Plans.Plan_ID for this Added Accumulator.


 
accum_Name
required
string  [ 1 .. 10 ] characters 
Unique identifier for this Added Accumulator. This value must also be unique of any Benefit_Code value in BenefitCodes.Benefit_Code.


 
annual_Max
number or null <double> 
Total annual amount that the Plan will pay both In Network and Out of Network.


 
annual_Max_Member
number or null <double> 
Total annual amount that the Plan will pay both In Network and Out of Network.


 
annual_Max_Net
number or null <double> 
Annual amount that the Plan will pay In Network.


 
annual_Max_Net_Member
number or null <double> 
Annual amount that the Plan will pay In Network.


 
annual_Max_OON
number or null <double> 
Annual amount that the Plan will pay Out of Network.


 
annual_Max_OON_Member
number or null <double> 
Annual amount that the Plan will pay Out of Network.


 
coIns_Max_Mem
number or null <double> 
Total Co-Insurance amount for the Member.


 
coIns_Max_Net_Mem
number or null <double> 
In Network Co-Insurance amount for the Member.


 
coIns_Max_Net_Sub
number or null <double> 
In Network Co-Insurance amount for the Family.


 
coIns_Max_OON_Mem
number or null <double> 
Out of Network Co-Insurance amount for the Member.


 
coIns_Max_OON_Sub
number or null <double> 
Out of Network Co-Insurance amount for the Family.


 
coIns_Max_Sub
number or null <double> 
Total Co-Insurance amount for the Family.


 
entry_Date
string <date-time> 
Date when the record was first added to the system.


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system.


 
lifetime_Max
number or null <double> 
Total lifetime amount that the Plan will pay both In Network and Out of Network.


 
lifetime_Max_Member
number or null <double> 
Total lifetime amount that the Plan will pay both In Network and Out of Network.


 
lifetime_Max_Net
number or null <double> 
Lifetime amount that the Plan will pay In Network.


 
lifetime_Max_Net_Member
number or null <double> 
Lifetime amount that the Plan will pay In Network.


 
lifetime_Max_OON
number or null <double> 
Lifetime amount that the Plan will pay Out of Network.


 
lifetime_Max_OON_Member
number or null <double> 
Lifetime amount that the Plan will pay Out of Network.


 
member_Ded_OON
number or null <double> 
Out of Network deductible amount for the Member.


 
member_Ded_PPO
number or null <double> 
In Network deductible amount for the Member.


 
member_Deductible
number or null <double> 
Total deductible amount for the Member.


 
ooP_Max_Mem
number or null <double> 
Total Out of Pocket amount for the Member.


 
ooP_Max_Net_Mem
number or null <double> 
In Network Out of Pocket amount for the Member.


 
ooP_Max_Net_Sub
number or null <double> 
In Network Out of Pocket amount for the Family.


 
ooP_Max_OON_Mem
number or null <double> 
Out of Network Out of Pocket amount for the Member.


 
ooP_Max_OON_Sub
number or null <double> 
Out of Network Out of Pocket amount for the Family.


 
ooP_Max_Sub
number or null <double> 
Total Out of Pocket amount for the Family.


 
subscriber_Ded_OON
number or null <double> 
Out of Network deductible amount for the Family.


 
subscriber_Ded_PPO
number or null <double> 
In Network deductible amount for the Family.


 
subscriber_Deductible
number or null <double> 
Total deductible amount for the Family.


 
update_Date
string <date-time> 
Date when the record was last updated in the system.


 
update_User
string or null  <= 20 characters 
User that last updated the record in the system.


 
Responses 
207
Success


401
Unauthorized


put/plans/{planID}/accumulators-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}