Sign in
latestSwagger 2.02026-08-0982147352.7 KB

be66ed178abe

Eligibility

eligibility rates

Partially updates eligibility rates.<p>Scopes: import_plan</p>

patch/v{version}/eligibilities/{id}/rates

Path parameters

idstring required
versionstring required

Request body

rate_type'Table' | 'Tier-Table' | 'Tier' required
plan_typestring

The type of the plan. See Plan.Type for more information.

rate_basisstring

The rate basis for a life plan.

rate_adjustment_factorstring

The Rate Adjustment Factor,

per_unitnumber double

The per unit amount for a life plan.

tier_employeestring

Amount for employee. Used when RateType == "Tier". Example: $12.10 or 30%.

tier_spousestring

Amount for spouse. Used when RateType == "Tier". Example: $12.10 or 30%.

tier_childrenstring

Amount for children. Used when RateType = "Tier". Example: $12.10 or 30%.

tier_dependentsstring

Amount for dependents. Used when RateType = "Tier". Example: $12.10 or 30%.

tier_eestring

Amount for employee Only. Used when RateType = "Tier". Example: $12.10 or 30%.

tier_esstring

Amount for employee + spouse. Used when RateType = "Tier". Example: $12.10 or 30%.

tier_e_s1cstring

Amount for employee + spouse + 1 child. The rate for child 1. Used when RateType = "Tier". Example: $12.10 or 30%.

tier_e_s2cstring

Amount for employee + spouse + 2 children. Used when RateType = "Tier". Example: $12.10 or 30%.

tier_e_s3cstring

Amount for employee + spouse + 3 children. Used when RateType = "Tier". Example: $12.10 or 30%.

tier_e1cstring

Amount for employee + 1 child. Used when RateType = "Tier". Example: $12.10 or 30%.

tier_e2cstring

Amount for employee + 2 children. Used when RateType = "Tier". Example: $12.10 or 30%.

tier_e3cstring

Amount for employee + 3 children. Used when RateType = "Tier". Example: $12.10 or 30%.

tier_rates_tobaccostring[]

Used when RateType = "Tier". Example: $12.10.

tier_table_rates_ee_onlystring[]

Used when RateType = "Tier-Table". Example: $12.10.

tier_table_rates_eespstring[]

Used when RateType = "Tier-Table". Example: $12.10.

tier_table_rates_e_e1chstring[]

Used when RateType = "Tier-Table". Example: $12.10.

tier_table_rates_eechstring[]

Used when RateType = "Tier-Table". Example: $12.10.

tier_table_rates_familystring[]

Used when RateType = "Tier-Table". Example: $12.10.

tier_table_rates_ee_only_tobaccostring[]

Used when RateType = "Tier-Table". Example: $12.10.

tier_table_rates_eesp_tobaccostring[]

Used when RateType = "Tier-Table". Example: $12.10.

tier_table_rates_e_e1ch_tobaccostring[]

Used when RateType = "Tier-Table". Example: $12.10.

tier_table_rates_eech_tobaccostring[]

Used when RateType = "Tier-Table". Example: $12.10.

tier_table_rates_family_tobaccostring[]

Used when RateType = "Tier-Table". Example: $12.10.

tier_table_rates_ee_only_malestring[]

Used when RateType = "Tier-Table". Example: $12.10.

tier_table_rates_eesp_malestring[]

Used when RateType = "Tier-Table". Example: $12.10.

tier_table_rates_e_e1ch_malestring[]

Used when RateType = "Tier-Table". Example: $12.10.

tier_table_rates_eech_malestring[]

Used when RateType = "Tier-Table". Example: $12.10.

tier_table_rates_family_malestring[]

Used when RateType = "Tier-Table". Example: $12.10.

tier_table_rates_ee_only_femalestring[]

Used when RateType = "Tier-Table". Example: $12.10.

tier_table_rates_eesp_femalestring[]

Used when RateType = "Tier-Table". Example: $12.10.

tier_table_rates_e_e1ch_femalestring[]

Used when RateType = "Tier-Table". Example: $12.10.

tier_table_rates_eech_femalestring[]

Used when RateType = "Tier-Table". Example: $12.10.

tier_table_rates_family_femalestring[]

