/employer-benefits

Returns a list of EmployerBenefit objects.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Query parameters

created_afterdatetimeOptional

If provided, will only return objects created after this datetime.

created_beforedatetimeOptional

If provided, will only return objects created before this datetime.

cursorstringOptional

The pagination cursor value.

include_deleted_databooleanOptional

Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.

include_remote_databooleanOptional

Whether to include the original data Merge fetched from the third-party to produce these models.

include_shell_databooleanOptional

Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

modified_afterdatetimeOptional

If provided, only objects synced by Merge after this date time will be returned.

modified_beforedatetimeOptional

If provided, only objects synced by Merge before this date time will be returned.

page_sizeintegerOptional

Number of results to return per page. The maximum limit is 100.

remote_idstringOptional

The API provider's ID for the given object.

Response

nextstring or null

previousstring or null

resultslist of objects or null

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

benefit_plan_typeenum or nullOptional

The type of benefit plan.

MEDICAL - MEDICAL
HEALTH_SAVINGS - HEALTH_SAVINGS
INSURANCE - INSURANCE
RETIREMENT - RETIREMENT
OTHER - OTHER

Allowed values:

namestring or nullOptional<=200 characters

The employer benefit’s name - typically the carrier or network name.

descriptionstring or nullOptional<=2000 characters

The employer benefit's description.

deduction_codestring or nullOptional<=60 characters

The employer benefit's deduction code.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

benefit_plan_typeenum or nullOptional

The type of benefit plan.

MEDICAL - MEDICAL
HEALTH_SAVINGS - HEALTH_SAVINGS
INSURANCE - INSURANCE
RETIREMENT - RETIREMENT
OTHER - OTHER

Allowed values:

namestring or nullOptional<=200 characters

The employer benefit’s name - typically the carrier or network name.

deduction_codestring or nullOptional<=60 characters

The employer benefit's deduction code.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

benefit_plan_typeenum or nullOptional

The type of benefit plan.

MEDICAL - MEDICAL
HEALTH_SAVINGS - HEALTH_SAVINGS
INSURANCE - INSURANCE
RETIREMENT - RETIREMENT
OTHER - OTHER

Allowed values:

namestring or nullOptional<=200 characters

The employer benefit’s name - typically the carrier or network name.

descriptionstring or nullOptional<=2000 characters

The employer benefit's description.

deduction_codestring or nullOptional<=60 characters

The employer benefit's deduction code.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

benefit_plan_typeenum or nullOptional

The type of benefit plan.

MEDICAL - MEDICAL
HEALTH_SAVINGS - HEALTH_SAVINGS
INSURANCE - INSURANCE
RETIREMENT - RETIREMENT
OTHER - OTHER

Allowed values:

namestring or nullOptional<=200 characters

The employer benefit’s name - typically the carrier or network name.

deduction_codestring or nullOptional<=60 characters

The employer benefit's deduction code.

remote_datalist of objects or nullOptionalRead-only

1	using Merge.Client.Hris;
2	using Merge.Client;
3
4	var client = new MergeClient("API_KEY");
5	var items = await client.Hris.EmployerBenefits.ListAsync(
6	new EmployerBenefitsListRequest
7	{
8	CreatedAfter = new DateTime(2024, 01, 15, 09, 30, 00, 000),
9	CreatedBefore = new DateTime(2024, 01, 15, 09, 30, 00, 000),
10	Cursor = "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
11	IncludeDeletedData = true,
12	IncludeRemoteData = true,
13	IncludeShellData = true,
14	ModifiedAfter = new DateTime(2024, 01, 15, 09, 30, 00, 000),
15	ModifiedBefore = new DateTime(2024, 01, 15, 09, 30, 00, 000),
16	PageSize = 1,
17	RemoteId = "remote_id",
18	}
19	);
20
21	await foreach (var item in items)
22	{
23	// do something with item
24	}

1	{
2	"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
3	"previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
4	"results": [
5	{
6	"id": "025fjlc6-6000-430a-848e-aafacbadf4fele",
7	"remote_id": "19202939",
8	"created_at": "2021-09-15T00:00:00Z",
9	"modified_at": "2021-10-16T00:00:00Z",
10	"benefit_plan_type": "MEDICAL",
11	"name": "Kaiser Permanente Medical Plan",
12	"description": "HDHP Silver Plan",
13	"deduction_code": "COL",
14	"remote_was_deleted": true,
15	"field_mappings": {
16	"organization_defined_targets": {
17	"custom_key": "custom_value"
18	},
19	"linked_account_defined_targets": {
20	"custom_key": "custom_value"
21	}
22	},
23	"remote_data": [
24	{
25	"path": "/platform-endpoint"
26	}
27	]
28	}
29	]
30	}

/employer-benefits

Authentication

Headers

Query parameters

Response

Field support by integration

Field support by integration