Benefit
object is used to represent a benefit that an employee has enrolled in.id
UUIDremote_id
Stringcreated_at
DateTime (ISO 8601)modified_at
DateTime (ISO 8601)employee
UUIDprovider_name
Stringbenefit_plan_type
StringDeprecatedThe benefit_plan_type
field on the Benefit
object is deprecated
employee_contribution
Numbercompany_contribution
Numberstart_date
DateTime (ISO 8601)end_date
DateTime (ISO 8601)remote_was_deleted
Booleanemployer_benefit
UUIDfield_mappings
Objectremote_data
RemoteData[]https://api.merge.dev/api/hris/v1/benefits
Returns a list of Benefit
objects.
created_after
DateTime (ISO 8601)created_before
DateTime (ISO 8601)cursor
Stringemployee_id
Stringexpand
Stringinclude_deleted_data
Booleaninclude_remote_data
Booleanmodified_after
DateTime (ISO 8601)modified_before
DateTime (ISO 8601)page_size
Integerremote_id
String![ADP Workforce Now](https://merge-api-production.s3.amazonaws.com/media/ADP_Square_Logo_GXCPXY1.jpg)
Supported Response Fields
benefit_plan_type
Stringcompany_contribution
Numberemployee
UUIDemployee_contribution
Numberemployer_benefit
UUIDend_date
DateTime (ISO 8601)provider_name
Stringremote_data
RemoteData[]path
stringdata
stringstart_date
DateTime (ISO 8601)![Altera Payroll](https://merge-api-production.s3.amazonaws.com/media/Altera_Square_Logo.png)
Supported Response Fields
benefit_plan_type
Stringemployee
UUIDend_date
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringstart_date
DateTime (ISO 8601)![BambooHR](https://merge-api-production.s3.amazonaws.com/media/BambooHR_Square_Logo.jpg)
Supported Response Fields
company_contribution
Numberemployee
UUIDemployee_contribution
Numberend_date
DateTime (ISO 8601)provider_name
Stringremote_data
RemoteData[]path
stringdata
stringstart_date
DateTime (ISO 8601)![Breathe](https://merge-api-production.s3.amazonaws.com/media/Breathe_Square_Logo_FY9Zgjm.jpg)
Supported Response Fields
company_contribution
Numberemployee
UUIDemployee_contribution
Numberend_date
DateTime (ISO 8601)provider_name
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_date
DateTime (ISO 8601)![](/static/b5d5c1854759bd0665de50ccff3750f5/35742/gusto_square_image.png)
Supported Response Fields
company_contribution
Numberemployee
UUIDemployee_contribution
Numberemployer_benefit
UUIDremote_id
String![HR Partner](https://merge-api-production.s3.amazonaws.com/media/HRPartner_Square_Logo.jpg)
Supported Response Fields
benefit_plan_type
Stringcompany_contribution
Numberemployee
UUIDend_date
DateTime (ISO 8601)provider_name
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_date
DateTime (ISO 8601)![OysterHR](https://merge-api-production.s3.amazonaws.com/media/Oyster_square.png)
Supported Response Fields
benefit_plan_type
Stringemployee
UUIDprovider_name
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String![Paychex](https://merge-api-production.s3.amazonaws.com/media/Paychex_Square_Logo.png)
Supported Response Fields
benefit_plan_type
Stringcompany_contribution
Numberemployee
UUIDemployee_contribution
Numberemployer_benefit
UUIDend_date
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_date
DateTime (ISO 8601)![Paylocity](https://merge-api-production.s3.amazonaws.com/media/Paylocity_Square_Logo_LGm1Fdn.png)
Supported Response Fields
benefit_plan_type
Stringemployee
UUIDemployee_contribution
Numberemployer_benefit
UUIDend_date
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringstart_date
DateTime (ISO 8601)![UKG Pro](https://merge-api-production.s3.amazonaws.com/media/UKG_Square_Logo_fl9LQnt.png)
Supported Response Fields
benefit_plan_type
Stringcompany_contribution
Numberemployee
UUIDemployee_contribution
Numberend_date
DateTime (ISO 8601)provider_name
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_date
DateTime (ISO 8601)![UKG Ready](https://merge-api-production.s3.amazonaws.com/media/UKG_Square_Logo_fl9LQnt_jYRGZr5.png)
Supported Response Fields
company_contribution
Numberemployee
UUIDemployee_contribution
Numberemployer_benefit
UUIDend_date
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_date
DateTime (ISO 8601)https://api.merge.dev/api/hris/v1/benefits/{id}
Returns a Benefit
object with the given id
.
expand
Stringid
UUIDinclude_remote_data
Boolean![ADP Workforce Now](https://merge-api-production.s3.amazonaws.com/media/ADP_Square_Logo_GXCPXY1.jpg)
Supported Response Fields
benefit_plan_type
Stringcompany_contribution
Numberemployee
UUIDemployee_contribution
Numberemployer_benefit
UUIDend_date
DateTime (ISO 8601)provider_name
Stringremote_data
RemoteData[]path
stringdata
stringstart_date
DateTime (ISO 8601)![Altera Payroll](https://merge-api-production.s3.amazonaws.com/media/Altera_Square_Logo.png)
Supported Response Fields
benefit_plan_type
Stringemployee
UUIDend_date
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringstart_date
DateTime (ISO 8601)![BambooHR](https://merge-api-production.s3.amazonaws.com/media/BambooHR_Square_Logo.jpg)
Supported Response Fields
company_contribution
Numberemployee
UUIDemployee_contribution
Numberend_date
DateTime (ISO 8601)provider_name
Stringremote_data
RemoteData[]path
stringdata
stringstart_date
DateTime (ISO 8601)![Breathe](https://merge-api-production.s3.amazonaws.com/media/Breathe_Square_Logo_FY9Zgjm.jpg)
Supported Response Fields
company_contribution
Numberemployee
UUIDemployee_contribution
Numberend_date
DateTime (ISO 8601)provider_name
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_date
DateTime (ISO 8601)![](/static/b5d5c1854759bd0665de50ccff3750f5/35742/gusto_square_image.png)
Supported Response Fields
company_contribution
Numberemployee
UUIDemployee_contribution
Numberemployer_benefit
UUIDremote_id
String![HR Partner](https://merge-api-production.s3.amazonaws.com/media/HRPartner_Square_Logo.jpg)
Supported Response Fields
benefit_plan_type
Stringcompany_contribution
Numberemployee
UUIDend_date
DateTime (ISO 8601)provider_name
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_date
DateTime (ISO 8601)![OysterHR](https://merge-api-production.s3.amazonaws.com/media/Oyster_square.png)
Supported Response Fields
benefit_plan_type
Stringemployee
UUIDprovider_name
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String![Paychex](https://merge-api-production.s3.amazonaws.com/media/Paychex_Square_Logo.png)
Supported Response Fields
benefit_plan_type
Stringcompany_contribution
Numberemployee
UUIDemployee_contribution
Numberemployer_benefit
UUIDend_date
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_date
DateTime (ISO 8601)![Paylocity](https://merge-api-production.s3.amazonaws.com/media/Paylocity_Square_Logo_LGm1Fdn.png)
Supported Response Fields
benefit_plan_type
Stringemployee
UUIDemployee_contribution
Numberemployer_benefit
UUIDend_date
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringstart_date
DateTime (ISO 8601)![UKG Pro](https://merge-api-production.s3.amazonaws.com/media/UKG_Square_Logo_fl9LQnt.png)
Supported Response Fields
benefit_plan_type
Stringcompany_contribution
Numberemployee
UUIDemployee_contribution
Numberend_date
DateTime (ISO 8601)provider_name
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_date
DateTime (ISO 8601)![UKG Ready](https://merge-api-production.s3.amazonaws.com/media/UKG_Square_Logo_fl9LQnt_jYRGZr5.png)
Supported Response Fields
company_contribution
Numberemployee
UUIDemployee_contribution
Numberemployer_benefit
UUIDend_date
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_date
DateTime (ISO 8601)