Premium Rates

Create PremRate

Creates a new PremRate

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
premRate_Key
required
integer <int32>

Unique identifier for the PremRate Note: This field is marked as NOT NULL in the database and therefore required by the API.

add_On_Grouping_ID
string or null <= 32 characters

Used to identify Add On rates by Group

additional_Invoice_Address
string or null <= 4 characters

Address the additional invoice is sent to

additional_Invoice_Frequency
string or null <= 2 characters

Frequency of the additional invoice

additional_Invoice_Level
string or null <= 16 characters

Allows split billing at this level

address_Type
string or null <= 16 characters

Level of the Address used to determine if the rate applies

adjustment_Reason
integer or null <int32>

Adjustment Reason of the PremRate

adult
required
boolean

Flag used to determine if the rate applies to Adults Note: This field is marked as NOT NULL in the database and therefore required by the API.

age_From
integer or null <int32>

Beginning Age range of the PremRate

age_Thru
integer or null <int32>

Ending Age range of the PremRate

age_Type
string or null <= 16 characters

Detemines what date is used to calculate Age

age_Type_Month
string or null <= 2 characters

Detemines what Month is used if the Month Type is selected

assign_To_New_Division
required
boolean

Flag to determine if the rate applies to new Divisions Note: This field is marked as NOT NULL in the database and therefore required by the API.

assign_To_New_Group
required
boolean

Flag to determine if the rate applies to new Groups Note: This field is marked as NOT NULL in the database and therefore required by the API.

assign_To_New_Member
required
boolean

Flag to determine if the rate applies to new Members Note: This field is marked as NOT NULL in the database and therefore required by the API.

auto_Adjust
required
boolean

Flag that determines if the rate is automatically adjusted Note: This field is marked as NOT NULL in the database and therefore required by the API.

auto_Adjust_Reason
integer or null <int32>

Reason applied to automatic adjustments

avoid_Retro
required
boolean

This flag indicates prevention of the retro logic from creating backout adjustments for this rate Note: This field is marked as NOT NULL in the database and therefore required by the API.

benefit_Code
string or null <= 10 characters

Benefit Code of the PremRate

billing_Cycle_ID
string or null <= 2 characters

This is the Billing Cycle the invoice was gerenated for.

child
required
boolean

Flag used to determine if the rate applies to Children Note: This field is marked as NOT NULL in the database and therefore required by the API.

city
string or null <= 32 characters

City of the Address used to determine if the rate applies

class_Code
string or null <= 32 characters

Class Code for the PremRate

country_ID
string or null <= 8 characters

Country ID of the Address used to determine if the rate applies

county_Code
string or null <= 8 characters

Country Code of the Address used to determine if the rate applies

description
string or null <= 128 characters

Description of the PremRate

division_ID
string or null <= 20 characters

Unique identifier for the Division

effective_Date
string or null <date-time>

Effective Date of the PremRate

effective_Date_Type
string or null <= 16 characters

Determines the logic that modifies the Effective Date of the PremRate to a date based on the enrollment of the member. Note: The database will apply a default value of NORMAL for this field if a value is not provided.

employee_Employer_Contribution
string or null <= 2 characters

Determines if the contribution is Employee or Employer

employer_Contribution
number or null <double>

Amount of the contribution

employer_Contribution_Pct
required
boolean

Determines if the contribution is a percentage Note: This field is marked as NOT NULL in the database and therefore required by the API.

employer_Rate
number or null <double>

Decimal value that defines the base employer rate

employer_Rate_Max
number or null <double>

Maximum the employer rate will be regardless of the calculation

employer_Rate_Minimum
number or null <double>

Minimum the employer rate will be regardless of the calculation

employer_Rate_Type
string or null <= 32 characters

Type of Employer Rate

employer_Rate_Variable1
number or null <double>

First variable used in calculating the employer rate based on the type

employer_Rate_Variable2
number or null <double>

Second variable used in calculating the employer rate based on the type

employer_Rate_Variable3
number or null <double>

Third variable used in calculating the employer rate based on the type

employer_Round_Precision
integer or null <int32>

Precision that the employerrate is rounded to

employer_Round_Type
string or null <= 16 characters

