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[]RemoteData
object is used to represent the full data pulled from the third-party API for an object.path
Stringdata
Anyhttps://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
Booleaninclude_shell_data
Booleanmodified_after
DateTime (ISO 8601)modified_before
DateTime (ISO 8601)page_size
Integerremote_id
String
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)
Supported Response Fields
benefit_plan_type
Stringemployee
UUIDend_date
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringstart_date
DateTime (ISO 8601)
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)
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)
Supported Response Fields
benefit_plan_type
Stringcompany_contribution
Numberemployee
UUIDemployee_contribution
Numberemployer_benefit
UUIDprovider_name
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
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)
Supported Response Fields
employee
UUIDprovider_name
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
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)
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)
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)
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
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)
Supported Response Fields
benefit_plan_type
Stringemployee
UUIDend_date
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringstart_date
DateTime (ISO 8601)
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)
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)
Supported Response Fields
benefit_plan_type
Stringcompany_contribution
Numberemployee
UUIDemployee_contribution
Numberemployer_benefit
UUIDprovider_name
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
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)
Supported Response Fields
employee
UUIDprovider_name
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
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)
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)
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)
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)