For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Logo
Resources
Log inGet a demo
Get startedAPI referenceImplementation
Get startedAPI referenceImplementation
    • Overview
          • The Benefit object
          • GET/benefits
          • GET/benefits/{id}
UnifiedAgent HandlerGateway
UnifiedAgent HandlerGateway
Resources
Log inGet a demo
Common ModelsBenefits

The Benefit object

The Benefit Object
1{
2  "id": "string",
3  "remote_id": "string",
4  "created_at": "2023-01-01T00:00:00Z",
5  "modified_at": "2023-01-01T00:00:00Z",
6  "employee": "string",
7  "provider_name": "string",
8  "benefit_plan_type": "string",
9  "employee_contribution": 1,
10  "company_contribution": 1,
11  "start_date": "2023-01-01T00:00:00Z",
12  "end_date": "2023-01-01T00:00:00Z",
13  "employer_benefit": "string",
14  "remote_was_deleted": true,
15  "field_mappings": {},
16  "remote_data": [
17    {
18      "path": "string",
19      "data": {}
20    }
21  ]
22}
Was this page helpful?
Previous

/bank-info/{id}

Next

/benefits

Built with

The Benefit object is used to represent a benefit that an employee has enrolled in.

idstringOptionalRead-onlyformat: "uuid"
remote_idstring or nullOptional

The third-party API ID of the matching object.

created_atdatetimeOptionalRead-only
The datetime that this object was created by Merge.
modified_atdatetimeOptionalRead-only
The datetime that this object was modified by Merge.
employeestring or nullOptionalformat: "uuid"
The employee on the plan.
provider_namestring or nullOptional
The name of the benefit provider.
employee_contributiondouble or nullOptional
The employee's contribution.
company_contributiondouble or nullOptional
The company's contribution.
start_datedatetime or nullOptional
The day and time the benefit started.
end_datedatetime or nullOptional
The day and time the benefit ended.
employer_benefitstring or nullOptionalformat: "uuid"
The employer benefit plan the employee is enrolled in.
remote_was_deletedbooleanOptionalRead-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 nullOptionalRead-only
remote_datalist of objects or nullOptionalRead-only
benefit_plan_typestring or nullOptionalDeprecated
The type of benefit plan