Type that determine how the employer rate is rounded

enrolled_Count_From
integer or null <int32>

Beginning range based on number of enrollments

enrolled_Count_Thru
integer or null <int32>

Ending range based on number of enrollments

enrolled_Count_Type
string or null <= 16 characters

Type of enrollments used to calculate the number of enrollments

enrolled_Duration_From
integer or null <int32>

Beginning range based on length of enrollment

enrolled_Duration_Min
integer or null <int32>

Minimum length of enrollment

enrolled_Duration_Option
string or null <= 16 characters

Determines if the date is based on the Member or the Plan enrollment

enrolled_Duration_Thru
integer or null <int32>

Ending range based on length of enrollment

enrolled_Duration_Type
string or null <= 16 characters

Type of date used to determine the enrollment range

entry_Date
string <date-time>

Date record was first added to the system

entry_User
string or null <= 20 characters

User that first added the record to the system

group_Division_Offering
required
boolean

Used to determine which records are updated when applying changes to a template Note: This field is marked as NOT NULL in the database and therefore required by the API.

group_ID
string or null <= 20 characters

Unique identifier for the Group

member_Seq
string or null <= 2 characters

Unique sequence for a Member

network_ID
string or null <= 10 characters

Unique identifier for the Network

network_Type
string or null <= 16 characters

Type of Network

new_Hire_Age
required
boolean

Flag that determines the Age based on the date of hire Note: This field is marked as NOT NULL in the database and therefore required by the API.

override_Enrolled_Dates
required
boolean

This flag indicates the rate should be paid if enrolled in for even a single day during the month. Note: This field is marked as NOT NULL in the database and therefore required by the API.

parent_PremRate_Key
integer or null <int32>

PremRate_Key of the template rate this rate was created from

payment_Method
string or null <= 20 characters

The primary key of the payment method

plan_ID
string or null <= 20 characters

Unique identifier for the Plan

plan_Type
string or null <= 6 characters

Type of Plan

premRate_Basis
string or null <= 32 characters

Basis of the PremRate

premRate_Category
string or null <= 32 characters

Category of the PremRate

premRate_ID
string or null <= 32 characters

Unique identifier for the PremRate

premRate_Type
string or null <= 16 characters

Type of the PremRate

premium_Proration
required
boolean

Flag that determines if the rate is prorated Note: This field is marked as NOT NULL in the database and therefore required by the API.

rate
number or null <double>

Decimal value that defines the base rate

rate_Max
number or null <double>

Maximum the rate will be regardless of the calculation

rate_Minimum
number or null <double>

Minimum the rate will be regardless of the calculation

rate_Pace
string or null <= 16 characters

How often the rate applies

rate_Pace_Type
string or null <= 16 characters

The day the rate applies when the pace is weekly

rate_Round_Precision
integer or null <int32>

Precision that the rate is rounded to

rate_Round_Type
string or null <= 16 characters

Type that determine how the rate is rounded

rate_Type
string or null <= 32 characters

Type of Rate

rate_Variable1
number or null <double>

First variable used in calculating the rate based on the type

rate_Variable2
number or null <double>

Second variable used in calculating the rate based on the type

rate_Variable3
number or null <double>

Third variable used in calculating the rate based on the type

region_Code
string or null <= 32 characters

Region Code of the Address used to determine if the rate applies

relationship
string or null <= 12 characters

Relationship for the PremRate

sex
string or null <= 1 characters

Flag used to determine what Sex the rate applies to

smoker
string or null <= 1 characters

Flag to determine if the rate applies to Smokers

state
string or null <= 2 characters

State of the Address used to determine if the rate applies

subscriber_ID
string or null <= 9 characters

Unique identifier for the Subscriber

term_Date
string or null <date-time>

Term Date of the PremRate

term_Date_type
string or null <= 16 characters

Determines the logic that modifies the Term Date of the PremRate to a date based on the enrollment of the member. Note: The database will apply a default value of NORMAL for this field if a value is not provided.

tier
string or null <= 2 characters

Tier of the PremRate

update_Date
string <date-time>

Date the record was last updated in the system

update_User
string or null <= 20 characters

