> ## Documentation Index
> Fetch the complete documentation index at: https://beta-docs.vitablehealth.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Configure company benefit

> Configure a company benefit with eligibility rules, tier costs, expense categories,
and enrollment periods. This endpoint allows payroll providers to set up
comprehensive benefit configurations including minimum premiums, eligibility criteria,
and cost structures.




## OpenAPI

````yaml external-api-schema.yml post /v1/company-benefits/{company_benefit_id}/configuration
openapi: 3.0.3
info:
  title: Vitable External Partner API
  version: 1.0.0
  description: >
    External API for Payroll Providers and PEO platforms to integrate with
    Vitable health plan products 

    for benefit administration. This API enables partner systems to manage
    benefit enrollment, 

    employee data, and plan information for their clients.


    Common integration scenarios:

    - Retrieve active benefit plans for employers

    - List enrolled employees for benefit periods  

    - Create and update employee records

    - Manage benefit enrollments and elections

    - Access enrollment status and eligibility information
servers:
  - url: https://api.vitablehealth.com
    description: Production server
  - url: https://api-staging.vitablehealth.com
    description: Staging server
security:
  - partnerApiKey: []
tags:
  - name: Company Benefits
    description: Benefit plans available to companies (plan years)
  - name: Company Members
    description: Employee management and information
  - name: Benefit Enrollments
    description: Employee benefit enrollment status and management
  - name: Member Benefits
    description: Individual employee benefit information
  - name: Benefit Eligibility
    description: Employee benefit eligibility information
  - name: Payroll Integration
    description: Payroll deduction and contribution calculations
  - name: Quoting
    description: Marketplace plan searches and insurance quotes
paths:
  /v1/company-benefits/{company_benefit_id}/configuration:
    post:
      tags:
        - Company Benefits
      summary: Configure company benefit
      description: >
        Configure a company benefit with eligibility rules, tier costs, expense
        categories,

        and enrollment periods. This endpoint allows payroll providers to set up

        comprehensive benefit configurations including minimum premiums,
        eligibility criteria,

        and cost structures.
      operationId: configure_company_benefit
      parameters:
        - in: path
          name: company_benefit_id
          schema:
            type: string
            format: uuid
          required: true
          description: Unique identifier for the company benefit to configure
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConfigureCompanyBenefitRequest'
      responses:
        '200':
          description: Company benefit configured successfully
      security:
        - partnerApiKey: []
components:
  schemas:
    ConfigureCompanyBenefitRequest:
      type: object
      description: Request to configure a company benefit
      properties:
        min_monthly_premium_in_cents:
          type: integer
          minimum: 0
          description: Minimum monthly premium amount in cents
        open_enrollment_start_date:
          type: string
          format: date
          description: Open enrollment period start date
        open_enrollment_end_date:
          type: string
          format: date
          nullable: true
          description: Open enrollment period end date
        configured_eligibility_rules:
          type: array
          items:
            $ref: '#/components/schemas/ConfigurableEligibilityRule'
          description: Eligibility rules configuration
        configured_tier_costs:
          type: array
          items:
            $ref: '#/components/schemas/ConfigurableTierCost'
          description: Tier cost configuration
        selected_eligible_expense_categories_ids:
          type: array
          items:
            type: string
            format: uuid
          description: Selected eligible expense category IDs
        agency_of_record_id:
          type: string
          format: uuid
          nullable: true
          description: Agency of record identifier
      required:
        - min_monthly_premium_in_cents
        - open_enrollment_start_date
        - configured_eligibility_rules
        - configured_tier_costs
        - selected_eligible_expense_categories_ids
    ConfigurableEligibilityRule:
      type: object
      description: Configurable eligibility rule
      properties:
        id:
          type: string
          format: uuid
          nullable: true
          description: Rule identifier (null for new rules)
        employment:
          type: string
          enum:
            - Unspecified
            - Full Time
            - Part Time
            - Temporary
            - Seasonal
          description: Employment type requirement
        compensation:
          type: string
          enum:
            - Unspecified
            - Salary
            - Hourly
          description: Compensation type requirement
        location:
          type: string
          enum:
            - Unspecified
            - State
          description: Location requirement type
        location_value:
          type: string
          nullable: true
          description: Location requirement value (e.g., state code if location is "State")
      required:
        - employment
        - compensation
        - location
    ConfigurableTierCost:
      type: object
      description: Configurable tier cost information
      properties:
        tier_cost_id:
          type: string
          format: uuid
          description: Tier cost identifier
        cost_in_cents:
          type: integer
          minimum: 0
          description: Employee cost in cents
        cost_per_dependent_in_cents:
          type: integer
          minimum: 0
          description: Cost per dependent in cents
        pepm_in_cents:
          type: integer
          minimum: 0
          description: Per employee per month cost in cents
        pepm_per_dependent_in_cents:
          type: integer
          minimum: 0
          description: Per employee per month cost per dependent in cents
      required:
        - tier_cost_id
        - cost_in_cents
        - cost_per_dependent_in_cents
        - pepm_in_cents
        - pepm_per_dependent_in_cents
  securitySchemes:
    partnerApiKey:
      type: apiKey
      in: header
      name: X-Partner-API-Key
      description: Partner API key for external integrations

````