Scopes: import_plan
## Path parameters - `id` string, required - `version` string, required ## Request body - DtosPlanRenewal — The payload for a plan renewal. - `admin_name` string, required — The plan name displayed to the administrators. - `display_name` string, required — The plan name displayed to the enrollees. - `start_date` string, required — The effective date of the plan. - `end_date` string, required — The end date of the plan. - `available_start_date` string, required — The Available Start Date is the first date that employees are able to see the plan. This should not be confused with open enrollment dates. If an employee logs in during this time period AND they are eligible for the plan they would be given the option to enroll. - `options` string[], required — The options for the renewal. ## Response `200` Success - DtosPlan - `id` string — The Ease plan id. - `carrier` DtosCarrier - `id` string, required — The Id of the carrier. - `name` string, required — The name of the carrier. - `group_number` string — The group number of the carrier. - `group_number` string — The plan group number. - `contribution_type` string — The plan contribution type. - `name` string — The plan name. - `admin_name` string — The plan admin name. - `import_id` string — The plan import id. - `type` string — The plan type. Please see Plan Types for a complete list of supported values. - `start_date` string — The plan start date. - `end_date` string — The plan end date. The date is inclusive. - `created` string — The plan created date / time. - `cobra_eligibility` string — The Cobra eligibility setting. The default is "Not Eligible". - `provides_minimum_value` boolean — Does this plan provide minimum value? - `provides_creditable_coverage` boolean — Does this plan provide creditable coverage? - `self_funded` boolean — Is this plan self-funded? - `is_open_enrollment_plan` boolean — Is this plan a current Open Enrollment option? - `benefits` DtosPlanBenefits - `deductible` string - `office_visit` string - `inpatient` string - `outpatient` string - `emergency_room` string - `rx` string - `lab_x_ray` string - `out_of_network` string - `out_of_pocket_max` string - `preventive` string - `basic` string - `major` string - `ortho` string - `annual_benefit_max` string - `exam` string - `materials` string - `eye_glass_lenses` string - `frame_allowance` string - `contact_lenses` string - `exam_service_interval` string - `lenses_and_frame_service_interval` string - `coinsurance` string - `other` string - `ee_benefit_type` 'NONE' | 'Flat Amount' | 'X Earnings' | '% Employee' | 'Increments' | 'Custom' | 'Custom (Based Off Employee Selection)' — Benefit calculation type (i.e., Flat Amount, X Earnings, etc) - `is_volume_plan` boolean — Denotes that the plan is a volume based plan - `volume_basis_percent` string — The volumne basis percent, based on earnings, for earnings based plans - `ee_earnings_min` string — The minimum electable benefit amount for earnings based plans - `ee_earnings_max` string — The maximum electable benefit amount for earnings based plans - `ee_increment_from` string — The minimum electable benefit amount for increment based plans - `ee_increment_to` string — The maximum electable benefit amount for increment based plans - `ee_increment_by` string — The benefit increase increment for increment based plans - `ee_flat_amount` string — The electable amount for a flat amount plane - `ee_guaranteed_issue` string — The Guaranteed Issue of a plan - `sp_percentage` string — The percentage paid for spouse - `ch_percentage` string — The percent paid for child(ren) - `request_primary_care_provider_id` boolean — Whether or not the plan requires a primary care provider id. - `request_primary_care_provider_name` boolean — Whether or not the plan requires a primary care provider name. - `documents` DtosPlanDocument[] — Any plan specific linkable documents. - `id` string, required — The Id of the document. - `name` string, required — The name of the document. This will be displayed to the user. - `url` string — The external link to the document. - `requires_review` boolean — Indicates whether document has to be reviewed by employee. - `type` string — Describes what kind of file is associated with this document. Please use "Web Address" for this field when adding documents to plans. - `system_type` string — Describes the purpose of the document. Please use "Plan" for this field when adding documents to plans. - `eligibilities` DtosEligibility[] — Plan eligibilities with their respective Rate Types. - `id` string — The Ease eligibility id. - `rates` DtosEligibilityRates - `rate_type` 'Table' | 'Tier-Table' | 'Tier', required - `plan_type` string — The type of the plan. See Plan.Type for more information. - `rate_basis` string — The rate basis for a life plan. - `rate_adjustment_factor` string — The Rate Adjustment Factor, - `per_unit` number, double — The per unit amount for a life plan. - `tier_employee` string — Amount for employee. Used when RateType == "Tier". Example: $12.10 or 30%. - `tier_spouse` string — Amount for spouse. Used when RateType == "Tier". Example: $12.10 or 30%. - `tier_children` string — Amount for children. Used when RateType = "Tier". Example: $12.10 or 30%. - `tier_dependents` string — Amount for dependents. Used when RateType = "Tier". Example: $12.10 or 30%. - `tier_ee` string — Amount for employee Only. Used when RateType = "Tier". Example: $12.10 or 30%. - `tier_es` string — Amount for employee + spouse. Used when RateType = "Tier". Example: $12.10 or 30%. - `tier_e_s1c` string — Amount for employee + spouse + 1 child. The rate for child 1. Used when RateType = "Tier". Example: $12.10 or 30%. - `tier_e_s2c` string — Amount for employee + spouse + 2 children. Used when RateType = "Tier". Example: $12.10 or 30%. - `tier_e_s3c` string — Amount for employee + spouse + 3 children. Used when RateType = "Tier". Example: $12.10 or 30%. - `tier_e1c` string — Amount for employee + 1 child. Used when RateType = "Tier". Example: $12.10 or 30%. - `tier_e2c` string — Amount for employee + 2 children. Used when RateType = "Tier". Example: $12.10 or 30%. - `tier_e3c` string — Amount for employee + 3 children. Used when RateType = "Tier". Example: $12.10 or 30%. - `tier_rates_tobacco` string[] — Used when RateType = "Tier". Example: $12.10. - `tier_table_rates_ee_only` string[] — Used when RateType = "Tier-Table". Example: $12.10. - `tier_table_rates_eesp` string[] — Used when RateType = "Tier-Table". Example: $12.10. - `tier_table_rates_e_e1ch` string[] — Used when RateType = "Tier-Table". Example: $12.10. - `tier_table_rates_eech` string[] — Used when RateType = "Tier-Table". Example: $12.10. - `tier_table_rates_family` string[] — Used when RateType = "Tier-Table". Example: $12.10. - `tier_table_rates_ee_only_tobacco` string[] — Used when RateType = "Tier-Table". Example: $12.10. - `tier_table_rates_eesp_tobacco` string[] — Used when RateType = "Tier-Table". Example: $12.10. - `tier_table_rates_e_e1ch_tobacco` string[] — Used when RateType = "Tier-Table". Example: $12.10. - `tier_table_rates_eech_tobacco` string[] — Used when RateType = "Tier-Table". Example: $12.10. - `tier_table_rates_family_tobacco` string[] — Used when RateType = "Tier-Table". Example: $12.10. - `tier_table_rates_ee_only_male` string[] — Used when RateType = "Tier-Table". Example: $12.10. - `tier_table_rates_eesp_male` string[] — Used when RateType = "Tier-Table". Example: $12.10. - `tier_table_rates_e_e1ch_male` string[] — Used when RateType = "Tier-Table". Example: $12.10. - `tier_table_rates_eech_male` string[] — Used when RateType = "Tier-Table". Example: $12.10. - `tier_table_rates_family_male` string[] — Used when RateType = "Tier-Table". Example: $12.10. - `tier_table_rates_ee_only_female` string[] — Used when RateType = "Tier-Table". Example: $12.10. - `tier_table_rates_eesp_female` string[] — Used when RateType = "Tier-Table". Example: $12.10. - `tier_table_rates_e_e1ch_female` string[] — Used when RateType = "Tier-Table". Example: $12.10. - `tier_table_rates_eech_female` string[] — Used when RateType = "Tier-Table". Example: $12.10. - `tier_table_rates_family_female` string[] — 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_rates` string[] — 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` string[] — 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` string[] — 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_tobacco` string[] — 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_tobacco` string[] — 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_child` string[] — 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_male` string[] — 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` string[] — 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_tobacco` string[] — 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_tobacco` string[] — 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_tobacco` string[] — 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_child1` string — Amount for 1 child. Used when RateType = "Table". Example: $12.10 or 30%. - `table_child2` string — Amount for 2 children. Used when RateType = "Table". Example: $12.10 or 30%. - `table_child3` string — 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_employee` boolean — Base the spouse age off employee age. - `base_spouse_tobacco_off_employee` boolean — Base the tobacco spouse age off employee age. - `base_adult_children_off_age` boolean — Base the adult children age off their age. - `rate_library_plan_id` string — For rates associated with a Rate Library, the external Plan Id for the rate. - `rate_library_name` string — For rates associated with a Rate Library, the library name for the rate. - `contributions` DtosEligibilityContributions - `contribution_detail` 'Table' | 'Tier' | 'Custom' | 'Tier-Tobacco', required - `contribution_type` 'Employee' | 'Employer' | 'Base Plan', required — Specifies who the contribution costs are attributed to. "Base Plan" can be used to inherit from the base plan. - `base_plan_id` string — The base plan id. Must match an existing plan_id from the list of externally supplied plans OR match an existing ease plan id. - `dependents` string — Combined Dependents. Optionally used when contribution_detail = "Tier". - `ee` string — Employee only. Used when contribution_detail = "Tier". - `es` string — Employee + Spouse. Used when contribution_detail = "Tier". - `e_s1c` string — Employee + Spouse + 1 Child. Used when contribution_detail = "Tier". - `e_s2c` string — Employee + Spouse + 2 Children. Used when contribution_detail = "Tier". - `e_s3c` string — Employee + Spouse + 3 Children. Used when contribution_detail = "Tier". - `e1c` string — Employee + 1 child. Used when contribution_detail = "Tier". - `e2c` string — Employee + 2 children. Used when contribution_detail = "Tier". - `e3c` string — Employee + 3 children. Used when contribution_detail = "Tier". - `ee_tobacco` string — Employee only. Used when contribution_detail = "Tier-Tobacco". - `es_tobacco` string — Employee + Spouse. Used when contribution_detail = "Tier-Tobacco". - `e_s1c_tobacco` string — Employee + Spouse + 1 child. Used when contribution_detail = "Tier-Tobacco". - `e_s2c_tobacco` string — Employee + Spouse + 2 children. Used when contribution_detail = "Tier-Tobacco". - `e_s3c_tobacco` string — Employee + Spouse + 3 children. Used when contribution_detail = "Tier-Tobacco". - `e1c_tobacco` string — Employee + 1 child. Used when contribution_detail = "Tier-Tobacco". - `e2c_tobacco` string — Employee + 2 children. Used when contribution_detail = "Tier-Tobacco". - `e3c_tobacco` string — Employee + 3 children. Used when contribution_detail = "Tier-Tobacco". - `employee` string — Used when contribution_detail = "Table". - `spouse` string — Used when contribution_detail = "Table". - `children` string — Used when contribution_detail = "Table". - `employee_tobacco` string — Used when contribution_detail = "Table". - `spouse_tobacco` string — Used when contribution_detail = "Table". - `child1` string — Used when contribution_detail = "Table". - `child2` string — Used when contribution_detail = "Table". - `child3` string — Used when contribution_detail = "Table". - `family` string — Used when contribution_detail = "Table". - `overall_max` string — Used when contribution_detail = "Table". - `apply_base_plan_amount_to_employee_only` boolean — Indicates whether or not to limit the base amount to employee only. - `job_classes` DtosJobClassLink[] — The JobClasses for the plan eligibility. - `name` string, required — The name of the object. - `id` string, required — The object id. - `href` string, required — The object uri. - `children_age_min` integer — Minumum child age for eligibility. - `children_age_max` integer — Maximum child age for eligibility. - `children_student_age_min` integer — Minumum child/student age for eligibility. - `children_student_age_max` integer — Maximum child/student age for eligibility. - `children_disabled_age_min` integer — Minumum disabled child age for eligibility. - `children_disabled_age_max` integer — Maximum disabled child age for eligibility. - `locations` DtosLocation[] — The locations for plan eligibility. - `id` string, required — The id of the location. - `name` string, required — The name of the location. - `created` string, date-time, required — The datetime the location was created. - `last_modified` string, date-time, required — The datetime the location was last modified. - `addr1` string — The Location Address 1. - `addr2` string — The Location Address 2. - `city` string — The Location City. - `state` string — The Location State. - `zip` string — The Location Zip. - `county` string — The Location County. - `country` 'Afghanistan' | 'Albania' | 'Algeria' | 'Argentina' | 'Armenia' | 'Australia' | 'Austria' | 'Azerbaijan' | 'Bahrain' | 'Bangladesh' | 'Belarus' | 'Belgium' | 'Belize' | 'Benin' | 'Bhutan' | 'Bolivarian Republic of Venezuela' | 'Bolivia' | 'Bosnia and Herzegovina' | 'Botswana' | 'Brazil' | 'Brunei Darussalam' | 'Bulgaria' | 'Burundi' | 'Cambodia' | 'Cameroon' | 'Canada' | 'Caribbean' | 'Chile' | 'Colombia' | 'Congo (DRC)' | 'Costa Rica' | 'Côte d'Ivoire' | 'Croatia' | 'Cuba' | 'Cyprus' | 'Czech Republic' | 'Denmark' | 'Djibouti' | 'Dominican Republic' | 'Ecuador' | 'Egypt' | 'El Salvador' | 'Eritrea' | 'Estonia' | 'Ethiopia' | 'Faroe Islands' | 'Fiji' | 'Finland' | 'France' | 'Gambia' | 'Georgia' | 'Germany' | 'Ghana' | 'Greece' | 'Greenland' | 'Guatemala' | 'Haiti' | 'Honduras' | 'Hong Kong S.A.R.' | 'Hungary' | 'Iceland' | 'India' | 'Indonesia' | 'Iran' | 'Iraq' | 'Ireland' | 'Islamic Republic of Pakistan' | 'Israel' | 'Italy' | 'Jamaica' | 'Japan' | 'Jordan' | 'Kazakhstan' | 'Kenya' | 'Korea' | 'Kuwait' | 'Kyrgyzstan' | 'Lao P.D.R.' | 'Latin America' | 'Latvia' | 'Lebanon' | 'Liberia' | 'Libya' | 'Liechtenstein' | 'Lithuania' | 'Luxembourg' | 'Macao S.A.R.' | 'Malaysia' | 'Maldives' | 'Mali' | 'Malta' | 'Mexico' | 'Moldova' | 'Mongolia' | 'Montenegro' | 'Morocco' | 'Myanmar' | 'Namibia' | 'Nepal' | 'Netherlands' | 'New Zealand' | 'Nicaragua' | 'Nigeria' | 'North Macedonia' | 'Norway' | 'Oman' | 'Palestine' | 'Panama' | 'Paraguay' | 'People's Republic of China' | 'Peru' | 'Philippines' | 'Poland' | 'Portugal' | 'Principality of Monaco' | 'Puerto Rico' | 'Qatar' | 'Réunion' | 'Romania' | 'Russia' | 'Rwanda' | 'Saudi Arabia' | 'Senegal' | 'Serbia' | 'Sierra Leone' | 'Singapore' | 'Slovakia' | 'Slovenia' | 'Somalia' | 'South Africa' | 'Spain' | 'Sri Lanka' | 'Sudan' | 'Sweden' | 'Switzerland' | 'Syria' | 'Taiwan' | 'Tajikistan' | 'Tanzania' | 'Thailand' | 'Trinidad and Tobago' | 'Tunisia' | 'Turkey' | 'Turkmenistan' | 'U.A.E.' | 'Uganda' | 'Ukraine' | 'United Kingdom' | 'United States' | 'Uruguay' | 'Uzbekistan' | 'Vietnam' | 'Yemen' | 'Zambia' | 'Zimbabwe' — The Location Country. - `phone` string — The phone number of the location. - `ein` string — The EIN of the location. - `fax` string — The fax number of the location. - `headquarters` boolean — Is this the headquarters for the company? - `name` string — The eligibility name. - `policy_number` string — The Policy Number of the eligibility. - `subgroup_number` string — The subgroupnumber of the eligibility. - `scheduled_hours` string — The scheduledhours of the eligibility. - `waiting_period_amount` integer — The waiting period amount of the eligibility. - `waiting_period_type` 'Days' | 'Months' | '' — The waiting period type of the eligibility. - `entry_date` 'First of the Month' | 'First of the Month Next Following' | 'Immediate' | 'Semi-Annual' | 'Quarterly' | '15th of the Month' | 'First of the Month (Coinciding)' — The entry date of the eligibility. - `term_date` 'End of the Month' | 'End of Second Month' | 'Immediate' | '15th of the Month' — The termination date of the eligibility. - `rate_type` string — The type of rates. - `rate_age_band_type` string — The age band type used for the rates. - `tax` 'Pre-Tax' | 'Post-Tax' — The Tax treatment of the eligibility. - `is_spouse_eligible` boolean — Indicates if the spouse eligible for coverage. - `is_different_gender_partner_eligible` boolean — Indicates if different gender partner eligible for coverage. - `is_same_gender_partner_eligible` boolean — Indicates if same gender partner eligible for coverage. - `is_child_eligible` boolean — Indicates if children are eligible for coverage. - `plan_stats` DtosPlanStats — Aggregated counts for the plan enrollment. - `eligible_count` integer - `enrolled_count` integer - `waived_count` integer - `employee_premium_total` number, double - `spouse_premium_total` number, double - `child_premium_total` number, double - `total_premium_total` number, double - `employer_cost_total` number, double - `integration_premium_total` number, double - `integration_enrolled_total` integer - `integration_assisted_total` integer - `employee_statuses` 0KeyValuePairEmployeeStatusPlanStats[] — Plan stats grouped by employee statuses. - `key` 'Active' | 'Leave of Absence' | 'COBRA' | 'Terminated' | 'Resigned' | 'Deceased' | 'Retired' | 'Applicant' | 'Test' - `value` DtosPlanStats — recursive - `connect_status` 'Not Connected' | 'Pending' | 'Pending (New)' | 'Ease Review' | 'Ease Review (New)' | 'Carrier Review' | 'Connected' | 'Self-Bill' | 'EOI' | 'EOI & Self-Bill' | 'Disabled' | 'Broker Submitted' | 'Suspended' — The plan connect status. - `external_plan_id` string — The plan external id. - `previous_plan_id` string — The previous plan id. --- [API](https://skmtc.net/ease/apis/version-2.md) · [All operations](https://skmtc.net/ease/apis/version-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ease/version-2/revisions/be66ed178abe/schema)