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 EmployerBenefit object
          • GET/employer-benefits
          • GET/employer-benefits/{id}
UnifiedAgent HandlerGateway
UnifiedAgent HandlerGateway
Resources
Log inGet a demo
Common ModelsEmployer benefits

The EmployerBenefit object

The EmployerBenefit 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  "benefit_plan_type": "MEDICAL",
7  "name": "string",
8  "description": "string",
9  "deduction_code": "string",
10  "remote_was_deleted": true,
11  "field_mappings": {},
12  "remote_data": [
13    {
14      "path": "string",
15      "data": {}
16    }
17  ]
18}
Was this page helpful?
Previous

/employees/meta/post

Next

/employer-benefits

Built with

The Employer Benefit object is used to represent a benefit plan offered by a company.

idstringOptionalRead-onlyformat: "uuid"
remote_idstring or nullOptional
created_atdatetimeOptionalRead-only
The datetime that this object was created by Merge.
modified_atdatetimeOptionalRead-only
The datetime that this object was modified by Merge.
benefit_plan_typeenum or nullOptional
Allowed values:
namestring or nullOptional<=200 characters
descriptionstring or nullOptional<=2000 characters
The employer benefit's description.
deduction_codestring or nullOptional<=60 characters
The employer benefit's deduction code.
remote_was_deletedbooleanOptionalRead-only
field_mappingsobject or nullOptionalRead-only
remote_datalist of objects or nullOptionalRead-only