Merge · Schema

EmployerBenefit

# The EmployerBenefit Object ### Description The `Employer Benefit` object is used to represent a benefit plan offered by a company. ### Usage Example Fetch from the `LIST EmployerBenefits` endpoint and filter by `ID` to show all EmployerBenefits.

IntegrationsPlatformUnified APIAgent HandlerLLM Gateway

Properties

Name	Type	Description
id	string
remote_id	stringnull	The third-party API ID of the matching object.
created_at	string	The datetime that this object was created by Merge.
modified_at	string	The datetime that this object was modified by Merge.
benefit_plan_type	object	The type of benefit plan.
name	stringnull	The employer benefit's name - typically the carrier or network name.
description	stringnull	The employer benefit's description.
deduction_code	stringnull	The employer benefit's deduction code.
remote_was_deleted	boolean	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 cove
field_mappings	object
remote_data	arraynull

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/EmployerBenefit",
  "title": "EmployerBenefit",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "remote_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "The third-party API ID of the matching object."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "The datetime that this object was created by Merge."
    },
    "modified_at": {
      "type": "string",
      "format": "date-time",
      "description": "The datetime that this object was modified by Merge."
    },
    "benefit_plan_type": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/BenefitPlanTypeEnum"
        },
        {
          "type": "null"
        }
      ],
      "description": "The type of benefit plan."
    },
    "name": {
      "type": [
        "string",
        "null"
      ],
      "description": "The employer benefit's name - typically the carrier or network name."
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "description": "The employer benefit's description."
    },
    "deduction_code": {
      "type": [
        "string",
        "null"
      ],
      "description": "The employer benefit's deduction code."
    },
    "remote_was_deleted": {
      "type": "boolean",
      "description": "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](https://docs.merge.dev/integrations/hris/supported-features/)."
    },
    "field_mappings": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/EmployerBenefitFieldMappings"
        },
        {
          "type": "null"
        }
      ]
    },
    "remote_data": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "#/components/schemas/RemoteData"
      }
    }
  },
  "description": "# The EmployerBenefit Object\n### Description\nThe `Employer Benefit` object is used to represent a benefit plan offered by a company.\n\n### Usage Example\nFetch from the `LIST EmployerBenefits` endpoint and filter by `ID` to show all EmployerBenefits."
}