GET
/
api
/
v1
/
employees
/
{employee_id}
/
premiums
curl --request GET \
  --url https://fulfillment.noyo.com/api/v1/employees/{employee_id}/premiums
{
  "meta": {
    "offset": 0,
    "page_num": 1,
    "page_size": 20,
    "total_records": 2
  },
  "response": [
    {
      "amount": "50.00",
      "billed_members": [
        {
          "line_of_coverage": "dental",
          "member_id": "4638b93f-b20a-4922-82b1-0f406891e2e3",
          "member_type": "employee",
          "plan_id": "8609ee91-772a-4047-8e2b-a79883cf05ea"
        },
        {
          "line_of_coverage": "vision",
          "member_id": "4638b93f-b20a-4922-82b1-0f406891e2e3",
          "member_type": "employee",
          "plan_id": "e1793d34-700b-4c14-9425-d0f4f426d4d0"
        },
        {
          "line_of_coverage": "dental",
          "member_id": "67309c4b-12f5-4bb0-92ce-a45639af9055",
          "member_type": "dependent",
          "plan_id": "8609ee91-772a-4047-8e2b-a79883cf05ea"
        },
        {
          "line_of_coverage": "vision",
          "member_id": "8f5aaf65-c4e6-4909-9ebf-58b320645df2",
          "member_type": "dependent",
          "plan_id": "e1793d34-700b-4c14-9425-d0f4f426d4d0"
        }
      ],
      "carrier_id": "e2c76400-b505-432a-a1c1-c777bcec4648",
      "created": 1599184829,
      "effective_end_date": "2020-12-31",
      "effective_start_date": "2020-01-01",
      "modified": 1599292817,
      "period": {
        "amount": 1,
        "unit": "month"
      },
      "premium_type": "employer_amount"
    },
    {
      "amount": "50.00",
      "billed_members": [
        {
          "line_of_coverage": "dental",
          "member_id": "4638b93f-b20a-4922-82b1-0f406891e2e3",
          "member_type": "employee",
          "plan_id": "8609ee91-772a-4047-8e2b-a79883cf05ea"
        },
        {
          "line_of_coverage": "vision",
          "member_id": "4638b93f-b20a-4922-82b1-0f406891e2e3",
          "member_type": "employee",
          "plan_id": "e1793d34-700b-4c14-9425-d0f4f426d4d0"
        },
        {
          "line_of_coverage": "dental",
          "member_id": "67309c4b-12f5-4bb0-92ce-a45639af9055",
          "member_type": "dependent",
          "plan_id": "8609ee91-772a-4047-8e2b-a79883cf05ea"
        },
        {
          "line_of_coverage": "vision",
          "member_id": "8f5aaf65-c4e6-4909-9ebf-58b320645df2",
          "member_type": "dependent",
          "plan_id": "e1793d34-700b-4c14-9425-d0f4f426d4d0"
        }
      ],
      "carrier_id": "e2c76400-b505-432a-a1c1-c777bcec4648",
      "created": 1599184829,
      "effective_end_date": "2020-12-31",
      "effective_start_date": "2020-01-01",
      "modified": 1599292817,
      "period": {
        "amount": 1,
        "unit": "month"
      },
      "premium_type": "employee_amount"
    }
  ]
}

Path Parameters

​
employee_id
string
required

Unique ID of the employee in Noyo

Example:

"30b74a44-d5b1-4123-a7a4-6d3aec251ba4"

Query Parameters

​
effective_date
string

The relative date on which to view the state of the records. Defaults to today

Example:

"Tue, 01 Sep 2020 00:00:00 GMT"

Response

200 - application/json
Paginated List of Member Premiums
​
meta
object
required

Metadata associated with the response data

​
response
object[]
required

List of member premiums

Was this page helpful?