User that last updated the record in the system

zip_Code_From
string or null <= 32 characters

Beginning Zip Code of the Address used to determine if the rate applies

zip_Code_Thru
string or null <= 32 characters

Ending Zip Code of the Address used to determine if the rate applies

Responses
200

Success

401

Unauthorized

post/premium-rates
Request samples
{
  • "premRate_Key": 0,
  • "add_On_Grouping_ID": "string",
  • "additional_Invoice_Address": "stri",
  • "additional_Invoice_Frequency": "st",
  • "additional_Invoice_Level": "string",
  • "address_Type": "string",
  • "adjustment_Reason": 0,
  • "adult": true,
  • "age_From": 0,
  • "age_Thru": 0,
  • "age_Type": "string",
  • "age_Type_Month": "st",
  • "assign_To_New_Division": true,
  • "assign_To_New_Group": true,
  • "assign_To_New_Member": true,
  • "auto_Adjust": true,
  • "auto_Adjust_Reason": 0,
  • "avoid_Retro": true,
  • "benefit_Code": "string",
  • "billing_Cycle_ID": "st",
  • "child": true,
  • "city": "string",
  • "class_Code": "string",
  • "country_ID": "string",
  • "county_Code": "string",
  • "description": "string",
  • "division_ID": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "effective_Date_Type": "string",
  • "employee_Employer_Contribution": "st",
  • "employer_Contribution": 0.1,
  • "employer_Contribution_Pct": true,
  • "employer_Rate": 0.1,
  • "employer_Rate_Max": 0.1,
  • "employer_Rate_Minimum": 0.1,
  • "employer_Rate_Type": "string",
  • "employer_Rate_Variable1": 0.1,
  • "employer_Rate_Variable2": 0.1,
  • "employer_Rate_Variable3": 0.1,
  • "employer_Round_Precision": 0,
  • "employer_Round_Type": "string",
  • "enrolled_Count_From": 0,
  • "enrolled_Count_Thru": 0,
  • "enrolled_Count_Type": "string",
  • "enrolled_Duration_From": 0,
  • "enrolled_Duration_Min": 0,
  • "enrolled_Duration_Option": "string",
  • "enrolled_Duration_Thru": 0,
  • "enrolled_Duration_Type": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "group_Division_Offering": true,
  • "group_ID": "string",
  • "member_Seq": "st",
  • "network_ID": "string",
  • "network_Type": "string",
  • "new_Hire_Age": true,
  • "override_Enrolled_Dates": true,
  • "parent_PremRate_Key": 0,
  • "payment_Method": "string",
  • "plan_ID": "string",
  • "plan_Type": "string",
  • "premRate_Basis": "string",
  • "premRate_Category": "string",
  • "premRate_ID": "string",
  • "premRate_Type": "string",
  • "premium_Proration": true,
  • "rate": 0.1,
  • "rate_Max": 0.1,
  • "rate_Minimum": 0.1,
  • "rate_Pace": "string",
  • "rate_Pace_Type": "string",
  • "rate_Round_Precision": 0,
  • "rate_Round_Type": "string",
  • "rate_Type": "string",
  • "rate_Variable1": 0.1,
  • "rate_Variable2": 0.1,
  • "rate_Variable3": 0.1,
  • "region_Code": "string",
  • "relationship": "string",
  • "sex": "s",
  • "smoker": "s",
  • "state": "st",
  • "subscriber_ID": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "term_Date_type": "string",
  • "tier": "st",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "zip_Code_From": "string",
  • "zip_Code_Thru": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List PremRate

Lists all PremRate

SecurityapiKeyAuth and bearerAuth
Request
query Parameters
premRateType
string

PremRate_Type

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/premium-rates
Request samples 
Response samples 
No sample
List Premium Rates nested by Division/Plan/Category/Basis
Lists all Premium Rates for the given groupID and have it nested by Division, then by Plan, then by Rate Category, then by Rate Basis.


SecurityapiKeyAuth and bearerAuth 
Request 
query Parameters
premRateType
string
PremRate_Type


 
groupID
string
Group ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/premium-rates-nested
Request samples 
Response samples 
No sample
Get PremRate
Gets PremRate


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
premRateKey
required
integer <int32> 
PremRate Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/premium-rates/{premRateKey}
Request samples 
Response samples 
No sample
Update PremRate
Updates a specific PremRate.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
premRateKey
required
integer <int32> 
PremRate Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
premRate_Key
required
integer <int32> 
Unique identifier for the PremRate Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
add_On_Grouping_ID
string or null  <= 32 characters 
Used to identify Add On rates by Group


 
additional_Invoice_Address
string or null  <= 4 characters 
Address the additional invoice is sent to


 
additional_Invoice_Frequency
string or null  <= 2 characters 
Frequency of the additional invoice


 
additional_Invoice_Level
string or null  <= 16 characters 
Allows split billing at this level


 
address_Type
string or null  <= 16 characters 
Level of the Address used to determine if the rate applies


 
adjustment_Reason
integer or null <int32> 
Adjustment Reason of the PremRate


 
adult
required
boolean
Flag used to determine if the rate applies to Adults Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
age_From
integer or null <int32> 
Beginning Age range of the PremRate


 
age_Thru
integer or null <int32> 
Ending Age range of the PremRate


 
age_Type
string or null  <= 16 characters 
Detemines what date is used to calculate Age


 
age_Type_Month
string or null  <= 2 characters 
Detemines what Month is used if the Month Type is selected


 
assign_To_New_Division
required
boolean
Flag to determine if the rate applies to new Divisions Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
assign_To_New_Group
required
boolean
Flag to determine if the rate applies to new Groups Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
assign_To_New_Member
required
boolean
Flag to determine if the rate applies to new Members Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
auto_Adjust
required
boolean
Flag that determines if the rate is automatically adjusted Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
auto_Adjust_Reason
integer or null <int32> 
Reason applied to automatic adjustments


 
avoid_Retro
required
boolean
This flag indicates prevention of the retro logic from creating backout adjustments for this rate Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
benefit_Code
string or null  <= 10 characters 
Benefit Code of the PremRate


 
billing_Cycle_ID
string or null  <= 2 characters 
This is the Billing Cycle the invoice was gerenated for.


 
child
required
boolean
Flag used to determine if the rate applies to Children Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
city
string or null  <= 32 characters 
City of the Address used to determine if the rate applies


 
class_Code
string or null  <= 32 characters 
Class Code for the PremRate


 
country_ID
string or null  <= 8 characters 
Country ID of the Address used to determine if the rate applies


 
county_Code
string or null  <= 8 characters 
Country Code of the Address used to determine if the rate applies


 
description
string or null  <= 128 characters 
Description of the PremRate


 
division_ID
string or null  <= 20 characters 
Unique identifier for the Division


 
effective_Date
string or null <date-time> 
Effective Date of the PremRate


 
effective_Date_Type
string or null  <= 16 characters 
Determines the logic that modifies the Effective Date of the PremRate to a date based on the enrollment of the member. Note: The database will apply a default value of NORMAL for this field if a value is not provided.


 
employee_Employer_Contribution
string or null  <= 2 characters 
Determines if the contribution is Employee or Employer


 
employer_Contribution
number or null <double> 
Amount of the contribution


 
employer_Contribution_Pct
required
boolean
Determines if the contribution is a percentage Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
employer_Rate
number or null <double> 
Decimal value that defines the base employer rate


 
employer_Rate_Max
number or null <double> 
Maximum the employer rate will be regardless of the calculation


 
employer_Rate_Minimum
number or null <double> 
Minimum the employer rate will be regardless of the calculation


 
employer_Rate_Type
string or null  <= 32 characters 
Type of Employer Rate


 
employer_Rate_Variable1
number or null <double> 
First variable used in calculating the employer rate based on the type


 
employer_Rate_Variable2
number or null <double> 
Second variable used in calculating the employer rate based on the type


 
employer_Rate_Variable3
number or null <double> 
Third variable used in calculating the employer rate based on the type


 
employer_Round_Precision
integer or null <int32> 
Precision that the employerrate is rounded to


 
employer_Round_Type
string or null  <= 16 characters 
Type that determine how the employer rate is rounded


 
enrolled_Count_From
integer or null <int32> 
Beginning range based on number of enrollments


 
enrolled_Count_Thru
integer or null <int32> 
Ending range based on number of enrollments


 
enrolled_Count_Type
string or null  <= 16 characters 
Type of enrollments used to calculate the number of enrollments


 
enrolled_Duration_From
integer or null <int32> 
Beginning range based on length of enrollment


 
enrolled_Duration_Min
integer or null <int32> 
Minimum length of enrollment


 
enrolled_Duration_Option
string or null  <= 16 characters 
Determines if the date is based on the Member or the Plan enrollment


 
enrolled_Duration_Thru
integer or null <int32> 
Ending range based on length of enrollment


 
enrolled_Duration_Type
string or null  <= 16 characters 
Type of date used to determine the enrollment range


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


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


 
group_Division_Offering
required
boolean
Used to determine which records are updated when applying changes to a template Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
group_ID
string or null  <= 20 characters 
Unique identifier for the Group


 
member_Seq
string or null  <= 2 characters 
Unique sequence for a Member


 
network_ID
string or null  <= 10 characters 
Unique identifier for the Network


 
network_Type
string or null  <= 16 characters 
Type of Network


 
new_Hire_Age
required
boolean
Flag that determines the Age based on the date of hire Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
override_Enrolled_Dates
required
boolean
This flag indicates the rate should be paid if enrolled in for even a single day during the month. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
parent_PremRate_Key
integer or null <int32> 
PremRate_Key of the template rate this rate was created from


 
payment_Method
string or null  <= 20 characters 
The primary key of the payment method


 
plan_ID
string or null  <= 20 characters 
Unique identifier for the Plan


 
plan_Type
string or null  <= 6 characters 
Type of Plan


 
premRate_Basis
string or null  <= 32 characters 
Basis of the PremRate


 
premRate_Category
string or null  <= 32 characters 
Category of the PremRate


 
premRate_ID
string or null  <= 32 characters 
Unique identifier for the PremRate


 
premRate_Type
string or null  <= 16 characters 
Type of the PremRate


 
premium_Proration
required
boolean
Flag that determines if the rate is prorated Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
rate
number or null <double> 
Decimal value that defines the base rate


 
rate_Max
number or null <double> 
Maximum the rate will be regardless of the calculation


 
rate_Minimum
number or null <double> 
Minimum the rate will be regardless of the calculation


 
rate_Pace
string or null  <= 16 characters 
How often the rate applies


 
rate_Pace_Type
string or null  <= 16 characters 
The day the rate applies when the pace is weekly


 
rate_Round_Precision
integer or null <int32> 
Precision that the rate is rounded to


 
rate_Round_Type
string or null  <= 16 characters 
Type that determine how the rate is rounded


 
rate_Type
string or null  <= 32 characters 
Type of Rate


 
rate_Variable1
number or null <double> 
First variable used in calculating the rate based on the type


 
rate_Variable2
number or null <double> 
Second variable used in calculating the rate based on the type


 
rate_Variable3
number or null <double> 
Third variable used in calculating the rate based on the type


 
region_Code
string or null  <= 32 characters 
Region Code of the Address used to determine if the rate applies


 
relationship
string or null  <= 12 characters 
Relationship for the PremRate


 
sex
string or null  <= 1 characters 
Flag used to determine what Sex the rate applies to


 
smoker
string or null  <= 1 characters 
Flag to determine if the rate applies to Smokers


 
state
string or null  <= 2 characters 
State of the Address used to determine if the rate applies


 
subscriber_ID
string or null  <= 9 characters 
Unique identifier for the Subscriber


 
term_Date
string or null <date-time> 
Term Date of the PremRate


 
term_Date_type
string or null  <= 16 characters 
Determines the logic that modifies the Term Date of the PremRate to a date based on the enrollment of the member. Note: The database will apply a default value of NORMAL for this field if a value is not provided.


 
tier
string or null  <= 2 characters 
Tier of the PremRate


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


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


 
zip_Code_From
string or null  <= 32 characters 
Beginning Zip Code of the Address used to determine if the rate applies


 
zip_Code_Thru
string or null  <= 32 characters 
Ending Zip Code of the Address used to determine if the rate applies


 
Responses 
200
Success


401
Unauthorized


put/premium-rates/{premRateKey}
Request samples 
{
  • "premRate_Key": 0,
  • "add_On_Grouping_ID": "string",
  • "additional_Invoice_Address": "stri",
  • "additional_Invoice_Frequency": "st",
  • "additional_Invoice_Level": "string",
  • "address_Type": "string",
  • "adjustment_Reason": 0,
  • "adult": true,
  • "age_From": 0,
  • "age_Thru": 0,
  • "age_Type": "string",
  • "age_Type_Month": "st",
  • "assign_To_New_Division": true,
  • "assign_To_New_Group": true,
  • "assign_To_New_Member": true,
  • "auto_Adjust": true,
  • "auto_Adjust_Reason": 0,
  • "avoid_Retro": true,
  • "benefit_Code": "string",
  • "billing_Cycle_ID": "st",
  • "child": true,
  • "city": "string",
  • "class_Code": "string",
  • "country_ID": "string",
  • "county_Code": "string",
  • "description": "string",
  • "division_ID": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "effective_Date_Type": "string",
  • "employee_Employer_Contribution": "st",
  • "employer_Contribution": 0.1,
  • "employer_Contribution_Pct": true,
  • "employer_Rate": 0.1,
  • "employer_Rate_Max": 0.1,
  • "employer_Rate_Minimum": 0.1,
  • "employer_Rate_Type": "string",
  • "employer_Rate_Variable1": 0.1,
  • "employer_Rate_Variable2": 0.1,
  • "employer_Rate_Variable3": 0.1,
  • "employer_Round_Precision": 0,
  • "employer_Round_Type": "string",
  • "enrolled_Count_From": 0,
  • "enrolled_Count_Thru": 0,
  • "enrolled_Count_Type": "string",
  • "enrolled_Duration_From": 0,
  • "enrolled_Duration_Min": 0,
  • "enrolled_Duration_Option": "string",
  • "enrolled_Duration_Thru": 0,
  • "enrolled_Duration_Type": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "group_Division_Offering": true,
  • "group_ID": "string",
  • "member_Seq": "st",
  • "network_ID": "string",
  • "network_Type": "string",
  • "new_Hire_Age": true,
  • "override_Enrolled_Dates": true,
  • "parent_PremRate_Key": 0,
  • "payment_Method": "string",
  • "plan_ID": "string",
  • "plan_Type": "string",
  • "premRate_Basis": "string",
  • "premRate_Category": "string",
  • "premRate_ID": "string",
  • "premRate_Type": "string",
  • "premium_Proration": true,
  • "rate": 0.1,
  • "rate_Max": 0.1,
  • "rate_Minimum": 0.1,
  • "rate_Pace": "string",
  • "rate_Pace_Type": "string",
  • "rate_Round_Precision": 0,
  • "rate_Round_Type": "string",
  • "rate_Type": "string",
  • "rate_Variable1": 0.1,
  • "rate_Variable2": 0.1,
  • "rate_Variable3": 0.1,
  • "region_Code": "string",
  • "relationship": "string",
  • "sex": "s",
  • "smoker": "s",
  • "state": "st",
  • "subscriber_ID": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "term_Date_type": "string",
  • "tier": "st",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "zip_Code_From": "string",
  • "zip_Code_Thru": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete PremRate
Deletes an PremRate


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
premRateKey
required
integer <int32> 
PremRate Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/premium-rates/{premRateKey}
Request samples 
Create or Update Batch PremRate
Create or Update multiple PremRate at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
premRate_Key
required
integer <int32> 
Unique identifier for the PremRate Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
add_On_Grouping_ID
string or null  <= 32 characters 
Used to identify Add On rates by Group


 
additional_Invoice_Address
string or null  <= 4 characters 
Address the additional invoice is sent to


 
additional_Invoice_Frequency
string or null  <= 2 characters 
Frequency of the additional invoice


 
additional_Invoice_Level
string or null  <= 16 characters 
Allows split billing at this level


 
address_Type
string or null  <= 16 characters 
Level of the Address used to determine if the rate applies


 
adjustment_Reason
integer or null <int32> 
Adjustment Reason of the PremRate


 
adult
required
boolean
Flag used to determine if the rate applies to Adults Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
age_From
integer or null <int32> 
Beginning Age range of the PremRate


 
age_Thru
integer or null <int32> 
Ending Age range of the PremRate


 
age_Type
string or null  <= 16 characters 
Detemines what date is used to calculate Age


 
age_Type_Month
string or null  <= 2 characters 
Detemines what Month is used if the Month Type is selected


 
assign_To_New_Division
required
boolean
Flag to determine if the rate applies to new Divisions Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
assign_To_New_Group
required
boolean
Flag to determine if the rate applies to new Groups Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
assign_To_New_Member
required
boolean
Flag to determine if the rate applies to new Members Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
auto_Adjust
required
boolean
Flag that determines if the rate is automatically adjusted Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
auto_Adjust_Reason
integer or null <int32> 
Reason applied to automatic adjustments


 
avoid_Retro
required
boolean
This flag indicates prevention of the retro logic from creating backout adjustments for this rate Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
benefit_Code
string or null  <= 10 characters 
Benefit Code of the PremRate


 
billing_Cycle_ID
string or null  <= 2 characters 
This is the Billing Cycle the invoice was gerenated for.


 
child
required
boolean
Flag used to determine if the rate applies to Children Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
city
string or null  <= 32 characters 
City of the Address used to determine if the rate applies


 
class_Code
string or null  <= 32 characters 
Class Code for the PremRate


 
country_ID
string or null  <= 8 characters 
Country ID of the Address used to determine if the rate applies


 
county_Code
string or null  <= 8 characters 
Country Code of the Address used to determine if the rate applies


 
description
string or null  <= 128 characters 
Description of the PremRate


 
division_ID
string or null  <= 20 characters 
Unique identifier for the Division


 
effective_Date
string or null <date-time> 
Effective Date of the PremRate


 
effective_Date_Type
string or null  <= 16 characters 
Determines the logic that modifies the Effective Date of the PremRate to a date based on the enrollment of the member. Note: The database will apply a default value of NORMAL for this field if a value is not provided.


 
employee_Employer_Contribution
string or null  <= 2 characters 
Determines if the contribution is Employee or Employer


 
employer_Contribution
number or null <double> 
Amount of the contribution


 
employer_Contribution_Pct
required
boolean
Determines if the contribution is a percentage Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
employer_Rate
number or null <double> 
Decimal value that defines the base employer rate


 
employer_Rate_Max
number or null <double> 
Maximum the employer rate will be regardless of the calculation


 
employer_Rate_Minimum
number or null <double> 
Minimum the employer rate will be regardless of the calculation


 
employer_Rate_Type
string or null  <= 32 characters 
Type of Employer Rate


 
employer_Rate_Variable1
number or null <double> 
First variable used in calculating the employer rate based on the type


 
employer_Rate_Variable2
number or null <double> 
Second variable used in calculating the employer rate based on the type


 
employer_Rate_Variable3
number or null <double> 
Third variable used in calculating the employer rate based on the type


 
employer_Round_Precision
integer or null <int32> 
Precision that the employerrate is rounded to


 
employer_Round_Type
string or null  <= 16 characters 
Type that determine how the employer rate is rounded


 
enrolled_Count_From
integer or null <int32> 
Beginning range based on number of enrollments


 
enrolled_Count_Thru
integer or null <int32> 
Ending range based on number of enrollments


 
enrolled_Count_Type
string or null  <= 16 characters 
Type of enrollments used to calculate the number of enrollments


 
enrolled_Duration_From
integer or null <int32> 
Beginning range based on length of enrollment


 
enrolled_Duration_Min
integer or null <int32> 
Minimum length of enrollment


 
enrolled_Duration_Option
string or null  <= 16 characters 
Determines if the date is based on the Member or the Plan enrollment


 
enrolled_Duration_Thru
integer or null <int32> 
Ending range based on length of enrollment


 
enrolled_Duration_Type
string or null  <= 16 characters 
Type of date used to determine the enrollment range


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


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


 
group_Division_Offering
required
boolean
Used to determine which records are updated when applying changes to a template Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
group_ID
string or null  <= 20 characters 
Unique identifier for the Group


 
member_Seq
string or null  <= 2 characters 
Unique sequence for a Member


 
network_ID
string or null  <= 10 characters 
Unique identifier for the Network


 
network_Type
string or null  <= 16 characters 
Type of Network


 
new_Hire_Age
required
boolean
Flag that determines the Age based on the date of hire Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
override_Enrolled_Dates
required
boolean
This flag indicates the rate should be paid if enrolled in for even a single day during the month. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
parent_PremRate_Key
integer or null <int32> 
PremRate_Key of the template rate this rate was created from


 
payment_Method
string or null  <= 20 characters 
The primary key of the payment method


 
plan_ID
string or null  <= 20 characters 
Unique identifier for the Plan


 
plan_Type
string or null  <= 6 characters 
Type of Plan


 
premRate_Basis
string or null  <= 32 characters 
Basis of the PremRate


 
premRate_Category
string or null  <= 32 characters 
Category of the PremRate


 
premRate_ID
string or null  <= 32 characters 
Unique identifier for the PremRate


 
premRate_Type
string or null  <= 16 characters 
Type of the PremRate


 
premium_Proration
required
boolean
Flag that determines if the rate is prorated Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
rate
number or null <double> 
Decimal value that defines the base rate


 
rate_Max
number or null <double> 
Maximum the rate will be regardless of the calculation


 
rate_Minimum
number or null <double> 
Minimum the rate will be regardless of the calculation


 
rate_Pace
string or null  <= 16 characters 
How often the rate applies


 
rate_Pace_Type
string or null  <= 16 characters 
The day the rate applies when the pace is weekly


 
rate_Round_Precision
integer or null <int32> 
Precision that the rate is rounded to


 
rate_Round_Type
string or null  <= 16 characters 
Type that determine how the rate is rounded


 
rate_Type
string or null  <= 32 characters 
Type of Rate


 
rate_Variable1
number or null <double> 
First variable used in calculating the rate based on the type


 
rate_Variable2
number or null <double> 
Second variable used in calculating the rate based on the type


 
rate_Variable3
number or null <double> 
Third variable used in calculating the rate based on the type


 
region_Code
string or null  <= 32 characters 
Region Code of the Address used to determine if the rate applies


 
relationship
string or null  <= 12 characters 
Relationship for the PremRate


 
sex
string or null  <= 1 characters 
Flag used to determine what Sex the rate applies to


 
smoker
string or null  <= 1 characters 
Flag to determine if the rate applies to Smokers


 
state
string or null  <= 2 characters 
State of the Address used to determine if the rate applies


 
subscriber_ID
string or null  <= 9 characters 
Unique identifier for the Subscriber


 
term_Date
string or null <date-time> 
Term Date of the PremRate


 
term_Date_type
string or null  <= 16 characters 
Determines the logic that modifies the Term Date of the PremRate to a date based on the enrollment of the member. Note: The database will apply a default value of NORMAL for this field if a value is not provided.


 
tier
string or null  <= 2 characters 
Tier of the PremRate


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


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


 
zip_Code_From
string or null  <= 32 characters 
Beginning Zip Code of the Address used to determine if the rate applies


 
zip_Code_Thru
string or null  <= 32 characters 
Ending Zip Code of the Address used to determine if the rate applies


 
Responses 
207
Success


401
Unauthorized


put/premium-rates-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}
List Included PremRate
Lists all PremRate included in the specified Group ID and Division ID.


SecurityapiKeyAuth and bearerAuth 
Request 
query Parameters
groupId
required
string
Group ID


 
divisionId
string
Division ID


 
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/included-premium-rates
Request samples 
Response samples 
No sample
Add Rate from Template Advanced API 
Create a new Premium Rate based on the selected Template Rate.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
premRateKey
required
integer <int32> 
Subscriber ID


 
groupID
required
string
Subscriber ID


 
divisionID
required
string
Subscriber ID


 
premRateType
required
string
Subscriber ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


post/premium-rates/{premRateKey}/add-from-template/{groupID}/{divisionID}/{premRateType}
Request samples 
Response samples 
No sample