{ "api": "Bnchmrk Partner API", "generated_from": "https://www.bnchmrk.com/developers/openapi.json", "field_count": 239, "fields": [ { "resource": "Employers", "endpoint": "POST /employers/", "section": "", "api_field_name": "name", "plain_label": "Employer name", "data_type": "string", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Provide a unique employer name to identify and differentiate. Please create only one record per employer." }, { "resource": "Employers", "endpoint": "POST /employers/", "section": "", "api_field_name": "url", "plain_label": "Company website", "data_type": "string", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Unique web address for employer. Should start with 'https://' or 'http://'." }, { "resource": "Employers", "endpoint": "POST /employers/", "section": "", "api_field_name": "size", "plain_label": "Eligible employee count", "data_type": "string", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Number of full-time eligible employees." }, { "resource": "Employers", "endpoint": "POST /employers/", "section": "", "api_field_name": "naics_codes", "plain_label": "NAICS industry codes", "data_type": "array", "required": "REQUIRED", "allowed_values": "", "constraints": "max 4 items, unique items", "default": "", "description": "List of 6-digit NAICS codes. Each code must be 6 digits. A maximum of 4 codes may be assigned per employer." }, { "resource": "Employers", "endpoint": "POST /employers/", "section": "", "api_field_name": "location_states", "plain_label": "Location states", "data_type": "array", "required": "REQUIRED", "allowed_values": "", "constraints": "unique items", "default": "", "description": "List of US states with physical locations. Each entry is a capitalized 2-letter abbreviation (e.g. CA, NY, TX). Washington, DC is supported and entered as 'DC'." }, { "resource": "Employers", "endpoint": "POST /employers/", "section": "", "api_field_name": "other_filters", "plain_label": "Applied filters", "data_type": "array", "required": "REQUIRED", "allowed_values": "", "constraints": "unique items", "default": "", "description": "List of filter UUIDs applied to the employer. Standard filters available to all accounts: 'Government Contractor' (a0924d18-5f7b-4643-8a2c-5de17be898c3) and 'Non-Profit Organization' (8c2bb207-44c1-404e-b377-c2d00f40211b). Some licenses support additional custom filters. Send an empty array if none apply." }, { "resource": "Employers", "endpoint": "POST /employers/", "section": "", "api_field_name": "division", "plain_label": "Division ID", "data_type": "string", "required": "REQUIRED", "allowed_values": "", "constraints": "format: uuid", "default": "", "description": "Required. Unique ID of the division the employer belongs to. A division is a dedicated group within an Account that secures benefit data — only users assigned to a division can view, edit, and report on employers/plans within it. Bnchmrk provides division UUIDs to partners; they can also be retrieved via GET /divisions/list/." }, { "resource": "Medical/Rx Plans", "endpoint": "POST /plans/medical/", "section": "", "api_field_name": "employer", "plain_label": "Employer ID", "data_type": "string", "required": "REQUIRED", "allowed_values": "", "constraints": "format: uuid", "default": "", "description": "ID of employer that offers plan." }, { "resource": "Medical/Rx Plans", "endpoint": "POST /plans/medical/", "section": "", "api_field_name": "title", "plain_label": "Plan title", "data_type": "string", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Unique plan title to identify and differentiate. Can match title provided by insurer." }, { "resource": "Medical/Rx Plans", "endpoint": "POST /plans/medical/", "section": "", "api_field_name": "carrier", "plain_label": "Carrier / ASO provider", "data_type": "string", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Name of insurance company for fully-insured plans and ASO provider for self-insured plans." }, { "resource": "Medical/Rx Plans", "endpoint": "POST /plans/medical/", "section": "", "api_field_name": "start_date", "plain_label": "Plan start date", "data_type": "string", "required": "REQUIRED", "allowed_values": "", "constraints": "format: date", "default": "", "description": "Formated YYYY-MM-DD." }, { "resource": "Medical/Rx Plans", "endpoint": "POST /plans/medical/", "section": "", "api_field_name": "end_date", "plain_label": "Plan end date", "data_type": "string", "required": "REQUIRED", "allowed_values": "", "constraints": "format: date", "default": "", "description": "Formated YYYY-MM-DD." }, { "resource": "Medical/Rx Plans", "endpoint": "POST /plans/medical/", "section": "", "api_field_name": "from_plan", "plain_label": "Prior-year plan ID", "data_type": "string", "required": "OPTIONAL", "allowed_values": "", "constraints": "format: uuid", "default": "", "description": "ID of prior year plan from which current plan is renewed or converted." }, { "resource": "Medical/Rx Plans", "endpoint": "POST /plans/medical/", "section": "", "api_field_name": "from_action", "plain_label": "Prior-year relationship", "data_type": "string", "required": "OPTIONAL", "allowed_values": "RENEWED | CONVERTED", "constraints": "", "default": "", "description": "Prior year plan is renewed if with the same carrier or converted if moved to a different carrier." }, { "resource": "Medical/Rx Plans", "endpoint": "POST /plans/medical/", "section": "", "api_field_name": "pt", "plain_label": "Offered to part-time employees", "data_type": "boolean", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Is benefit offered to part time employees?" }, { "resource": "Medical/Rx Plans", "endpoint": "POST /plans/medical/", "section": "", "api_field_name": "funding", "plain_label": "Funding type", "data_type": "string", "required": "REQUIRED", "allowed_values": "FUNDING_FULLY | FUNDING_LEVEL | FUNDING_SELF", "constraints": "", "default": "", "description": "Used to differentiate plans within the benefit class based on how employer shares risk with carrier." }, { "resource": "Medical/Rx Plans", "endpoint": "POST /plans/medical/", "section": "", "api_field_name": "t1_ee", "plain_label": "Tier 1 employee contribution (PEPY)", "data_type": "integer", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Amount paid by a single (tier 1) employee per year (PEPY) to cover their portion of the cost of the plan." }, { "resource": "Medical/Rx Plans", "endpoint": "POST /plans/medical/", "section": "", "api_field_name": "t2_ee", "plain_label": "Tier 2 employee contribution (PEPY)", "data_type": "integer", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Amount paid by an employee + spouse (tier 2) employee per year (PEPY) to cover their portion of the cost of the plan. If 2 tier rate structure, use the 'Family' rate. If it's 3 tiers, use the 'Employee + 1' rate." }, { "resource": "Medical/Rx Plans", "endpoint": "POST /plans/medical/", "section": "", "api_field_name": "t3_ee", "plain_label": "Tier 3 employee contribution (PEPY)", "data_type": "integer", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Amount paid by an employee + children (tier 3) employee per year (PEPY) to cover their portion of the cost of the plan. If 2 tier rate structure, use the 'Family' rate. If it's 3 tiers, use either, the 'Employee + 1' or 'Family' rate. If 5 tiers, use mean of the 3rd and 4th tier." }, { "resource": "Medical/Rx Plans", "endpoint": "POST /plans/medical/", "section": "", "api_field_name": "t4_ee", "plain_label": "Tier 4 employee contribution (PEPY)", "data_type": "integer", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Amount paid by an employee + family (tier 4) employee per year (PEPY) to cover their portion of the cost of the plan." }, { "resource": "Medical/Rx Plans", "endpoint": "POST /plans/medical/", "section": "", "api_field_name": "t1_gross", "plain_label": "Tier 1 total cost (PEPY)", "data_type": "integer", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Full amount paid by the employer (before EE contributions) to cover a single (tier 1) employee per year (PEPY)." }, { "resource": "Medical/Rx Plans", "endpoint": "POST /plans/medical/", "section": "", "api_field_name": "t2_gross", "plain_label": "Tier 2 total cost (PEPY)", "data_type": "integer", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Full amount paid by the employer (before EE contributions) to cover an employee + spouse (tier 2) employee per year (PEPY). If 2 tier rate structure, use the 'Family' rate. If it's 3 tiers, use the 'Employee + 1' rate." }, { "resource": "Medical/Rx Plans", "endpoint": "POST /plans/medical/", "section": "", "api_field_name": "t3_gross", "plain_label": "Tier 3 total cost (PEPY)", "data_type": "integer", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Full amount paid by the employer (before EE contributions) to cover an employee + children (tier 3) employee per year (PEPY). If 2 tier rate structure, use the 'Family' rate. If it's 3 tiers, use either, the 'Employee + 1' or 'Family' rate. If 5 tiers, use mean of the 3rd and 4th tier." }, { "resource": "Medical/Rx Plans", "endpoint": "POST /plans/medical/", "section": "", "api_field_name": "t4_gross", "plain_label": "Tier 4 total cost (PEPY)", "data_type": "integer", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Full amount paid by the employer (before EE contributions) to cover an employee + family (tier 4) employee per year (PEPY)." }, { "resource": "Medical/Rx Plans", "endpoint": "POST /plans/medical/", "section": "", "api_field_name": "type", "plain_label": "Plan type", "data_type": "string", "required": "REQUIRED", "allowed_values": "PPO | POS | EPO | HMO | HDHP", "constraints": "", "default": "", "description": "Used to differentiate plans within the benefit class based on how benefits are paid." }, { "resource": "Medical/Rx Plans", "endpoint": "POST /plans/medical/", "section": "", "api_field_name": "in_ded_single", "plain_label": "In-network deductible (single)", "data_type": "integer", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "The dollar amount of eligible expenses a covered single tier employee must pay each year out of pocket before the plan will make payment for eligible benefits in-network." }, { "resource": "Medical/Rx Plans", "endpoint": "POST /plans/medical/", "section": "", "api_field_name": "in_ded_family", "plain_label": "In-network deductible (family)", "data_type": "integer", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "The dollar amount of eligible expenses a covered family tier employee must pay each year out of pocket before the plan will make payment for eligible benefits in-network." }, { "resource": "Medical/Rx Plans", "endpoint": "POST /plans/medical/", "section": "", "api_field_name": "in_max_single", "plain_label": "In-network max out-of-pocket (single)", "data_type": "integer", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "The maximum dollar amount a single tier employee will pay toward in-network expenses within a calendar year. It includes the deductible, coinsurance and copays." }, { "resource": "Medical/Rx Plans", "endpoint": "POST /plans/medical/", "section": "", "api_field_name": "in_max_family", "plain_label": "In-network max out-of-pocket (family)", "data_type": "integer", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "The maximum dollar amount a family tier employee will pay toward in-network expenses within a calendar year. It includes the deductible, coinsurance and copays." }, { "resource": "Medical/Rx Plans", "endpoint": "POST /plans/medical/", "section": "", "api_field_name": "in_coin", "plain_label": "In-network coinsurance", "data_type": "integer", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "The percentage amount that the employee is expected to cover for in-network services." }, { "resource": "Medical/Rx Plans", "endpoint": "POST /plans/medical/", "section": "", "api_field_name": "out_ded_single", "plain_label": "Out-of-network deductible (single)", "data_type": "integer", "required": "OPTIONAL", "allowed_values": "", "constraints": "", "default": "", "description": "The dollar amount of eligible expenses a covered single tier employee must pay each year out of pocket before the plan will make payment for eligible benefits out-of-network." }, { "resource": "Medical/Rx Plans", "endpoint": "POST /plans/medical/", "section": "", "api_field_name": "out_ded_family", "plain_label": "Out-of-network deductible (family)", "data_type": "integer", "required": "OPTIONAL", "allowed_values": "", "constraints": "", "default": "", "description": "The dollar amount of eligible expenses a covered family tier employee must pay each year out of pocket before the plan will make payment for eligible benefits out-of-network." }, { "resource": "Medical/Rx Plans", "endpoint": "POST /plans/medical/", "section": "", "api_field_name": "out_max_single", "plain_label": "Out-of-network max out-of-pocket (single)", "data_type": "integer", "required": "OPTIONAL", "allowed_values": "", "constraints": "", "default": "", "description": "The maximum dollar amount a single tier employee will pay toward out-of-network expenses within a calendar year. It includes the deductible, coinsurance and copays." }, { "resource": "Medical/Rx Plans", "endpoint": "POST /plans/medical/", "section": "", "api_field_name": "out_max_family", "plain_label": "Out-of-network max out-of-pocket (family)", "data_type": "integer", "required": "OPTIONAL", "allowed_values": "", "constraints": "", "default": "", "description": "The maximum dollar amount a family tier employee will pay toward out-of-network expenses within a calendar year. It includes the deductible, coinsurance and copays." }, { "resource": "Medical/Rx Plans", "endpoint": "POST /plans/medical/", "section": "", "api_field_name": "out_coin", "plain_label": "Out-of-network coinsurance", "data_type": "integer", "required": "OPTIONAL", "allowed_values": "", "constraints": "", "default": "", "description": "The percentage amount that the employee is expected to cover for out-of-network services." }, { "resource": "Medical/Rx Plans", "endpoint": "POST /plans/medical/", "section": "", "api_field_name": "rx_ded_single", "plain_label": "Rx deductible (single, if separate)", "data_type": "integer", "required": "OPTIONAL", "allowed_values": "", "constraints": "", "default": "", "description": "Only provide a value here if Rx has a seperate single deductible from Medical; otherwise, set to null." }, { "resource": "Medical/Rx Plans", "endpoint": "POST /plans/medical/", "section": "", "api_field_name": "rx_ded_family", "plain_label": "Rx deductible (family, if separate)", "data_type": "integer", "required": "OPTIONAL", "allowed_values": "", "constraints": "", "default": "", "description": "Only provide a value here if Rx has a seperate family deductible from Medical; otherwise, set to null." }, { "resource": "Medical/Rx Plans", "endpoint": "POST /plans/medical/", "section": "", "api_field_name": "rx_max_single", "plain_label": "Rx max out-of-pocket (single, if separate)", "data_type": "integer", "required": "OPTIONAL", "allowed_values": "", "constraints": "", "default": "", "description": "Only provide a value here if Rx has a seperate single Max OOP from Medical; otherwise, set to null." }, { "resource": "Medical/Rx Plans", "endpoint": "POST /plans/medical/", "section": "", "api_field_name": "rx_max_family", "plain_label": "Rx max out-of-pocket (family, if separate)", "data_type": "integer", "required": "OPTIONAL", "allowed_values": "", "constraints": "", "default": "", "description": "Only provide a value here if Rx has a seperate family Max OOP from Medical; otherwise, set to null." }, { "resource": "Medical/Rx Plans", "endpoint": "POST /plans/medical/", "section": "", "api_field_name": "rx_coin", "plain_label": "Rx coinsurance", "data_type": "integer", "required": "OPTIONAL", "allowed_values": "", "constraints": "", "default": "", "description": "The percentage amount that the employee is expected to cover for out-of-network services." }, { "resource": "Medical/Rx Plans", "endpoint": "POST /plans/medical/", "section": "", "api_field_name": "pcp_ded_apply", "plain_label": "Primary care: deductible/coinsurance applies", "data_type": "string", "required": "REQUIRED", "allowed_values": "FALSE | FALSE_COIN | TRUE | TRUE_COIN", "constraints": "", "default": "", "description": "Does the deductible and/or coinsurance apply to Primary Care Physician visits?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, { "resource": "Medical/Rx Plans", "endpoint": "POST /plans/medical/", "section": "", "api_field_name": "sp_ded_apply", "plain_label": "Specialist: deductible/coinsurance applies", "data_type": "string", "required": "REQUIRED", "allowed_values": "FALSE | FALSE_COIN | TRUE | TRUE_COIN", "constraints": "", "default": "", "description": "Does the deductible and/or coinsurance apply to Specialist Physician visits?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, { "resource": "Medical/Rx Plans", "endpoint": "POST /plans/medical/", "section": "", "api_field_name": "er_ded_apply", "plain_label": "Emergency room: deductible/coinsurance applies", "data_type": "string", "required": "REQUIRED", "allowed_values": "FALSE | FALSE_COIN | TRUE | TRUE_COIN", "constraints": "", "default": "", "description": "Does the deductible and/or coinsurance apply to Emergency Room visits?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, { "resource": "Medical/Rx Plans", "endpoint": "POST /plans/medical/", "section": "", "api_field_name": "uc_ded_apply", "plain_label": "Urgent care: deductible/coinsurance applies", "data_type": "string", "required": "REQUIRED", "allowed_values": "FALSE | FALSE_COIN | TRUE | TRUE_COIN", "constraints": "", "default": "", "description": "Does the deductible and/or coinsurance apply to Urgent Care visits?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, { "resource": "Medical/Rx Plans", "endpoint": "POST /plans/medical/", "section": "", "api_field_name": "lx_ded_apply", "plain_label": "Lab & X-ray: deductible/coinsurance applies", "data_type": "string", "required": "REQUIRED", "allowed_values": "FALSE | FALSE_COIN | TRUE | TRUE_COIN", "constraints": "", "default": "", "description": "Does the deductible and/or coinsurance apply to Basic Lab and Xray services?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, { "resource": "Medical/Rx Plans", "endpoint": "POST /plans/medical/", "section": "", "api_field_name": "ip_ded_apply", "plain_label": "Inpatient: deductible/coinsurance applies", "data_type": "string", "required": "REQUIRED", "allowed_values": "FALSE | FALSE_COIN | TRUE | TRUE_COIN", "constraints": "", "default": "", "description": "Does the deductible and/or coinsurance apply to Inpatient Visits?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, { "resource": "Medical/Rx Plans", "endpoint": "POST /plans/medical/", "section": "", "api_field_name": "op_ded_apply", "plain_label": "Outpatient: deductible/coinsurance applies", "data_type": "string", "required": "REQUIRED", "allowed_values": "FALSE | FALSE_COIN | TRUE | TRUE_COIN", "constraints": "", "default": "", "description": "Does the deductible and/or coinsurance apply to Outpatient Visits?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, { "resource": "Medical/Rx Plans", "endpoint": "POST /plans/medical/", "section": "", "api_field_name": "rx1_ded_apply", "plain_label": "Rx tier 1 (generic): deductible/coinsurance applies", "data_type": "string", "required": "REQUIRED", "allowed_values": "FALSE | FALSE_COIN | TRUE | TRUE_COIN", "constraints": "", "default": "", "description": "Does the deductible and/or coinsurance apply to Tier 1 Generic Rx (retail 30 days)?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, { "resource": "Medical/Rx Plans", "endpoint": "POST /plans/medical/", "section": "", "api_field_name": "rx2_ded_apply", "plain_label": "Rx tier 2 (preferred brand): deductible/coinsurance applies", "data_type": "string", "required": "REQUIRED", "allowed_values": "FALSE | FALSE_COIN | TRUE | TRUE_COIN", "constraints": "", "default": "", "description": "Does the deductible and/or coinsurance apply to Tier 2 Preferred Brand Rx (retail 30 days)?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, { "resource": "Medical/Rx Plans", "endpoint": "POST /plans/medical/", "section": "", "api_field_name": "rx3_ded_apply", "plain_label": "Rx tier 3 (non-preferred brand): deductible/coinsurance applies", "data_type": "string", "required": "OPTIONAL", "allowed_values": "FALSE | FALSE_COIN | TRUE | TRUE_COIN", "constraints": "", "default": "", "description": "Does the deductible and/or coinsurance apply to Tier 3 Non-Preferred Brand Rx (retail 30 days)?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, { "resource": "Medical/Rx Plans", "endpoint": "POST /plans/medical/", "section": "", "api_field_name": "rx4_ded_apply", "plain_label": "Rx tier 4 (specialty): deductible/coinsurance applies", "data_type": "string", "required": "OPTIONAL", "allowed_values": "FALSE | FALSE_COIN | TRUE | TRUE_COIN", "constraints": "", "default": "", "description": "Does the deductible and/or coinsurance apply to Tier 4 Specialty Rx (retail 30 days)?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, { "resource": "Medical/Rx Plans", "endpoint": "POST /plans/medical/", "section": "", "api_field_name": "rx1_mail_ded_apply", "plain_label": "Rx tier 1 mail order: deductible/coinsurance applies", "data_type": "string", "required": "OPTIONAL", "allowed_values": "FALSE | FALSE_COIN | TRUE | TRUE_COIN", "constraints": "", "default": "", "description": "Does the deductible and/or coinsurance apply to Tier 1 Generic Rx (mail order 90 days)?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, { "resource": "Medical/Rx Plans", "endpoint": "POST /plans/medical/", "section": "", "api_field_name": "rx2_mail_ded_apply", "plain_label": "Rx tier 2 mail order: deductible/coinsurance applies", "data_type": "string", "required": "OPTIONAL", "allowed_values": "FALSE | FALSE_COIN | TRUE | TRUE_COIN", "constraints": "", "default": "", "description": "Does the deductible and/or coinsurance apply to Tier 2 Preferred Brand Rx (mail order 90 days)?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, { "resource": "Medical/Rx Plans", "endpoint": "POST /plans/medical/", "section": "", "api_field_name": "rx3_mail_ded_apply", "plain_label": "Rx tier 3 mail order: deductible/coinsurance applies", "data_type": "string", "required": "OPTIONAL", "allowed_values": "FALSE | FALSE_COIN | TRUE | TRUE_COIN", "constraints": "", "default": "", "description": "Does the deductible and/or coinsurance apply to Tier 3 Non-Preferred Brand Rx (mail order 90 days)?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, { "resource": "Medical/Rx Plans", "endpoint": "POST /plans/medical/", "section": "", "api_field_name": "rx4_mail_ded_apply", "plain_label": "Rx tier 4 mail order: deductible/coinsurance applies", "data_type": "string", "required": "OPTIONAL", "allowed_values": "FALSE | FALSE_COIN | TRUE | TRUE_COIN", "constraints": "", "default": "", "description": "Does the deductible and/or coinsurance apply to Tier 4 Specialty Rx (mail order 90 days)?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, { "resource": "Medical/Rx Plans", "endpoint": "POST /plans/medical/", "section": "", "api_field_name": "pcp_copay", "plain_label": "Primary care copay", "data_type": "integer", "required": "OPTIONAL", "allowed_values": "", "constraints": "", "default": "", "description": "Single payment that applies to Primary Care Physician visits in-network. Only provide a value if a copay is required." }, { "resource": "Medical/Rx Plans", "endpoint": "POST /plans/medical/", "section": "", "api_field_name": "sp_copay", "plain_label": "Specialist copay", "data_type": "integer", "required": "OPTIONAL", "allowed_values": "", "constraints": "", "default": "", "description": "Single payment that applies to Specialist Physician visits in-network. Only provide a value if a copay is required." }, { "resource": "Medical/Rx Plans", "endpoint": "POST /plans/medical/", "section": "", "api_field_name": "er_copay", "plain_label": "Emergency room copay", "data_type": "integer", "required": "OPTIONAL", "allowed_values": "", "constraints": "", "default": "", "description": "Single payment that applies to Emergency Room visits in-network. Only provide a value if a copay is required." }, { "resource": "Medical/Rx Plans", "endpoint": "POST /plans/medical/", "section": "", "api_field_name": "uc_copay", "plain_label": "Urgent care copay", "data_type": "integer", "required": "OPTIONAL", "allowed_values": "", "constraints": "", "default": "", "description": "Single payment that applies to Urgent Care visits in-network. Only provide a value if a copay is required." }, { "resource": "Medical/Rx Plans", "endpoint": "POST /plans/medical/", "section": "", "api_field_name": "lx_copay", "plain_label": "Lab & X-ray copay", "data_type": "integer", "required": "OPTIONAL", "allowed_values": "", "constraints": "", "default": "", "description": "Single payment that applies to Basic Lab & X-ray services in-network. Only provide a value if a copay is required." }, { "resource": "Medical/Rx Plans", "endpoint": "POST /plans/medical/", "section": "", "api_field_name": "ip_copay", "plain_label": "Inpatient copay", "data_type": "integer", "required": "OPTIONAL", "allowed_values": "", "constraints": "", "default": "", "description": "Single payment that applies to Inpatient Hospital visits in-network. Only provide a value if a copay is required." }, { "resource": "Medical/Rx Plans", "endpoint": "POST /plans/medical/", "section": "", "api_field_name": "op_copay", "plain_label": "Outpatient copay", "data_type": "integer", "required": "OPTIONAL", "allowed_values": "", "constraints": "", "default": "", "description": "Single payment that applies to Outpatient Hospital visits in-network. Only provide a value if a copay is required." }, { "resource": "Medical/Rx Plans", "endpoint": "POST /plans/medical/", "section": "", "api_field_name": "rx1_copay", "plain_label": "Rx tier 1 (generic) copay", "data_type": "integer", "required": "OPTIONAL", "allowed_values": "", "constraints": "", "default": "", "description": "Single payment that applies to Tier 1 Generic Rx (retail 30 days) in-network. Only provide a value if a copay is required." }, { "resource": "Medical/Rx Plans", "endpoint": "POST /plans/medical/", "section": "", "api_field_name": "rx2_copay", "plain_label": "Rx tier 2 (preferred brand) copay", "data_type": "integer", "required": "OPTIONAL", "allowed_values": "", "constraints": "", "default": "", "description": "Single payment that applies to Tier 2 Preferred Brand Rx (retail 30 days) in-network. Only provide a value if a copay is required." }, { "resource": "Medical/Rx Plans", "endpoint": "POST /plans/medical/", "section": "", "api_field_name": "rx3_copay", "plain_label": "Rx tier 3 (non-preferred brand) copay", "data_type": "integer", "required": "OPTIONAL", "allowed_values": "", "constraints": "", "default": "", "description": "Single payment that applies to Tier 3 Non-Preferred Brand Rx (retail 30 days) in-network. Only provide a value if a copay is required." }, { "resource": "Medical/Rx Plans", "endpoint": "POST /plans/medical/", "section": "", "api_field_name": "rx4_copay", "plain_label": "Rx tier 4 (specialty) copay", "data_type": "integer", "required": "OPTIONAL", "allowed_values": "", "constraints": "", "default": "", "description": "Single payment that applies to Tier 4 Specialty Rx (retail 30 days) in-network. Only provide a value if a copay is required." }, { "resource": "Medical/Rx Plans", "endpoint": "POST /plans/medical/", "section": "", "api_field_name": "rx1_mail_copay", "plain_label": "Rx tier 1 mail-order copay", "data_type": "integer", "required": "OPTIONAL", "allowed_values": "", "constraints": "", "default": "", "description": "Single payment that applies to Tier 1 Generic Rx (mail order 90 days) in-network. Only provide a value if a copay is required." }, { "resource": "Medical/Rx Plans", "endpoint": "POST /plans/medical/", "section": "", "api_field_name": "rx2_mail_copay", "plain_label": "Rx tier 2 mail-order copay", "data_type": "integer", "required": "OPTIONAL", "allowed_values": "", "constraints": "", "default": "", "description": "Single payment that applies to Tier 2 Preferred Brand Rx (mail order 90 days) in-network. Only provide a value if a copay is required." }, { "resource": "Medical/Rx Plans", "endpoint": "POST /plans/medical/", "section": "", "api_field_name": "rx3_mail_copay", "plain_label": "Rx tier 3 mail-order copay", "data_type": "integer", "required": "OPTIONAL", "allowed_values": "", "constraints": "", "default": "", "description": "Single payment that applies to Tier 3 Non-Preferred Brand Rx (mail order 90 days) in-network. Only provide a value if a copay is required." }, { "resource": "Medical/Rx Plans", "endpoint": "POST /plans/medical/", "section": "", "api_field_name": "rx4_mail_copay", "plain_label": "Rx tier 4 mail-order copay", "data_type": "integer", "required": "OPTIONAL", "allowed_values": "", "constraints": "", "default": "", "description": "Single payment that applies to Tier 4 Specialty Rx (mail order 90 days) in-network. Only provide a value if a copay is required." }, { "resource": "Medical/Rx Plans", "endpoint": "POST /plans/medical/", "section": "", "api_field_name": "hra", "plain_label": "HRA offered", "data_type": "boolean", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Is an HRA offered with the Medical/Rx plan?" }, { "resource": "Medical/Rx Plans", "endpoint": "POST /plans/medical/", "section": "", "api_field_name": "hsa", "plain_label": "HSA offered", "data_type": "boolean", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Is an HSA offered with the Medical/Rx plan?" }, { "resource": "Medical/Rx Plans", "endpoint": "POST /plans/medical/", "section": "", "api_field_name": "fsa", "plain_label": "FSA offered", "data_type": "boolean", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Is an FSA offered with the Medical/Rx plan?" }, { "resource": "Medical/Rx Plans", "endpoint": "POST /plans/medical/", "section": "", "api_field_name": "age_rated", "plain_label": "Age-rated premiums", "data_type": "boolean", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Are the premium rates based 100% on age-banded or community ratings?" }, { "resource": "Medical/Rx Plans", "endpoint": "POST /plans/medical/", "section": "", "api_field_name": "salary_banding", "plain_label": "Salary-banded contributions", "data_type": "boolean", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Do the employee contributions vary based on employee salary?" }, { "resource": "Medical/Rx Plans", "endpoint": "POST /plans/medical/", "section": "", "api_field_name": "tobacco_surcharge", "plain_label": "Tobacco surcharge (PEPY)", "data_type": "integer", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Additional amount employees are required to pay annually (PEPY) based on tested or self-reported tobacco use. If not required, set to null." }, { "resource": "Medical/Rx Plans", "endpoint": "POST /plans/medical/", "section": "", "api_field_name": "spousal_surcharge", "plain_label": "Spousal surcharge (PEPY)", "data_type": "integer", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Additional amount employees are required to pay annually (PEPY) based on whether spouse is working/retired and is eligible for medical coverage through their employer/former employer. If not required, set to null." }, { "resource": "Medical/Rx Plans", "endpoint": "POST /plans/medical/", "section": "", "api_field_name": "t1_ercdhp", "plain_label": "Tier 1 employer HSA/CDHP funding", "data_type": "integer", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "The amount funded to single tier employees' HSA account each year by the employer" }, { "resource": "Medical/Rx Plans", "endpoint": "POST /plans/medical/", "section": "", "api_field_name": "t2_ercdhp", "plain_label": "Tier 2 employer HSA/CDHP funding", "data_type": "integer", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "The amount funded to employee + spouse tier employees' HSA account each year by the employer" }, { "resource": "Medical/Rx Plans", "endpoint": "POST /plans/medical/", "section": "", "api_field_name": "t3_ercdhp", "plain_label": "Tier 3 employer HSA/CDHP funding", "data_type": "integer", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "The amount funded to employee + children tier employees' HSA account each year by the employer" }, { "resource": "Medical/Rx Plans", "endpoint": "POST /plans/medical/", "section": "", "api_field_name": "t4_ercdhp", "plain_label": "Tier 4 employer HSA/CDHP funding", "data_type": "integer", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "The amount funded to employee + family tier employees' HSA account each year by the employer" }, { "resource": "Dental Plans", "endpoint": "POST /plans/dental/", "section": "", "api_field_name": "employer", "plain_label": "Employer ID", "data_type": "string", "required": "REQUIRED", "allowed_values": "", "constraints": "format: uuid", "default": "", "description": "ID of employer that offers plan." }, { "resource": "Dental Plans", "endpoint": "POST /plans/dental/", "section": "", "api_field_name": "title", "plain_label": "Plan title", "data_type": "string", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Unique plan title to identify and differentiate. Can match title provided by insurer." }, { "resource": "Dental Plans", "endpoint": "POST /plans/dental/", "section": "", "api_field_name": "carrier", "plain_label": "Carrier / ASO provider", "data_type": "string", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Name of insurance company for fully-insured plans and ASO provider for self-insured plans." }, { "resource": "Dental Plans", "endpoint": "POST /plans/dental/", "section": "", "api_field_name": "start_date", "plain_label": "Plan start date", "data_type": "string", "required": "REQUIRED", "allowed_values": "", "constraints": "format: date", "default": "", "description": "Formated YYYY-MM-DD." }, { "resource": "Dental Plans", "endpoint": "POST /plans/dental/", "section": "", "api_field_name": "end_date", "plain_label": "Plan end date", "data_type": "string", "required": "REQUIRED", "allowed_values": "", "constraints": "format: date", "default": "", "description": "Formated YYYY-MM-DD." }, { "resource": "Dental Plans", "endpoint": "POST /plans/dental/", "section": "", "api_field_name": "from_plan", "plain_label": "Prior-year plan ID", "data_type": "string", "required": "OPTIONAL", "allowed_values": "", "constraints": "format: uuid", "default": "", "description": "ID of prior year plan from which current plan is renewed or converted." }, { "resource": "Dental Plans", "endpoint": "POST /plans/dental/", "section": "", "api_field_name": "from_action", "plain_label": "Prior-year relationship", "data_type": "string", "required": "OPTIONAL", "allowed_values": "RENEWED | CONVERTED", "constraints": "", "default": "", "description": "Prior year plan is renewed if with the same carrier or converted if moved to a different carrier." }, { "resource": "Dental Plans", "endpoint": "POST /plans/dental/", "section": "", "api_field_name": "pt", "plain_label": "Offered to part-time employees", "data_type": "boolean", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Is benefit offered to part time employees?" }, { "resource": "Dental Plans", "endpoint": "POST /plans/dental/", "section": "", "api_field_name": "funding", "plain_label": "Funding type", "data_type": "string", "required": "REQUIRED", "allowed_values": "FUNDING_FULLY | FUNDING_LEVEL | FUNDING_SELF", "constraints": "", "default": "", "description": "Used to differentiate plans within the benefit class based on how employer shares risk with carrier." }, { "resource": "Dental Plans", "endpoint": "POST /plans/dental/", "section": "", "api_field_name": "t1_ee", "plain_label": "Tier 1 employee contribution (PEPY)", "data_type": "integer", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Amount paid by a single (tier 1) employee per year (PEPY) to cover their portion of the cost of the plan." }, { "resource": "Dental Plans", "endpoint": "POST /plans/dental/", "section": "", "api_field_name": "t2_ee", "plain_label": "Tier 2 employee contribution (PEPY)", "data_type": "integer", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Amount paid by an employee + spouse (tier 2) employee per year (PEPY) to cover their portion of the cost of the plan. If 2 tier rate structure, use the 'Family' rate. If it's 3 tiers, use the 'Employee + 1' rate." }, { "resource": "Dental Plans", "endpoint": "POST /plans/dental/", "section": "", "api_field_name": "t3_ee", "plain_label": "Tier 3 employee contribution (PEPY)", "data_type": "integer", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Amount paid by an employee + children (tier 3) employee per year (PEPY) to cover their portion of the cost of the plan. If 2 tier rate structure, use the 'Family' rate. If it's 3 tiers, use either, the 'Employee + 1' or 'Family' rate. If 5 tiers, use mean of the 3rd and 4th tier." }, { "resource": "Dental Plans", "endpoint": "POST /plans/dental/", "section": "", "api_field_name": "t4_ee", "plain_label": "Tier 4 employee contribution (PEPY)", "data_type": "integer", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Amount paid by an employee + family (tier 4) employee per year (PEPY) to cover their portion of the cost of the plan." }, { "resource": "Dental Plans", "endpoint": "POST /plans/dental/", "section": "", "api_field_name": "t1_gross", "plain_label": "Tier 1 total cost (PEPY)", "data_type": "integer", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Full amount paid by the employer (before EE contributions) to cover a single (tier 1) employee per year (PEPY)." }, { "resource": "Dental Plans", "endpoint": "POST /plans/dental/", "section": "", "api_field_name": "t2_gross", "plain_label": "Tier 2 total cost (PEPY)", "data_type": "integer", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Full amount paid by the employer (before EE contributions) to cover an employee + spouse (tier 2) employee per year (PEPY). If 2 tier rate structure, use the 'Family' rate. If it's 3 tiers, use the 'Employee + 1' rate." }, { "resource": "Dental Plans", "endpoint": "POST /plans/dental/", "section": "", "api_field_name": "t3_gross", "plain_label": "Tier 3 total cost (PEPY)", "data_type": "integer", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Full amount paid by the employer (before EE contributions) to cover an employee + children (tier 3) employee per year (PEPY). If 2 tier rate structure, use the 'Family' rate. If it's 3 tiers, use either, the 'Employee + 1' or 'Family' rate. If 5 tiers, use mean of the 3rd and 4th tier." }, { "resource": "Dental Plans", "endpoint": "POST /plans/dental/", "section": "", "api_field_name": "t4_gross", "plain_label": "Tier 4 total cost (PEPY)", "data_type": "integer", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Full amount paid by the employer (before EE contributions) to cover an employee + family (tier 4) employee per year (PEPY)." }, { "resource": "Dental Plans", "endpoint": "POST /plans/dental/", "section": "", "api_field_name": "type", "plain_label": "Plan type", "data_type": "string", "required": "REQUIRED", "allowed_values": "DPPO | DMO", "constraints": "", "default": "", "description": "Used to differentiate plans within the benefit class based on how benefits are paid." }, { "resource": "Dental Plans", "endpoint": "POST /plans/dental/", "section": "", "api_field_name": "in_ded_single", "plain_label": "In-network deductible (single)", "data_type": "integer", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "The dollar amount of eligible expenses a covered single tier employee must pay each year out of pocket before the plan will make payment for eligible benefits in-network." }, { "resource": "Dental Plans", "endpoint": "POST /plans/dental/", "section": "", "api_field_name": "in_ded_family", "plain_label": "In-network deductible (family)", "data_type": "integer", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "The dollar amount of eligible expenses a covered family tier employee must pay each year out of pocket before the plan will make payment for eligible benefits in-network." }, { "resource": "Dental Plans", "endpoint": "POST /plans/dental/", "section": "", "api_field_name": "in_max", "plain_label": "In-network annual maximum", "data_type": "integer", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "The maximum dollar amount the plan will pay per member toward the in-network cost of dental care within a calendar year." }, { "resource": "Dental Plans", "endpoint": "POST /plans/dental/", "section": "", "api_field_name": "in_max_ortho", "plain_label": "In-network orthodontia maximum", "data_type": "integer", "required": "OPTIONAL", "allowed_values": "", "constraints": "", "default": "", "description": "The maximum dollar amount the plan will pay per member toward the in-network cost of orthodontia care in the member's lifetime." }, { "resource": "Dental Plans", "endpoint": "POST /plans/dental/", "section": "", "api_field_name": "out_ded_single", "plain_label": "Out-of-network deductible (single)", "data_type": "integer", "required": "OPTIONAL", "allowed_values": "", "constraints": "", "default": "", "description": "The dollar amount of eligible expenses a covered single tier employee must pay each year out of pocket before the plan will make payment for eligible benefits out-of-network. Required if type is set to 'DPPO'." }, { "resource": "Dental Plans", "endpoint": "POST /plans/dental/", "section": "", "api_field_name": "out_ded_family", "plain_label": "Out-of-network deductible (family)", "data_type": "integer", "required": "OPTIONAL", "allowed_values": "", "constraints": "", "default": "", "description": "The dollar amount of eligible expenses a covered family tier employee must pay each year out of pocket before the plan will make payment for eligible benefits out-of-network. Required if type is set to 'DPPO'." }, { "resource": "Dental Plans", "endpoint": "POST /plans/dental/", "section": "", "api_field_name": "out_max", "plain_label": "Out-of-network annual maximum", "data_type": "integer", "required": "OPTIONAL", "allowed_values": "", "constraints": "", "default": "", "description": "The maximum dollar amount the plan will pay per member toward the out-of-network cost of dental care within a calendar year. Required if type is set to 'DPPO'." }, { "resource": "Dental Plans", "endpoint": "POST /plans/dental/", "section": "", "api_field_name": "out_max_ortho", "plain_label": "Out-of-network orthodontia maximum", "data_type": "integer", "required": "OPTIONAL", "allowed_values": "", "constraints": "", "default": "", "description": "The maximum dollar amount the plan will pay per member toward the out-of-network cost of orthodontia care in the member's lifetime." }, { "resource": "Dental Plans", "endpoint": "POST /plans/dental/", "section": "", "api_field_name": "prev_ded_apply", "plain_label": "Deductible applies to preventive care", "data_type": "boolean", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Does the deductible apply to preventive care?" }, { "resource": "Dental Plans", "endpoint": "POST /plans/dental/", "section": "", "api_field_name": "basic_ded_apply", "plain_label": "Deductible applies to basic care", "data_type": "boolean", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Does the deductible apply to basic care?" }, { "resource": "Dental Plans", "endpoint": "POST /plans/dental/", "section": "", "api_field_name": "major_ded_apply", "plain_label": "Deductible applies to major care", "data_type": "boolean", "required": "OPTIONAL", "allowed_values": "", "constraints": "", "default": "", "description": "Does the deductible apply to major care? If major care is not covered, set to null." }, { "resource": "Dental Plans", "endpoint": "POST /plans/dental/", "section": "", "api_field_name": "ortho_ded_apply", "plain_label": "Deductible applies to orthodontia", "data_type": "boolean", "required": "OPTIONAL", "allowed_values": "", "constraints": "", "default": "", "description": "Does the deductible apply to orthodontia care? If orthodontia care is not covered, set to null." }, { "resource": "Dental Plans", "endpoint": "POST /plans/dental/", "section": "", "api_field_name": "in_prev_coin", "plain_label": "In-network preventive coinsurance", "data_type": "integer", "required": "OPTIONAL", "allowed_values": "", "constraints": "", "default": "", "description": "The percentage amount that the employee is expected to cover for in-network preventive care. If the service is copay-based, set to null." }, { "resource": "Dental Plans", "endpoint": "POST /plans/dental/", "section": "", "api_field_name": "in_basic_coin", "plain_label": "In-network basic coinsurance", "data_type": "integer", "required": "OPTIONAL", "allowed_values": "", "constraints": "", "default": "", "description": "The percentage amount that the employee is expected to cover for in-network basic care. If the service is copay-based, set to null." }, { "resource": "Dental Plans", "endpoint": "POST /plans/dental/", "section": "", "api_field_name": "in_major_coin", "plain_label": "In-network major coinsurance", "data_type": "integer", "required": "OPTIONAL", "allowed_values": "", "constraints": "", "default": "", "description": "The percentage amount that the employee is expected to cover for in-network major care. If the service is copay-based, set to null." }, { "resource": "Dental Plans", "endpoint": "POST /plans/dental/", "section": "", "api_field_name": "in_ortho_coin", "plain_label": "In-network orthodontia coinsurance", "data_type": "integer", "required": "OPTIONAL", "allowed_values": "", "constraints": "", "default": "", "description": "The percentage amount that the employee is expected to cover for in-network orthodontia care. If the service is copay-based, set to null." }, { "resource": "Dental Plans", "endpoint": "POST /plans/dental/", "section": "", "api_field_name": "out_prev_coin", "plain_label": "Out-of-network preventive coinsurance", "data_type": "integer", "required": "OPTIONAL", "allowed_values": "", "constraints": "", "default": "", "description": "The percentage amount that the employee is expected to cover for out-of-network preventive care. If the service is copay-based, set to null." }, { "resource": "Dental Plans", "endpoint": "POST /plans/dental/", "section": "", "api_field_name": "out_basic_coin", "plain_label": "Out-of-network basic coinsurance", "data_type": "integer", "required": "OPTIONAL", "allowed_values": "", "constraints": "", "default": "", "description": "The percentage amount that the employee is expected to cover for out-of-network basic care. If the service is copay-based, set to null." }, { "resource": "Dental Plans", "endpoint": "POST /plans/dental/", "section": "", "api_field_name": "out_major_coin", "plain_label": "Out-of-network major coinsurance", "data_type": "integer", "required": "OPTIONAL", "allowed_values": "", "constraints": "", "default": "", "description": "The percentage amount that the employee is expected to cover for out-of-network major care. If the service is copay-based, set to null." }, { "resource": "Dental Plans", "endpoint": "POST /plans/dental/", "section": "", "api_field_name": "out_ortho_coin", "plain_label": "Out-of-network orthodontia coinsurance", "data_type": "integer", "required": "OPTIONAL", "allowed_values": "", "constraints": "", "default": "", "description": "The percentage amount that the employee is expected to cover for out-of-network orthodontia care. If the service is copay-based, set to null." }, { "resource": "Vision Plans", "endpoint": "POST /plans/vision/", "section": "", "api_field_name": "employer", "plain_label": "Employer ID", "data_type": "string", "required": "REQUIRED", "allowed_values": "", "constraints": "format: uuid", "default": "", "description": "ID of employer that offers plan." }, { "resource": "Vision Plans", "endpoint": "POST /plans/vision/", "section": "", "api_field_name": "title", "plain_label": "Plan title", "data_type": "string", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Unique plan title to identify and differentiate. Can match title provided by insurer." }, { "resource": "Vision Plans", "endpoint": "POST /plans/vision/", "section": "", "api_field_name": "carrier", "plain_label": "Carrier / ASO provider", "data_type": "string", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Name of insurance company for fully-insured plans and ASO provider for self-insured plans." }, { "resource": "Vision Plans", "endpoint": "POST /plans/vision/", "section": "", "api_field_name": "start_date", "plain_label": "Plan start date", "data_type": "string", "required": "REQUIRED", "allowed_values": "", "constraints": "format: date", "default": "", "description": "Formated YYYY-MM-DD." }, { "resource": "Vision Plans", "endpoint": "POST /plans/vision/", "section": "", "api_field_name": "end_date", "plain_label": "Plan end date", "data_type": "string", "required": "REQUIRED", "allowed_values": "", "constraints": "format: date", "default": "", "description": "Formated YYYY-MM-DD." }, { "resource": "Vision Plans", "endpoint": "POST /plans/vision/", "section": "", "api_field_name": "from_plan", "plain_label": "Prior-year plan ID", "data_type": "string", "required": "OPTIONAL", "allowed_values": "", "constraints": "format: uuid", "default": "", "description": "ID of prior year plan from which current plan is renewed or converted." }, { "resource": "Vision Plans", "endpoint": "POST /plans/vision/", "section": "", "api_field_name": "from_action", "plain_label": "Prior-year relationship", "data_type": "string", "required": "OPTIONAL", "allowed_values": "RENEWED | CONVERTED", "constraints": "", "default": "", "description": "Prior year plan is renewed if with the same carrier or converted if moved to a different carrier." }, { "resource": "Vision Plans", "endpoint": "POST /plans/vision/", "section": "", "api_field_name": "pt", "plain_label": "Offered to part-time employees", "data_type": "boolean", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Is benefit offered to part time employees?" }, { "resource": "Vision Plans", "endpoint": "POST /plans/vision/", "section": "", "api_field_name": "funding", "plain_label": "Funding type", "data_type": "string", "required": "REQUIRED", "allowed_values": "FUNDING_FULLY | FUNDING_LEVEL | FUNDING_SELF", "constraints": "", "default": "", "description": "Used to differentiate plans within the benefit class based on how employer shares risk with carrier." }, { "resource": "Vision Plans", "endpoint": "POST /plans/vision/", "section": "", "api_field_name": "t1_ee", "plain_label": "Tier 1 employee contribution (PEPY)", "data_type": "integer", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Amount paid by a single (tier 1) employee per year (PEPY) to cover their portion of the cost of the plan." }, { "resource": "Vision Plans", "endpoint": "POST /plans/vision/", "section": "", "api_field_name": "t2_ee", "plain_label": "Tier 2 employee contribution (PEPY)", "data_type": "integer", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Amount paid by an employee + spouse (tier 2) employee per year (PEPY) to cover their portion of the cost of the plan. If 2 tier rate structure, use the 'Family' rate. If it's 3 tiers, use the 'Employee + 1' rate." }, { "resource": "Vision Plans", "endpoint": "POST /plans/vision/", "section": "", "api_field_name": "t3_ee", "plain_label": "Tier 3 employee contribution (PEPY)", "data_type": "integer", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Amount paid by an employee + children (tier 3) employee per year (PEPY) to cover their portion of the cost of the plan. If 2 tier rate structure, use the 'Family' rate. If it's 3 tiers, use either, the 'Employee + 1' or 'Family' rate. If 5 tiers, use mean of the 3rd and 4th tier." }, { "resource": "Vision Plans", "endpoint": "POST /plans/vision/", "section": "", "api_field_name": "t4_ee", "plain_label": "Tier 4 employee contribution (PEPY)", "data_type": "integer", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Amount paid by an employee + family (tier 4) employee per year (PEPY) to cover their portion of the cost of the plan." }, { "resource": "Vision Plans", "endpoint": "POST /plans/vision/", "section": "", "api_field_name": "t1_gross", "plain_label": "Tier 1 total cost (PEPY)", "data_type": "integer", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Full amount paid by the employer (before EE contributions) to cover a single (tier 1) employee per year (PEPY)." }, { "resource": "Vision Plans", "endpoint": "POST /plans/vision/", "section": "", "api_field_name": "t2_gross", "plain_label": "Tier 2 total cost (PEPY)", "data_type": "integer", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Full amount paid by the employer (before EE contributions) to cover an employee + spouse (tier 2) employee per year (PEPY). If 2 tier rate structure, use the 'Family' rate. If it's 3 tiers, use the 'Employee + 1' rate." }, { "resource": "Vision Plans", "endpoint": "POST /plans/vision/", "section": "", "api_field_name": "t3_gross", "plain_label": "Tier 3 total cost (PEPY)", "data_type": "integer", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Full amount paid by the employer (before EE contributions) to cover an employee + children (tier 3) employee per year (PEPY). If 2 tier rate structure, use the 'Family' rate. If it's 3 tiers, use either, the 'Employee + 1' or 'Family' rate. If 5 tiers, use mean of the 3rd and 4th tier." }, { "resource": "Vision Plans", "endpoint": "POST /plans/vision/", "section": "", "api_field_name": "t4_gross", "plain_label": "Tier 4 total cost (PEPY)", "data_type": "integer", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Full amount paid by the employer (before EE contributions) to cover an employee + family (tier 4) employee per year (PEPY)." }, { "resource": "Vision Plans", "endpoint": "POST /plans/vision/", "section": "", "api_field_name": "exam_frequency", "plain_label": "Exam frequency (months)", "data_type": "integer", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "How often the exam benefit is covered, in months." }, { "resource": "Vision Plans", "endpoint": "POST /plans/vision/", "section": "", "api_field_name": "lenses_frequency", "plain_label": "Lenses frequency (months)", "data_type": "integer", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "How often the lenses benefit is covered, in months." }, { "resource": "Vision Plans", "endpoint": "POST /plans/vision/", "section": "", "api_field_name": "frames_frequency", "plain_label": "Frames frequency (months)", "data_type": "integer", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "How often the frames benefit is covered, in months." }, { "resource": "Vision Plans", "endpoint": "POST /plans/vision/", "section": "", "api_field_name": "contacts_frequency", "plain_label": "Contacts frequency (months)", "data_type": "integer", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "How often the contacts benefit is covered, in months." }, { "resource": "Vision Plans", "endpoint": "POST /plans/vision/", "section": "", "api_field_name": "exam_copay", "plain_label": "Exam copay (in-network)", "data_type": "integer", "required": "OPTIONAL", "allowed_values": "", "constraints": "", "default": "", "description": "Single payment that applies to exam in-network. Only provide a value if a copay is required; otherwise set to null." }, { "resource": "Vision Plans", "endpoint": "POST /plans/vision/", "section": "", "api_field_name": "lenses_copay", "plain_label": "Lenses copay (in-network)", "data_type": "integer", "required": "OPTIONAL", "allowed_values": "", "constraints": "", "default": "", "description": "Single payment that applies to lenses in-network. Only provide a value if a copay is required; otherwise set to null." }, { "resource": "Vision Plans", "endpoint": "POST /plans/vision/", "section": "", "api_field_name": "frames_copay", "plain_label": "Frames copay (in-network)", "data_type": "integer", "required": "OPTIONAL", "allowed_values": "", "constraints": "", "default": "", "description": "Single payment that applies to frames in-network. Only provide a value if a copay is required; otherwise set to null." }, { "resource": "Vision Plans", "endpoint": "POST /plans/vision/", "section": "", "api_field_name": "contacts_copay", "plain_label": "Contacts copay (in-network)", "data_type": "integer", "required": "OPTIONAL", "allowed_values": "", "constraints": "", "default": "", "description": "Single payment that applies to contacts in-network. Only provide a value if a copay is required; otherwise set to null." }, { "resource": "Vision Plans", "endpoint": "POST /plans/vision/", "section": "", "api_field_name": "exam_allowance", "plain_label": "Exam allowance (in-network)", "data_type": "integer", "required": "OPTIONAL", "allowed_values": "", "constraints": "", "default": "", "description": "Amount covered by insurance that applies to exam in-network. Only provide a value if an allowance is part of the cost share; otherwise set to null." }, { "resource": "Vision Plans", "endpoint": "POST /plans/vision/", "section": "", "api_field_name": "lenses_allowance", "plain_label": "Lenses allowance (in-network)", "data_type": "integer", "required": "OPTIONAL", "allowed_values": "", "constraints": "", "default": "", "description": "Amount covered by insurance that applies to lenses in-network. Only provide a value if an allowance is part of the cost share; otherwise set to null." }, { "resource": "Vision Plans", "endpoint": "POST /plans/vision/", "section": "", "api_field_name": "frames_allowance", "plain_label": "Frames allowance (in-network)", "data_type": "integer", "required": "OPTIONAL", "allowed_values": "", "constraints": "", "default": "", "description": "Amount covered by insurance that applies to frames in-network. Only provide a value if an allowance is part of the cost share; otherwise set to null." }, { "resource": "Vision Plans", "endpoint": "POST /plans/vision/", "section": "", "api_field_name": "contacts_allowance", "plain_label": "Contacts allowance (in-network)", "data_type": "integer", "required": "OPTIONAL", "allowed_values": "", "constraints": "", "default": "", "description": "Amount covered by insurance that applies to contacts in-network. Only provide a value if an allowance is part of the cost share; otherwise set to null." }, { "resource": "Vision Plans", "endpoint": "POST /plans/vision/", "section": "", "api_field_name": "exam_out_allowance", "plain_label": "Exam allowance (out-of-network)", "data_type": "integer", "required": "OPTIONAL", "allowed_values": "", "constraints": "", "default": "", "description": "Amount covered by insurance that applies to exam out-of-network." }, { "resource": "Vision Plans", "endpoint": "POST /plans/vision/", "section": "", "api_field_name": "lenses_out_allowance", "plain_label": "Lenses allowance (out-of-network)", "data_type": "integer", "required": "OPTIONAL", "allowed_values": "", "constraints": "", "default": "", "description": "Amount covered by insurance that applies to lenses out-of-network." }, { "resource": "Vision Plans", "endpoint": "POST /plans/vision/", "section": "", "api_field_name": "frames_out_allowance", "plain_label": "Frames allowance (out-of-network)", "data_type": "integer", "required": "OPTIONAL", "allowed_values": "", "constraints": "", "default": "", "description": "Amount covered by insurance that applies to frames out-of-network." }, { "resource": "Vision Plans", "endpoint": "POST /plans/vision/", "section": "", "api_field_name": "contacts_out_allowance", "plain_label": "Contacts allowance (out-of-network)", "data_type": "integer", "required": "OPTIONAL", "allowed_values": "", "constraints": "", "default": "", "description": "Amount covered by insurance that applies to contacts out-of-network." }, { "resource": "Basic Life and AD&D Plans", "endpoint": "POST /plans/basiclife/", "section": "", "api_field_name": "employer", "plain_label": "Employer ID", "data_type": "string", "required": "REQUIRED", "allowed_values": "", "constraints": "format: uuid", "default": "", "description": "ID of employer that offers plan." }, { "resource": "Basic Life and AD&D Plans", "endpoint": "POST /plans/basiclife/", "section": "", "api_field_name": "title", "plain_label": "Plan title", "data_type": "string", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Unique plan title to identify and differentiate. Can match title provided by insurer." }, { "resource": "Basic Life and AD&D Plans", "endpoint": "POST /plans/basiclife/", "section": "", "api_field_name": "carrier", "plain_label": "Carrier / ASO provider", "data_type": "string", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Name of insurance company for fully-insured plans and ASO provider for self-insured plans." }, { "resource": "Basic Life and AD&D Plans", "endpoint": "POST /plans/basiclife/", "section": "", "api_field_name": "start_date", "plain_label": "Plan start date", "data_type": "string", "required": "REQUIRED", "allowed_values": "", "constraints": "format: date", "default": "", "description": "Formated YYYY-MM-DD." }, { "resource": "Basic Life and AD&D Plans", "endpoint": "POST /plans/basiclife/", "section": "", "api_field_name": "end_date", "plain_label": "Plan end date", "data_type": "string", "required": "REQUIRED", "allowed_values": "", "constraints": "format: date", "default": "", "description": "Formated YYYY-MM-DD." }, { "resource": "Basic Life and AD&D Plans", "endpoint": "POST /plans/basiclife/", "section": "", "api_field_name": "from_plan", "plain_label": "Prior-year plan ID", "data_type": "string", "required": "OPTIONAL", "allowed_values": "", "constraints": "format: uuid", "default": "", "description": "ID of prior year plan from which current plan is renewed or converted." }, { "resource": "Basic Life and AD&D Plans", "endpoint": "POST /plans/basiclife/", "section": "", "api_field_name": "from_action", "plain_label": "Prior-year relationship", "data_type": "string", "required": "OPTIONAL", "allowed_values": "RENEWED | CONVERTED", "constraints": "", "default": "", "description": "Prior year plan is renewed if with the same carrier or converted if moved to a different carrier." }, { "resource": "Basic Life and AD&D Plans", "endpoint": "POST /plans/basiclife/", "section": "", "api_field_name": "pt", "plain_label": "Offered to part-time employees", "data_type": "boolean", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Is benefit offered to part time employees?" }, { "resource": "Basic Life and AD&D Plans", "endpoint": "POST /plans/basiclife/", "section": "", "api_field_name": "type", "plain_label": "Benefit amount basis", "data_type": "string", "required": "REQUIRED", "allowed_values": "MULTIPLE_OF_SALARY | FLAT_AMOUNT", "constraints": "", "default": "", "description": "Method used to determine the total death benefit. 'MULTIPLE_OF_SALARY' calculates a variable benefit from the employee's salary; 'FLAT_AMOUNT' provides a fixed benefit." }, { "resource": "Basic Life and AD&D Plans", "endpoint": "POST /plans/basiclife/", "section": "", "api_field_name": "multiple", "plain_label": "Salary multiple", "data_type": "number", "required": "OPTIONAL", "allowed_values": "", "constraints": "format: integer", "default": "", "description": "The multiply factor of salary used to calculate a variable total death benefit to be paid to beneficiaries. Required when type is 'MULTIPLE_OF_SALARY'." }, { "resource": "Basic Life and AD&D Plans", "endpoint": "POST /plans/basiclife/", "section": "", "api_field_name": "multiple_max", "plain_label": "Salary-multiple benefit cap", "data_type": "number", "required": "OPTIONAL", "allowed_values": "", "constraints": "format: integer", "default": "", "description": "Used with 'MULTIPLE_OF_SALARY' plans to cap the total death benefit to be paid to beneficiaries." }, { "resource": "Basic Life and AD&D Plans", "endpoint": "POST /plans/basiclife/", "section": "", "api_field_name": "flat_amount", "plain_label": "Flat benefit amount", "data_type": "number", "required": "OPTIONAL", "allowed_values": "", "constraints": "format: integer", "default": "", "description": "The fixed total death benefit to be paid to beneficiaries. Required when type is 'FLAT_AMOUNT'." }, { "resource": "Basic Life and AD&D Plans", "endpoint": "POST /plans/basiclife/", "section": "", "api_field_name": "add", "plain_label": "AD&D included", "data_type": "boolean", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Indicates if AD&D insurance is included with (or offered alongside) the life insurance policy." }, { "resource": "Voluntary Life and AD&D Plans", "endpoint": "POST /plans/voluntarylife/", "section": "", "api_field_name": "employer", "plain_label": "Employer ID", "data_type": "string", "required": "REQUIRED", "allowed_values": "", "constraints": "format: uuid", "default": "", "description": "ID of employer that offers plan." }, { "resource": "Voluntary Life and AD&D Plans", "endpoint": "POST /plans/voluntarylife/", "section": "", "api_field_name": "title", "plain_label": "Plan title", "data_type": "string", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Unique plan title to identify and differentiate. Can match title provided by insurer." }, { "resource": "Voluntary Life and AD&D Plans", "endpoint": "POST /plans/voluntarylife/", "section": "", "api_field_name": "carrier", "plain_label": "Carrier / ASO provider", "data_type": "string", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Name of insurance company for fully-insured plans and ASO provider for self-insured plans." }, { "resource": "Voluntary Life and AD&D Plans", "endpoint": "POST /plans/voluntarylife/", "section": "", "api_field_name": "start_date", "plain_label": "Plan start date", "data_type": "string", "required": "REQUIRED", "allowed_values": "", "constraints": "format: date", "default": "", "description": "Formated YYYY-MM-DD." }, { "resource": "Voluntary Life and AD&D Plans", "endpoint": "POST /plans/voluntarylife/", "section": "", "api_field_name": "end_date", "plain_label": "Plan end date", "data_type": "string", "required": "REQUIRED", "allowed_values": "", "constraints": "format: date", "default": "", "description": "Formated YYYY-MM-DD." }, { "resource": "Voluntary Life and AD&D Plans", "endpoint": "POST /plans/voluntarylife/", "section": "", "api_field_name": "from_plan", "plain_label": "Prior-year plan ID", "data_type": "string", "required": "OPTIONAL", "allowed_values": "", "constraints": "format: uuid", "default": "", "description": "ID of prior year plan from which current plan is renewed or converted." }, { "resource": "Voluntary Life and AD&D Plans", "endpoint": "POST /plans/voluntarylife/", "section": "", "api_field_name": "from_action", "plain_label": "Prior-year relationship", "data_type": "string", "required": "OPTIONAL", "allowed_values": "RENEWED | CONVERTED", "constraints": "", "default": "", "description": "Prior year plan is renewed if with the same carrier or converted if moved to a different carrier." }, { "resource": "Voluntary Life and AD&D Plans", "endpoint": "POST /plans/voluntarylife/", "section": "", "api_field_name": "pt", "plain_label": "Offered to part-time employees", "data_type": "boolean", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Is benefit offered to part time employees?" }, { "resource": "Voluntary Life and AD&D Plans", "endpoint": "POST /plans/voluntarylife/", "section": "", "api_field_name": "max", "plain_label": "Maximum employee benefit", "data_type": "number", "required": "REQUIRED", "allowed_values": "", "constraints": "format: integer", "default": "", "description": "Maximum total death benefit amount available to the employee." }, { "resource": "Voluntary Life and AD&D Plans", "endpoint": "POST /plans/voluntarylife/", "section": "", "api_field_name": "guarantee_issue", "plain_label": "Guarantee issue amount", "data_type": "number", "required": "REQUIRED", "allowed_values": "", "constraints": "format: integer", "default": "", "description": "Guarantee issue amount available to the employee without evidence of insurability." }, { "resource": "Voluntary Life and AD&D Plans", "endpoint": "POST /plans/voluntarylife/", "section": "", "api_field_name": "max_spouse", "plain_label": "Maximum spouse benefit", "data_type": "number", "required": "OPTIONAL", "allowed_values": "", "constraints": "format: integer", "default": "", "description": "Maximum total death benefit amount available to the employee's spouse." }, { "resource": "Voluntary Life and AD&D Plans", "endpoint": "POST /plans/voluntarylife/", "section": "", "api_field_name": "max_children", "plain_label": "Maximum child benefit", "data_type": "number", "required": "OPTIONAL", "allowed_values": "", "constraints": "format: integer", "default": "", "description": "Maximum total death benefit amount available to the employee's children." }, { "resource": "Voluntary Life and AD&D Plans", "endpoint": "POST /plans/voluntarylife/", "section": "", "api_field_name": "add", "plain_label": "AD&D included", "data_type": "boolean", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Indicates if AD&D insurance is included with (or offered alongside) the life insurance policy." }, { "resource": "Short-Term Disability Plans", "endpoint": "POST /plans/std/", "section": "", "api_field_name": "employer", "plain_label": "Employer ID", "data_type": "string", "required": "REQUIRED", "allowed_values": "", "constraints": "format: uuid", "default": "", "description": "ID of employer that offers plan." }, { "resource": "Short-Term Disability Plans", "endpoint": "POST /plans/std/", "section": "", "api_field_name": "title", "plain_label": "Plan title", "data_type": "string", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Unique plan title to identify and differentiate. Can match title provided by insurer." }, { "resource": "Short-Term Disability Plans", "endpoint": "POST /plans/std/", "section": "", "api_field_name": "carrier", "plain_label": "Carrier / ASO provider", "data_type": "string", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Name of insurance company for fully-insured plans and ASO provider for self-insured plans." }, { "resource": "Short-Term Disability Plans", "endpoint": "POST /plans/std/", "section": "", "api_field_name": "start_date", "plain_label": "Plan start date", "data_type": "string", "required": "REQUIRED", "allowed_values": "", "constraints": "format: date", "default": "", "description": "Formated YYYY-MM-DD." }, { "resource": "Short-Term Disability Plans", "endpoint": "POST /plans/std/", "section": "", "api_field_name": "end_date", "plain_label": "Plan end date", "data_type": "string", "required": "REQUIRED", "allowed_values": "", "constraints": "format: date", "default": "", "description": "Formated YYYY-MM-DD." }, { "resource": "Short-Term Disability Plans", "endpoint": "POST /plans/std/", "section": "", "api_field_name": "from_plan", "plain_label": "Prior-year plan ID", "data_type": "string", "required": "OPTIONAL", "allowed_values": "", "constraints": "format: uuid", "default": "", "description": "ID of prior year plan from which current plan is renewed or converted." }, { "resource": "Short-Term Disability Plans", "endpoint": "POST /plans/std/", "section": "", "api_field_name": "from_action", "plain_label": "Prior-year relationship", "data_type": "string", "required": "OPTIONAL", "allowed_values": "RENEWED | CONVERTED", "constraints": "", "default": "", "description": "Prior year plan is renewed if with the same carrier or converted if moved to a different carrier." }, { "resource": "Short-Term Disability Plans", "endpoint": "POST /plans/std/", "section": "", "api_field_name": "pt", "plain_label": "Offered to part-time employees", "data_type": "boolean", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Is benefit offered to part time employees?" }, { "resource": "Short-Term Disability Plans", "endpoint": "POST /plans/std/", "section": "", "api_field_name": "cost_share", "plain_label": "Cost-share model", "data_type": "string", "required": "REQUIRED", "allowed_values": "EMPLOYER_PAID | EMPLOYEE_COST_SHARE | VOLUNTARY", "constraints": "", "default": "", "description": "Used to differentiate plans within the benefit class based on how premium cost is shared." }, { "resource": "Short-Term Disability Plans", "endpoint": "POST /plans/std/", "section": "", "api_field_name": "percentage", "plain_label": "Income replacement percentage", "data_type": "integer", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Portion of weekly earnings eligible to receive up to a specific maximum amount. Some plans employ a “step-down”, where there are two percentages. Usually a higher percentage to start that drops down after a few weeks. In this case, use a weighted average." }, { "resource": "Short-Term Disability Plans", "endpoint": "POST /plans/std/", "section": "", "api_field_name": "weekly_max", "plain_label": "Weekly benefit maximum", "data_type": "integer", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Maximum benefit amount employees can receive each week." }, { "resource": "Short-Term Disability Plans", "endpoint": "POST /plans/std/", "section": "", "api_field_name": "waiting_days_injury", "plain_label": "Waiting period, injury (days)", "data_type": "integer", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "The number of days the employee must be disabled due to injury before being eligible to receive STD benefits." }, { "resource": "Short-Term Disability Plans", "endpoint": "POST /plans/std/", "section": "", "api_field_name": "waiting_days_sick", "plain_label": "Waiting period, illness (days)", "data_type": "integer", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "The number of days the employee must be disabled due to illness before being eligible to receive STD benefits." }, { "resource": "Short-Term Disability Plans", "endpoint": "POST /plans/std/", "section": "", "api_field_name": "duration_weeks", "plain_label": "Benefit duration (weeks)", "data_type": "integer", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "The maximum number of weeks that an employee will receive STD benefits. This duration figure does not include the elimination period." }, { "resource": "Long-Term Disability Plans", "endpoint": "POST /plans/ltd/", "section": "", "api_field_name": "employer", "plain_label": "Employer ID", "data_type": "string", "required": "REQUIRED", "allowed_values": "", "constraints": "format: uuid", "default": "", "description": "ID of employer that offers plan." }, { "resource": "Long-Term Disability Plans", "endpoint": "POST /plans/ltd/", "section": "", "api_field_name": "title", "plain_label": "Plan title", "data_type": "string", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Unique plan title to identify and differentiate. Can match title provided by insurer." }, { "resource": "Long-Term Disability Plans", "endpoint": "POST /plans/ltd/", "section": "", "api_field_name": "carrier", "plain_label": "Carrier / ASO provider", "data_type": "string", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Name of insurance company for fully-insured plans and ASO provider for self-insured plans." }, { "resource": "Long-Term Disability Plans", "endpoint": "POST /plans/ltd/", "section": "", "api_field_name": "start_date", "plain_label": "Plan start date", "data_type": "string", "required": "REQUIRED", "allowed_values": "", "constraints": "format: date", "default": "", "description": "Formated YYYY-MM-DD." }, { "resource": "Long-Term Disability Plans", "endpoint": "POST /plans/ltd/", "section": "", "api_field_name": "end_date", "plain_label": "Plan end date", "data_type": "string", "required": "REQUIRED", "allowed_values": "", "constraints": "format: date", "default": "", "description": "Formated YYYY-MM-DD." }, { "resource": "Long-Term Disability Plans", "endpoint": "POST /plans/ltd/", "section": "", "api_field_name": "from_plan", "plain_label": "Prior-year plan ID", "data_type": "string", "required": "OPTIONAL", "allowed_values": "", "constraints": "format: uuid", "default": "", "description": "ID of prior year plan from which current plan is renewed or converted." }, { "resource": "Long-Term Disability Plans", "endpoint": "POST /plans/ltd/", "section": "", "api_field_name": "from_action", "plain_label": "Prior-year relationship", "data_type": "string", "required": "OPTIONAL", "allowed_values": "RENEWED | CONVERTED", "constraints": "", "default": "", "description": "Prior year plan is renewed if with the same carrier or converted if moved to a different carrier." }, { "resource": "Long-Term Disability Plans", "endpoint": "POST /plans/ltd/", "section": "", "api_field_name": "pt", "plain_label": "Offered to part-time employees", "data_type": "boolean", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Is benefit offered to part time employees?" }, { "resource": "Long-Term Disability Plans", "endpoint": "POST /plans/ltd/", "section": "", "api_field_name": "cost_share", "plain_label": "Cost-share model", "data_type": "string", "required": "REQUIRED", "allowed_values": "EMPLOYER_PAID | EMPLOYEE_COST_SHARE | VOLUNTARY", "constraints": "", "default": "", "description": "Used to differentiate plans within the benefit class based on how premium cost is shared." }, { "resource": "Long-Term Disability Plans", "endpoint": "POST /plans/ltd/", "section": "", "api_field_name": "percentage", "plain_label": "Income replacement percentage", "data_type": "integer", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Portion of monthly earnings eligible to receive up to a specific maximum amount. Some plans employ a “step-down”, where there are two percentages. Usually a higher percentage to start that drops down after a few weeks. In this case, use a weighted average." }, { "resource": "Long-Term Disability Plans", "endpoint": "POST /plans/ltd/", "section": "", "api_field_name": "monthly_max", "plain_label": "Monthly benefit maximum", "data_type": "integer", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Maximum benefit amount employees can receive each month." }, { "resource": "Long-Term Disability Plans", "endpoint": "POST /plans/ltd/", "section": "", "api_field_name": "waiting_weeks", "plain_label": "Waiting period (weeks)", "data_type": "integer", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "The number of weeks the employee must be disabled before being eligible to receive LTD benefits." }, { "resource": "Stop Loss Plans", "endpoint": "POST /plans/stoploss/", "section": "", "api_field_name": "employer", "plain_label": "Employer ID", "data_type": "string", "required": "REQUIRED", "allowed_values": "", "constraints": "format: uuid", "default": "", "description": "ID of employer that offers plan." }, { "resource": "Stop Loss Plans", "endpoint": "POST /plans/stoploss/", "section": "", "api_field_name": "title", "plain_label": "Plan title", "data_type": "string", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Unique plan title to identify and differentiate. Can match title provided by insurer." }, { "resource": "Stop Loss Plans", "endpoint": "POST /plans/stoploss/", "section": "", "api_field_name": "carrier", "plain_label": "Carrier / ASO provider", "data_type": "string", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Name of insurance company for fully-insured plans and ASO provider for self-insured plans." }, { "resource": "Stop Loss Plans", "endpoint": "POST /plans/stoploss/", "section": "", "api_field_name": "start_date", "plain_label": "Plan start date", "data_type": "string", "required": "REQUIRED", "allowed_values": "", "constraints": "format: date", "default": "", "description": "Formated YYYY-MM-DD." }, { "resource": "Stop Loss Plans", "endpoint": "POST /plans/stoploss/", "section": "", "api_field_name": "end_date", "plain_label": "Plan end date", "data_type": "string", "required": "REQUIRED", "allowed_values": "", "constraints": "format: date", "default": "", "description": "Formated YYYY-MM-DD." }, { "resource": "Stop Loss Plans", "endpoint": "POST /plans/stoploss/", "section": "", "api_field_name": "from_plan", "plain_label": "Prior-year plan ID", "data_type": "string", "required": "OPTIONAL", "allowed_values": "", "constraints": "format: uuid", "default": "", "description": "ID of prior year plan from which current plan is renewed or converted." }, { "resource": "Stop Loss Plans", "endpoint": "POST /plans/stoploss/", "section": "", "api_field_name": "from_action", "plain_label": "Prior-year relationship", "data_type": "string", "required": "OPTIONAL", "allowed_values": "RENEWED | CONVERTED", "constraints": "", "default": "", "description": "Prior year plan is renewed if with the same carrier or converted if moved to a different carrier." }, { "resource": "Stop Loss Plans", "endpoint": "POST /plans/stoploss/", "section": "", "api_field_name": "spec_ded", "plain_label": "Specific deductible", "data_type": "integer", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "The dollar amount to be paid by the plan on each covered individual before the stop loss policy kicks in to reimburse expenses incurred during the contract period." }, { "resource": "Stop Loss Plans", "endpoint": "POST /plans/stoploss/", "section": "", "api_field_name": "spec_rate_single", "plain_label": "Specific rate (single)", "data_type": "integer", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Annual amount paid by employer for specific stop loss insurance for single tier employees." }, { "resource": "Stop Loss Plans", "endpoint": "POST /plans/stoploss/", "section": "", "api_field_name": "spec_rate_family", "plain_label": "Specific rate (family)", "data_type": "integer", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Annual amount paid by employer for specific stop loss insurance for family tier employees." }, { "resource": "Stop Loss Plans", "endpoint": "POST /plans/stoploss/", "section": "", "api_field_name": "num_lasers", "plain_label": "Lasered individuals", "data_type": "integer", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Number of individuals covered by the stop loss policy at a higher Specific deductible than the rest of the group, based on prior claims experience or known conditions." }, { "resource": "Stop Loss Plans", "endpoint": "POST /plans/stoploss/", "section": "", "api_field_name": "agg_rate", "plain_label": "Aggregate rate", "data_type": "integer", "required": "OPTIONAL", "allowed_values": "", "constraints": "", "default": "", "description": "Annual amount paid by employer for aggregate stop-loss insurance per employee. If Aggregate insurance is not offered, set to null." }, { "resource": "Supplemental Plans", "endpoint": "POST /plans/supplemental/", "section": "", "api_field_name": "employer", "plain_label": "Employer ID", "data_type": "string", "required": "REQUIRED", "allowed_values": "", "constraints": "format: uuid", "default": "", "description": "ID of employer that offers plan." }, { "resource": "Supplemental Plans", "endpoint": "POST /plans/supplemental/", "section": "", "api_field_name": "title", "plain_label": "Plan title", "data_type": "string", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Unique plan title to identify and differentiate. Can match title provided by insurer." }, { "resource": "Supplemental Plans", "endpoint": "POST /plans/supplemental/", "section": "", "api_field_name": "carrier", "plain_label": "Carrier / ASO provider", "data_type": "string", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Name of insurance company for fully-insured plans and ASO provider for self-insured plans." }, { "resource": "Supplemental Plans", "endpoint": "POST /plans/supplemental/", "section": "", "api_field_name": "start_date", "plain_label": "Plan start date", "data_type": "string", "required": "REQUIRED", "allowed_values": "", "constraints": "format: date", "default": "", "description": "Formated YYYY-MM-DD." }, { "resource": "Supplemental Plans", "endpoint": "POST /plans/supplemental/", "section": "", "api_field_name": "end_date", "plain_label": "Plan end date", "data_type": "string", "required": "REQUIRED", "allowed_values": "", "constraints": "format: date", "default": "", "description": "Formated YYYY-MM-DD." }, { "resource": "Supplemental Plans", "endpoint": "POST /plans/supplemental/", "section": "", "api_field_name": "from_plan", "plain_label": "Prior-year plan ID", "data_type": "string", "required": "OPTIONAL", "allowed_values": "", "constraints": "format: uuid", "default": "", "description": "ID of prior year plan from which current plan is renewed or converted." }, { "resource": "Supplemental Plans", "endpoint": "POST /plans/supplemental/", "section": "", "api_field_name": "from_action", "plain_label": "Prior-year relationship", "data_type": "string", "required": "OPTIONAL", "allowed_values": "RENEWED | CONVERTED", "constraints": "", "default": "", "description": "Prior year plan is renewed if with the same carrier or converted if moved to a different carrier." }, { "resource": "Supplemental Plans", "endpoint": "POST /plans/supplemental/", "section": "", "api_field_name": "critical_illness", "plain_label": "Critical illness offered", "data_type": "boolean", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Is Critical Illness insurance offered as part of the supplemental plan?" }, { "resource": "Supplemental Plans", "endpoint": "POST /plans/supplemental/", "section": "", "api_field_name": "hospital_indemnity", "plain_label": "Hospital indemnity offered", "data_type": "boolean", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Is Hospital Indemnity insurance offered as part of the supplemental plan?" }, { "resource": "Supplemental Plans", "endpoint": "POST /plans/supplemental/", "section": "", "api_field_name": "accident", "plain_label": "Accident offered", "data_type": "boolean", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Is Accident insurance offered as part of the supplemental plan?" }, { "resource": "Supplemental Plans", "endpoint": "POST /plans/supplemental/", "section": "", "api_field_name": "cancer", "plain_label": "Cancer offered", "data_type": "boolean", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Is Cancer insurance offered as part of the supplemental plan?" }, { "resource": "Supplemental Plans", "endpoint": "POST /plans/supplemental/", "section": "", "api_field_name": "pet", "plain_label": "Pet insurance offered", "data_type": "boolean", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Is Pet insurance offered as part of the supplemental plan?" }, { "resource": "Supplemental Plans", "endpoint": "POST /plans/supplemental/", "section": "", "api_field_name": "legal_assist", "plain_label": "Legal assistance offered", "data_type": "boolean", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Is Legal Assistance offered as part of the supplemental plan?" }, { "resource": "Supplemental Plans", "endpoint": "POST /plans/supplemental/", "section": "", "api_field_name": "credit_protection", "plain_label": "Credit protection offered", "data_type": "boolean", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Is Credit Protection offered as part of the supplemental plan?" }, { "resource": "Supplemental Plans", "endpoint": "POST /plans/supplemental/", "section": "", "api_field_name": "tuition_reimburse", "plain_label": "Tuition reimbursement offered", "data_type": "boolean", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Is Tuition Reimbursement offered as part of the supplemental plan?" }, { "resource": "Manage Users", "endpoint": "POST /users/", "section": "", "api_field_name": "email", "plain_label": "Work email", "data_type": "string", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "User's work email address." }, { "resource": "Manage Users", "endpoint": "POST /users/", "section": "", "api_field_name": "first_name", "plain_label": "First name", "data_type": "string", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "User's first name." }, { "resource": "Manage Users", "endpoint": "POST /users/", "section": "", "api_field_name": "last_name", "plain_label": "Last name", "data_type": "string", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "User's last name." }, { "resource": "Manage Users", "endpoint": "POST /users/", "section": "", "api_field_name": "division_ids", "plain_label": "Division IDs", "data_type": "array", "required": "REQUIRED", "allowed_values": "", "constraints": "unique items", "default": "", "description": "Unique ID assigned to a dedicated group within your account ensuring the security and protection of benefit data. Only users assigned to a division can view, edit, and report on employers/plans within that division." }, { "resource": "Manage Users", "endpoint": "POST /divisions/", "section": "", "api_field_name": "name", "plain_label": "Name", "data_type": "string", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "Unique name assigned to division." }, { "resource": "Manage Users", "endpoint": "POST /divisions/", "section": "", "api_field_name": "users", "plain_label": "User emails", "data_type": "array", "required": "REQUIRED", "allowed_values": "", "constraints": "unique items", "default": "", "description": "List of users' work emails assigned to division." }, { "resource": "Manage Users", "endpoint": "POST /divisions/", "section": "", "api_field_name": "employer_ids", "plain_label": "Employer IDs", "data_type": "array", "required": "REQUIRED", "allowed_values": "", "constraints": "unique items", "default": "", "description": "List of employer IDs assigned to division." }, { "resource": "Manage Users", "endpoint": "POST /divisions/{divisionID}/addUser/", "section": "", "api_field_name": "email", "plain_label": "Work email", "data_type": "string", "required": "REQUIRED", "allowed_values": "", "constraints": "", "default": "", "description": "User's work email address." } ] }