/employer-benefits/{id}

Returns an EmployerBenefit object with the given id.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Path parameters

idstringRequiredformat: "uuid"

Query parameters

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).

Response

idstringRead-onlyformat: "uuid"

remote_idstring or null

The third-party API ID of the matching object.

created_atdatetimeRead-only

The datetime that this object was created by Merge.

modified_atdatetimeRead-only

The datetime that this object was modified by Merge.

benefit_plan_typeenum or null

The type of benefit plan.

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

The type of benefit plan. * `MEDICAL` - MEDICAL * `HEALTH_SAVINGS` - HEALTH_SAVINGS * `INSURANCE` - INSURANCE * `RETIREMENT` - RETIREMENT * `OTHER` - OTHER

Allowed values:

namestring or null<=200 characters

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

descriptionstring or null<=2000 characters

The employer benefit's description.

deduction_codestring or null<=60 characters

The employer benefit's deduction code.

remote_was_deletedbooleanRead-only

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.

field_mappingsobject or nullRead-only

remote_datalist of objects or nullRead-only

1	import { MergeClient } from "@mergeapi/merge-node-client";
2
3	const client = new MergeClient({ apiKey: "YOUR_API_KEY", accountToken: "YOUR_ACCOUNT_TOKEN" });
4	await client.hris.employerBenefits.retrieve("id", {
5	includeRemoteData: true,
6	includeShellData: true
7	});

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

/employer-benefits/{id}

Authentication

Path parameters

Headers

Query parameters

Response

Field support by integration