Used when RateType = "Tier-Table". Example: $12.10.

table_columns'Rates' | 'Employee & Spouse Rates' | 'Gender Rates' | 'Tobacco Rates' | 'Gender & Tobacco Rates' | 'Employee & Spouse & Tobacco Rates' | 'Employee & Spouse & Child Rates'

Defaults to Rates.

tier_table_columns'Rates' | 'Gender Rates' | 'Tobacco Rates'

Defaults to Rates.

table_ratesstring[]

Contains the rate table amounts by age, [0] = {0-17}, [1] = 18, [2] = 19, ..., [62] = 80+. Used when RateType = "Table". Note that the specific configuration will depend on the AgeBandType value. Example: $12.10.

table_employeestring[]

Contains the rate table amounts by age, [0] = {0-17}, [1] = 18, [2] = 19, ..., [62] = 80+. Used when RateType = "Table". Note that the specific configuration will depend on the AgeBandType value. Example: $12.10.

table_spousestring[]

Contains the rate table amounts by age, [0] = {0-17}, [1] = 18, [2] = 19, ..., [62] = 80+. Used when RateType = "Table". Note that the specific configuration will depend on the AgeBandType value. Example: $12.10.

table_employee_tobaccostring[]

Contains the rate table amounts by age, [0] = {0-17}, [1] = 18, [2] = 19, ..., [62] = 80+. Used when RateType = "Table". Note that the specific configuration will depend on the AgeBandType value. Example: $12.10.

table_spouse_tobaccostring[]

Contains the rate table amounts by age, [0] = {0-17}, [1] = 18, [2] = 19, ..., [62] = 80+. Used when RateType = "Table". Note that the specific configuration will depend on the AgeBandType value. Example: $12.10 or 30%.

table_childstring[]

Contains the rate table amounts by age, [0] = {0-17}, [1] = 18, [2] = 19, ..., [62] = 80+. Used when RateType = "Table". Note that the specific configuration will depend on the AgeBandType value. Example: $12.10.

table_malestring[]

Contains the rate table amounts by age, [0] = {0-17}, [1] = 18, [2] = 19, ..., [62] = 80+. Used when RateType = "Table". Note that the specific configuration will depend on the AgeBandType value. Example: $12.10.

table_femalestring[]

Contains the rate table amounts by age, [0] = {0-17}, [1] = 18, [2] = 19, ..., [62] = 80+. Used when RateType = "Table". Note that the specific configuration will depend on the AgeBandType value. Example: $12.10.

table_tobaccostring[]

Contains the rate table amounts for the employee by age, [0] = {0-17}, [1] = 18, [2] = 19, ..., [62] = 80+. Used when RateType = "Table". Note that the specific configuration will depend on the AgeBandType value. Example: $12.10.

table_male_tobaccostring[]

Contains the rate table amounts by age, [0] = {0-17}, [1] = 18, [2] = 19, ..., [62] = 80+. Used when RateType = "Table". Note that the specific configuration will depend on the AgeBandType value. Example: $12.10.

table_female_tobaccostring[]

Contains the rate table amounts by age, [0] = {0-17}, [1] = 18, [2] = 19, ..., [62] = 80+. Used when RateType = "Table". Note that the specific configuration will depend on the AgeBandType value. Example: $12.10.

table_child1string

Amount for 1 child. Used when RateType = "Table". Example: $12.10 or 30%.

table_child2string

Amount for 2 children. Used when RateType = "Table". Example: $12.10 or 30%.

table_child3string

Amount for 3 children. Used when RateType = "Table". Example: $12.10 or 30%.

age_band_type'All Ages (starting with 0-17)' | 'All Ages' | '5 Year Age Bands' | '10 Year Age Bands'

Age bands for the rates. The default is "All Ages (starting with 0-17)", which starts with 0-17.

base_spouse_age_off_employeeboolean

Base the spouse age off employee age.

base_spouse_tobacco_off_employeeboolean

Base the tobacco spouse age off employee age.

base_adult_children_off_ageboolean

Base the adult children age off their age.

rate_library_plan_idstring

For rates associated with a Rate Library, the external Plan Id for the rate.

rate_library_namestring

For rates associated with a Rate Library, the library name for the rate.

Response

No Content