Get a list of all Member Premiums
Groups
- POSTCreate Group
- PUTEdit Group
- GETGet Group
- GETList Groups
- Configurations
- Connections
- Contacts
- Disconnections
- Enrollments
- Locations
- Plans
- Renewals
- Syncs
Members
- Employees
- Dependents
- Enrollments
- Premiums
Changes
- Snapshots
- Tracking
Legacy
- Requests
- Transactions
Get a list of all Member Premiums
Returns list of Member Premium information for an employee and dependents
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
Unique ID of the employee in Noyo
Query Parameters
The relative date on which to view the state of the records. Defaults to today
Response
200 - application/json
Paginated List of Member Premiums
Metadata associated with the response data
The offset of the first response record within the matching data set
Required range:
x > 0The page number of the response records within the overall data set (1-based integer)
Required range:
x > 1The maximum number of response records on each page of results
Required range:
x > 1The total number of records in the entire matching data set
Required range:
x > 0List of member premiums
Total amount of the premium in USD
List of member enrollments that constitute the premium amount
Line of coverage for the billed group plan
Available options:
medical, dental, vision, life, add, std, ltd, accident, critical_illness, cancer, hospital_indemnity Unique ID of the billed member in Noyo
Type of member for the billed premium
Available options:
dependent, employee Unique identifier of the billed group plan in Noyo
Unique ID of the carrier in Noyo
The date the record was created
ISO-8601 date string for the effective start date of the premium
Unique identifier of the record in Noyo
The date the record was last updated
Premium type, either the total premium, or just the employer-paid or employee-paid portion
Available options:
total_amount, employer_amount, employee_amount Current version of the record
ISO-8601 date string for the effective end date of the premium
Was this page helpful?
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"
}
]
}