latestSwagger 2.02026-08-0982147352.7 KB

be66ed178abe

Enrollment

current enrollments

All current and future enrollments.<p>Scopes: export_enrollment</p>

get/v{version}/companies/{company_id}/enrollments/current

Path parameters

company_idstring required

versionstring required

Query parameters

employee_start_idstring

employee_limitinteger

costs_deduction_period'Default' | 'Monthly' | 'Weekly' | 'PayCycle'

The deduction period used for cost calculations.

Response

Success

next_idstring

The id of the object next up after this set.

errorstring

Contains any error messages, if applicable.

Example response

{
  "data": [
    {
      "effective_date": "yyyy-MM-dd",
      "signature_date": "yyyy-MM-dd",
      "original_effective_date": "yyyy-MM-dd",
      "life_event_date": "yyyy-MM-dd",
      "coverages": [
        {
          "effective_date": "yyyy-MM-dd",
          "termination_date": "yyyy-MM-dd",
          "last_coverage_date": "yyyy-MM-dd",
          "life_event": {
            "date": "yyyy-MM-dd",
            "create_date": "yyyy-MM-dd",
            "last_modified_date": "yyyy-MM-dd"
          }
        }
      ],
      "plan": {
        "start_date": "yyyy-MM-dd",
        "end_date": "yyyy-MM-dd"
      },
      "activity_date": "yyyy-MM-dd",
      "change_date": "yyyy-MM-dd"
    }
  ]
}