Skip to content

Create SubscriberAccum

Request

Creates a new SubscriberAccum

Security
apiKeyAuth and bearerAuth
Path
subscriberIDstringrequired

Subscriber ID

groupIDstringrequired

Group ID

Headers
vbasoftware-databasestringrequired

Target database

Bodyapplication/jsonrequired
subscriber_IDstring, [ 1 .. 9 ] charactersrequired

References Subscribers.Subscriber_ID value on the parent record.

group_IDstring, [ 1 .. 20 ] charactersrequired

Identifier assigned to the Group associated with this Prior Accumulator.

plan_Yearstring, [ 1 .. 8 ] charactersrequired

Plan Year associated with this Subscriber Accumulator.

plan_Typestring, [ 1 .. 6 ] charactersrequired

Plan Type associated with this Subscriber Accumulator.

benefit_Codestring, [ 1 .. 10 ] charactersrequired

Benefit Code associated with this Subscriber Accumulator.

added_Accumstring or null, <= 1 characters

Identifies that this Accumulator is an Added Accumulator.

allowed_Amtnumber, (double)required

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

allowed_Amt_Netnumber, (double)required

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_OONnumber, (double)required

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_Usednumber, (double)required

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_Netnumber, (double)required

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_OONnumber, (double)required

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_Amtnumber, (double)required

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

billed_Amt_Netnumber, (double)required

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_OONnumber, (double)required

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_Amtnumber, (double)required

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_Netnumber, (double)required

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_OONnumber, (double)required

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_Amtnumber, (double)required

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_Netnumber, (double)required

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_OONnumber, (double)required

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_Amtnumber, (double)required

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_Netnumber, (double)required

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_OONnumber, (double)required

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_Usednumber, (double)required

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_Usednumber, (double)required

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_Usednumber, (double)required

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_Usednumber, (double)required

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_Usednumber, (double)required

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_OONnumber, (double)required

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_Datestring, (date-time)

Date when the record was first added to the system.

entry_Userstring or null, <= 20 characters

User that first added the record to the system.

not_Covered_Amtnumber, (double)required

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_Netnumber, (double)required

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_OONnumber, (double)required

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_Pocketnumber, (double)required

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_Netnumber, (double)required

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_OONnumber, (double)required

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_Datestring, (date-time)

Date when the record was last updated in the system.

update_Userstring or null, <= 20 characters

User that last updated the record in the system.

curl -i -X POST \
  'https://vbapi.vbasoftware.com/vbasoftware/subscribers/{subscriberID}/groups/{groupID}/accumulators' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'vbasoftware-database: string' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "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"
  }'

Responses

Success

Bodyapplication/json
dataobject
errorobject
debugobject
Response
{
  "data": { … },
  "error": { … },
  "debug": { … }
}