Subscriber Accumulators

Create SubscriberAccum

Creates a new SubscriberAccum

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
subscriberID
required
string

Subscriber ID

groupID
required
string

Group ID

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
subscriber_ID
required
string [ 1 .. 9 ] characters

References Subscribers.Subscriber_ID value on the parent record.

group_ID
required
string [ 1 .. 20 ] characters

Identifier assigned to the Group associated with this Prior Accumulator.

plan_Year
required
string [ 1 .. 8 ] characters

Plan Year associated with this Subscriber Accumulator.

plan_Type
required
string [ 1 .. 6 ] characters

Plan Type associated with this Subscriber Accumulator.

benefit_Code
required
string [ 1 .. 10 ] characters

Benefit Code associated with this Subscriber Accumulator.

added_Accum
string or null <= 1 characters

Identifies that this Accumulator is an Added Accumulator.

allowed_Amt
required
number <double>

Total Allowed amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.

allowed_Amt_Net
required
number <double>

Allowed amount that has been used In Network. Note: This field is marked as NOT NULL in the database and therefore required by the API.

allowed_Amt_OON
required
number <double>

Allowed amount that has been used Out of Network. Note: This field is marked as NOT NULL in the database and therefore required by the API.

benefit_Used
required
number <double>

Total amount of benefit that has been used. Note: This field is marked as NOT NULL in the database and therefore required by the API.

benefit_Used_Net
required
number <double>

Net amount of benefit that has been used. Note: This field is marked as NOT NULL in the database and therefore required by the API.

benefit_Used_OON
required
number <double>

Amount of benefit that has been used Out of Network. Note: This field is marked as NOT NULL in the database and therefore required by the API.

billed_Amt
required
number <double>

Amount that has been billed. Note: This field is marked as NOT NULL in the database and therefore required by the API.

billed_Amt_Net
required
number <double>

Amount that has been billed In Network. Note: This field is marked as NOT NULL in the database and therefore required by the API.

billed_Amt_OON
required
number <double>

Amount that has been billed Out of Network. Note: This field is marked as NOT NULL in the database and therefore required by the API.

coB_Amt
required
number <double>

Total Coordination of Benefits amount that has been used. Note: This field is marked as NOT NULL in the database and therefore required by the API.

coB_Amt_Net
required
number <double>

Net Coordination of Benefits amount that has been used. Note: This field is marked as NOT NULL in the database and therefore required by the API.

coB_Amt_OON
required
number <double>

Coordination of Benefits amount that has been used Out of Network. Note: This field is marked as NOT NULL in the database and therefore required by the API.

coins_Amt
required
number <double>

Total amount of Coinsurance that has been used. Note: This field is marked as NOT NULL in the database and therefore required by the API.

coins_Amt_Net
required
number <double>

Net amount of Coinsurance that has been used. Note: This field is marked as NOT NULL in the database and therefore required by the API.

coins_Amt_OON
required
number <double>

Amount of Coinsurance that has been used Out of Network. Note: This field is marked as NOT NULL in the database and therefore required by the API.

copay_Amt
required
number <double>

Total amount of Copay that has been used. Note: This field is marked as NOT NULL in the database and therefore required by the API.

copay_Amt_Net
required
number <double>

Net amount of Copay that has been used. Note: This field is marked as NOT NULL in the database and therefore required by the API.

copay_Amt_OON
required
number <double>

Amount of Copay that has been used Out of Network. Note: This field is marked as NOT NULL in the database and therefore required by the API.

ded_Credit_OON_Used
required
number <double>

Amount of deductible credit that has been used Out of Network. Note: This field is marked as NOT NULL in the database and therefore required by the API.

ded_Credit_PPO_Used
required
number <double>

Net amount of deductible credit that has been used. Note: This field is marked as NOT NULL in the database and therefore required by the API.

ded_Credit_Used
required
number <double>

Total amount of deductible credit that has been used. Note: This field is marked as NOT NULL in the database and therefore required by the API.

ded_PPO_Used
required
number <double>

Net amount of deductible that has been used. Note: This field is marked as NOT NULL in the database and therefore required by the API.

deductible_Used
required
number <double>

Total amount of deductible that has been used. Note: This field is marked as NOT NULL in the database and therefore required by the API.

deductible_Used_OON
required
number <double>

