Benefits
TheBenefit
object is used to represent a benefit that an employee has enrolled in.The Benefit object
Properties
id
Stringremote_id
Stringemployee
Stringprovider_name
Stringbenefit_plan_type
Stringemployee_contribution
Numbercompany_contribution
Numberremote_was_deleted
Booleanfield_mappings
Objectremote_data
RemoteData[]{"id": "3fe5ae7a-f1ba-4529-b7af-84e86dc6d232","remote_id": "19202938","employee": "d2f972d0-2526-434b-9409-4c3b468e08f0","provider_name": "Blue Shield of California","benefit_plan_type": "MEDICAL","employee_contribution": 23.65,"company_contribution": 150,"remote_was_deleted": true,Show advanced fields}
/benefits
Returns a list of Benefit
objects.
Header Parameters
Authorization
StringX-Account-Token
StringQuery & Path Parameters
created_after
Stringcreated_before
Stringcursor
Stringemployee_id
Stringexpand
Stringinclude_deleted_data
Booleaninclude_remote_data
Booleanmodified_after
Stringmodified_before
Stringpage_size
Integerremote_id
String{"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw","previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ","results": [{"id": "3fe5ae7a-f1ba-4529-b7af-84e86dc6d232","remote_id": "19202938","employee": "d2f972d0-2526-434b-9409-4c3b468e08f0","provider_name": "Blue Shield of California","benefit_plan_type": "MEDICAL","employee_contribution": 23.65,"company_contribution": 150,"remote_was_deleted": true,Show advanced fields}]}

ADP Workforce Now
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
benefit_plan_type
Stringcompany_contribution
Numberemployee
Stringemployee_contribution
Numberprovider_name
Stringremote_data
RemoteData[]path
stringdata
object
Altera Payroll
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
benefit_plan_type
Stringemployee
Stringremote_data
RemoteData[]path
stringdata
object
Breathe
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
company_contribution
Numberemployee
Stringemployee_contribution
Numberprovider_name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Gusto
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
benefit_plan_type
Stringcompany_contribution
Numberemployee
Stringemployee_contribution
Numberremote_data
RemoteData[]path
stringdata
objectremote_id
String
HR Partner
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
benefit_plan_type
Stringcompany_contribution
Numberemployee
Stringprovider_name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Paychex
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
benefit_plan_type
Stringcompany_contribution
Numberemployee
Stringemployee_contribution
Numberremote_id
String
Paylocity
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
benefit_plan_type
Stringemployee
Stringemployee_contribution
Numberremote_data
RemoteData[]path
stringdata
object
Rippling
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
benefit_plan_type
Stringcompany_contribution
Numberemployee
Stringemployee_contribution
Numberremote_data
RemoteData[]path
stringdata
objectremote_id
String
UKG Pro
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
benefit_plan_type
Stringcompany_contribution
Numberemployee
Stringemployee_contribution
Numberprovider_name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
UKG Ready
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
benefit_plan_type
Stringcompany_contribution
Numberemployee
Stringemployee_contribution
Numberremote_data
RemoteData[]path
stringdata
objectremote_id
String/benefits/{id}
Returns a Benefit
object with the given id
.
Header Parameters
Authorization
StringX-Account-Token
StringQuery & Path Parameters
expand
Stringid
Stringinclude_remote_data
Boolean{"id": "3fe5ae7a-f1ba-4529-b7af-84e86dc6d232","remote_id": "19202938","employee": "d2f972d0-2526-434b-9409-4c3b468e08f0","provider_name": "Blue Shield of California","benefit_plan_type": "MEDICAL","employee_contribution": 23.65,"company_contribution": 150,"remote_was_deleted": true,Show advanced fields}

ADP Workforce Now
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
benefit_plan_type
Stringcompany_contribution
Numberemployee
Stringemployee_contribution
Numberprovider_name
Stringremote_data
RemoteData[]path
stringdata
object
Altera Payroll
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
benefit_plan_type
Stringemployee
Stringremote_data
RemoteData[]path
stringdata
object
Breathe
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
company_contribution
Numberemployee
Stringemployee_contribution
Numberprovider_name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Gusto
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
benefit_plan_type
Stringcompany_contribution
Numberemployee
Stringemployee_contribution
Numberremote_data
RemoteData[]path
stringdata
objectremote_id
String
HR Partner
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
benefit_plan_type
Stringcompany_contribution
Numberemployee
Stringprovider_name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Paychex
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
benefit_plan_type
Stringcompany_contribution
Numberemployee
Stringemployee_contribution
Numberremote_id
String
Paylocity
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
benefit_plan_type
Stringemployee
Stringemployee_contribution
Numberremote_data
RemoteData[]path
stringdata
object
Rippling
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
benefit_plan_type
Stringcompany_contribution
Numberemployee
Stringemployee_contribution
Numberremote_data
RemoteData[]path
stringdata
objectremote_id
String
UKG Pro
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
benefit_plan_type
Stringcompany_contribution
Numberemployee
Stringemployee_contribution
Numberprovider_name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
UKG Ready
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
benefit_plan_type
Stringcompany_contribution
Numberemployee
Stringemployee_contribution
Numberremote_data
RemoteData[]path
stringdata
objectremote_id
String