Amount of deductible that has been used Out of Network. Note: This field is marked as NOT NULL in the database and therefore required by the API.

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.

not_Covered_Amt
required
number <double>

Total amount that is not covered. Note: This field is marked as NOT NULL in the database and therefore required by the API.

not_Covered_Amt_Net
required
number <double>

Net amount that is not covered. Note: This field is marked as NOT NULL in the database and therefore required by the API.

not_Covered_OON
required
number <double>

Out of Network amount that is not covered. Note: This field is marked as NOT NULL in the database and therefore required by the API.

out_Of_Pocket
required
number <double>

Total Out of Pocket amount that has been used. Note: This field is marked as NOT NULL in the database and therefore required by the API.

out_Of_Pocket_Net
required
number <double>

Amount of Out of Pocket that has been used In Network. Note: This field is marked as NOT NULL in the database and therefore required by the API.

out_Of_Pocket_OON
required
number <double>

Amount of Out of Pocket that has been used Out of Network. Note: This field is marked as NOT NULL in the database and therefore required by the API.

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/subscribers/{subscriberID}/groups/{groupID}/accumulators
Request samples
{
  • "subscriber_ID": "string",
  • "group_ID": "string",
  • "plan_Year": "string",
  • "plan_Type": "string",
  • "benefit_Code": "string",
  • "added_Accum": "s",
  • "allowed_Amt": 0.1,
  • "allowed_Amt_Net": 0.1,
  • "allowed_Amt_OON": 0.1,
  • "benefit_Used": 0.1,
  • "benefit_Used_Net": 0.1,
  • "benefit_Used_OON": 0.1,
  • "billed_Amt": 0.1,
  • "billed_Amt_Net": 0.1,
  • "billed_Amt_OON": 0.1,
  • "coB_Amt": 0.1,
  • "coB_Amt_Net": 0.1,
  • "coB_Amt_OON": 0.1,
  • "coins_Amt": 0.1,
  • "coins_Amt_Net": 0.1,
  • "coins_Amt_OON": 0.1,
  • "copay_Amt": 0.1,
  • "copay_Amt_Net": 0.1,
  • "copay_Amt_OON": 0.1,
  • "ded_Credit_OON_Used": 0.1,
  • "ded_Credit_PPO_Used": 0.1,
  • "ded_Credit_Used": 0.1,
  • "ded_PPO_Used": 0.1,
  • "deductible_Used": 0.1,
  • "deductible_Used_OON": 0.1,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "not_Covered_Amt": 0.1,
  • "not_Covered_Amt_Net": 0.1,
  • "not_Covered_OON": 0.1,
  • "out_Of_Pocket": 0.1,
  • "out_Of_Pocket_Net": 0.1,
  • "out_Of_Pocket_OON": 0.1,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List SubscriberAccum

Lists all SubscriberAccum for the given subscriberID and groupID

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
subscriberID
required
string

Subscriber ID

groupID
required
string

Group ID

query Parameters
page
integer <int32>
Default: 1

Page

pageSize
integer <int32>
Default: 100

Page Size

sortBy
string

Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., 'Property1:desc,Property2:asc,Property3:asc' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/subscribers/{subscriberID}/groups/{groupID}/accumulators
Request samples 
Response samples 
No sample
Get SubscriberAccum
Gets SubscriberAccum


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
groupID
required
string
Group ID


 
planYear
required
string
Plan Year


 
planType
required
string
Plan Type


 
benefitCode
required
string
Benefit Code


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/subscribers/{subscriberID}/groups/{groupID}/accumulators/{planYear}/{planType}/{benefitCode}
Request samples 
Response samples 
No sample
Update SubscriberAccum
Updates a specific SubscriberAccum.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
groupID
required
string
Group ID


 
planYear
required
string
Plan Year


 
planType
required
string
Plan Type


 
benefitCode
required
string
Benefit Code


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
subscriber_ID
required
string  [ 1 .. 9 ] characters 
References Subscribers.Subscriber_ID value on the parent record.


 
group_ID
required
string  [ 1 .. 20 ] characters 
Identifier assigned to the Group associated with this Prior Accumulator.


 
plan_Year
required
string  [ 1 .. 8 ] characters 
Plan Year associated with this Subscriber Accumulator.


 
plan_Type
required
string  [ 1 .. 6 ] characters 
Plan Type associated with this Subscriber Accumulator.


 
benefit_Code
required
string  [ 1 .. 10 ] characters 
Benefit Code associated with this Subscriber Accumulator.


 
added_Accum
string or null  <= 1 characters 
Identifies that this Accumulator is an Added Accumulator.


 
allowed_Amt
required
number <double> 
Total Allowed amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
allowed_Amt_Net
required
number <double> 
Allowed amount that has been used In Network. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
allowed_Amt_OON
required
number <double> 
Allowed amount that has been used Out of Network. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
benefit_Used
required
number <double> 
Total amount of benefit that has been used. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
benefit_Used_Net
required
number <double> 
Net amount of benefit that has been used. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
benefit_Used_OON
required
number <double> 
Amount of benefit that has been used Out of Network. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
billed_Amt
required
number <double> 
Amount that has been billed. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
billed_Amt_Net
required
number <double> 
Amount that has been billed In Network. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
billed_Amt_OON
required
number <double> 
Amount that has been billed Out of Network. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
coB_Amt
required
number <double> 
Total Coordination of Benefits amount that has been used. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
coB_Amt_Net
required
number <double> 
Net Coordination of Benefits amount that has been used. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
coB_Amt_OON
required
number <double> 
Coordination of Benefits amount that has been used Out of Network. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
coins_Amt
required
number <double> 
Total amount of Coinsurance that has been used. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
coins_Amt_Net
required
number <double> 
Net amount of Coinsurance that has been used. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
coins_Amt_OON
required
number <double> 
Amount of Coinsurance that has been used Out of Network. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
copay_Amt
required
number <double> 
Total amount of Copay that has been used. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
copay_Amt_Net
required
number <double> 
Net amount of Copay that has been used. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
copay_Amt_OON
required
number <double> 
Amount of Copay that has been used Out of Network. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
ded_Credit_OON_Used
required
number <double> 
Amount of deductible credit that has been used Out of Network. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
ded_Credit_PPO_Used
required
number <double> 
Net amount of deductible credit that has been used. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
ded_Credit_Used
required
number <double> 
Total amount of deductible credit that has been used. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
ded_PPO_Used
required
number <double> 
Net amount of deductible that has been used. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
deductible_Used
required
number <double> 
Total amount of deductible that has been used. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
deductible_Used_OON
required
number <double> 
Amount of deductible that has been used Out of Network. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
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.


 
not_Covered_Amt
required
number <double> 
Total amount that is not covered. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
not_Covered_Amt_Net
required
number <double> 
Net amount that is not covered. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
not_Covered_OON
required
number <double> 
Out of Network amount that is not covered. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
out_Of_Pocket
required
number <double> 
Total Out of Pocket amount that has been used. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
out_Of_Pocket_Net
required
number <double> 
Amount of Out of Pocket that has been used In Network. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
out_Of_Pocket_OON
required
number <double> 
Amount of Out of Pocket that has been used Out of Network. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
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/subscribers/{subscriberID}/groups/{groupID}/accumulators/{planYear}/{planType}/{benefitCode}
Request samples 
{
  • "subscriber_ID": "string",
  • "group_ID": "string",
  • "plan_Year": "string",
  • "plan_Type": "string",
  • "benefit_Code": "string",
  • "added_Accum": "s",
  • "allowed_Amt": 0.1,
  • "allowed_Amt_Net": 0.1,
  • "allowed_Amt_OON": 0.1,
  • "benefit_Used": 0.1,
  • "benefit_Used_Net": 0.1,
  • "benefit_Used_OON": 0.1,
  • "billed_Amt": 0.1,
  • "billed_Amt_Net": 0.1,
  • "billed_Amt_OON": 0.1,
  • "coB_Amt": 0.1,
  • "coB_Amt_Net": 0.1,
  • "coB_Amt_OON": 0.1,
  • "coins_Amt": 0.1,
  • "coins_Amt_Net": 0.1,
  • "coins_Amt_OON": 0.1,
  • "copay_Amt": 0.1,
  • "copay_Amt_Net": 0.1,
  • "copay_Amt_OON": 0.1,
  • "ded_Credit_OON_Used": 0.1,
  • "ded_Credit_PPO_Used": 0.1,
  • "ded_Credit_Used": 0.1,
  • "ded_PPO_Used": 0.1,
  • "deductible_Used": 0.1,
  • "deductible_Used_OON": 0.1,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "not_Covered_Amt": 0.1,
  • "not_Covered_Amt_Net": 0.1,
  • "not_Covered_OON": 0.1,
  • "out_Of_Pocket": 0.1,
  • "out_Of_Pocket_Net": 0.1,
  • "out_Of_Pocket_OON": 0.1,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete SubscriberAccum
Deletes an SubscriberAccum


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
groupID
required
string
Group ID


 
planYear
required
string
Plan Year


 
planType
required
string
Plan Type


 
benefitCode
required
string
Benefit Code


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/subscribers/{subscriberID}/groups/{groupID}/accumulators/{planYear}/{planType}/{benefitCode}
Request samples 
Create or Update Batch SubscriberAccum
Create or Update multiple SubscriberAccum 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
subscriberID
required
string
Subscriber ID


 
groupID
required
string
Group ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
subscriber_ID
required
string  [ 1 .. 9 ] characters 
References Subscribers.Subscriber_ID value on the parent record.


 
group_ID
required
string  [ 1 .. 20 ] characters 
Identifier assigned to the Group associated with this Prior Accumulator.


 
plan_Year
required
string  [ 1 .. 8 ] characters 
Plan Year associated with this Subscriber Accumulator.


 
plan_Type
required
string  [ 1 .. 6 ] characters 
Plan Type associated with this Subscriber Accumulator.


 
benefit_Code
required
string  [ 1 .. 10 ] characters 
Benefit Code associated with this Subscriber Accumulator.


 
added_Accum
string or null  <= 1 characters 
Identifies that this Accumulator is an Added Accumulator.


 
allowed_Amt
required
number <double> 
Total Allowed amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
allowed_Amt_Net
required
number <double> 
Allowed amount that has been used In Network. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
allowed_Amt_OON
required
number <double> 
Allowed amount that has been used Out of Network. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
benefit_Used
required
number <double> 
Total amount of benefit that has been used. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
benefit_Used_Net
required
number <double> 
Net amount of benefit that has been used. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
benefit_Used_OON
required
number <double> 
Amount of benefit that has been used Out of Network. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
billed_Amt
required
number <double> 
Amount that has been billed. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
billed_Amt_Net
required
number <double> 
Amount that has been billed In Network. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
billed_Amt_OON
required
number <double> 
Amount that has been billed Out of Network. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
coB_Amt
required
number <double> 
Total Coordination of Benefits amount that has been used. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
coB_Amt_Net
required
number <double> 
Net Coordination of Benefits amount that has been used. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
coB_Amt_OON
required
number <double> 
Coordination of Benefits amount that has been used Out of Network. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
coins_Amt
required
number <double> 
Total amount of Coinsurance that has been used. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
coins_Amt_Net
required
number <double> 
Net amount of Coinsurance that has been used. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
coins_Amt_OON
required
number <double> 
Amount of Coinsurance that has been used Out of Network. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
copay_Amt
required
number <double> 
Total amount of Copay that has been used. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
copay_Amt_Net
required
number <double> 
Net amount of Copay that has been used. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
copay_Amt_OON
required
number <double> 
Amount of Copay that has been used Out of Network. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
ded_Credit_OON_Used
required
number <double> 
Amount of deductible credit that has been used Out of Network. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
ded_Credit_PPO_Used
required
number <double> 
Net amount of deductible credit that has been used. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
ded_Credit_Used
required
number <double> 
Total amount of deductible credit that has been used. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
ded_PPO_Used
required
number <double> 
Net amount of deductible that has been used. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
deductible_Used
required
number <double> 
Total amount of deductible that has been used. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
deductible_Used_OON
required
number <double> 
Amount of deductible that has been used Out of Network. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
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.


 
not_Covered_Amt
required
number <double> 
Total amount that is not covered. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
not_Covered_Amt_Net
required
number <double> 
Net amount that is not covered. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
not_Covered_OON
required
number <double> 
Out of Network amount that is not covered. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
out_Of_Pocket
required
number <double> 
Total Out of Pocket amount that has been used. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
out_Of_Pocket_Net
required
number <double> 
Amount of Out of Pocket that has been used In Network. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
out_Of_Pocket_OON
required
number <double> 
Amount of Out of Pocket that has been used Out of Network. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
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/subscribers/{subscriberID}/groups/{groupID}/accumulators-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}