Benefits

The Benefit object is used to represent a benefit that an employee has enrolled in.

The Benefit object

Properties

idString
Required
remote_idString
Optional
The third-party API ID of the matching object.
employeeString
Optional
The employee on the plan.
provider_nameString
Optional
The name of the benefit provider.
benefit_plan_typeString
Optional
The type of benefit plan
employee_contributionNumber
Optional
The employee's contribution.
company_contributionNumber
Optional
The company's contribution.
remote_was_deletedBoolean
Required
Indicates whether or not this object has been deleted by third party webhooks.
field_mappingsObject
Optional
remote_dataRemoteData[]
Optional
The Benefit object
JSON
{
  "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
}
GET

/benefits

Returns a list of Benefit objects.


Header Parameters

AuthorizationString
Required
Token-based authentication with required prefix "Bearer"
X-Account-TokenString
Required
Token identifying the end user.

Query & Path Parameters

created_afterString
Optional
If provided, will only return objects created after this datetime.
created_beforeString
Optional
If provided, will only return objects created before this datetime.
cursorString
Optional
The pagination cursor value.
employee_idString
Optional
If provided, will return the benefits associated with the employee.
expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
include_deleted_dataBoolean
Optional
Whether to include data that was marked as deleted by third party webhooks.
include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
modified_afterString
Optional
If provided, will only return objects modified after this datetime.
modified_beforeString
Optional
If provided, will only return objects modified before this datetime.
page_sizeInteger
Optional
Number of results to return per page.
remote_idString
Optional
The API provider's ID for the given object.
Response
JSON
{
  "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
    }
  ]
}
Field support by platform

ADP Workforce Now

ADP Workforce Now

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

benefit_plan_typeString
company_contributionNumber
employeeString
employee_contributionNumber
provider_nameString
remote_dataRemoteData[]
pathstring
dataobject

Altera Payroll

Altera Payroll

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

benefit_plan_typeString
employeeString
remote_dataRemoteData[]
pathstring
dataobject

Breathe

Breathe

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

company_contributionNumber
employeeString
employee_contributionNumber
provider_nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

Gusto

Gusto

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

benefit_plan_typeString
company_contributionNumber
employeeString
employee_contributionNumber
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

HR Partner

HR Partner

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

benefit_plan_typeString
company_contributionNumber
employeeString
provider_nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

Paychex

Paychex

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

benefit_plan_typeString
company_contributionNumber
employeeString
employee_contributionNumber
remote_idString

Paylocity

Paylocity

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

benefit_plan_typeString
employeeString
employee_contributionNumber
remote_dataRemoteData[]
pathstring
dataobject

Rippling

Rippling

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

benefit_plan_typeString
company_contributionNumber
employeeString
employee_contributionNumber
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

UKG Pro

UKG Pro

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

benefit_plan_typeString
company_contributionNumber
employeeString
employee_contributionNumber
provider_nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

UKG Ready

UKG Ready

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

benefit_plan_typeString
company_contributionNumber
employeeString
employee_contributionNumber
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Not seeing a platform that you're looking for? Submit a request for it here.
Hint: Use the /linked-accounts endpoint to pull platform support information.
GET

/benefits/{id}

Returns a Benefit object with the given id.


Header Parameters

AuthorizationString
Required
Token-based authentication with required prefix "Bearer"
X-Account-TokenString
Required
Token identifying the end user.

Query & Path Parameters

expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
idString
Required
include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
Response
JSON
{
  "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
}
Field support by platform

ADP Workforce Now

ADP Workforce Now

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

benefit_plan_typeString
company_contributionNumber
employeeString
employee_contributionNumber
provider_nameString
remote_dataRemoteData[]
pathstring
dataobject

Altera Payroll

Altera Payroll

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

benefit_plan_typeString
employeeString
remote_dataRemoteData[]
pathstring
dataobject

Breathe

Breathe

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

company_contributionNumber
employeeString
employee_contributionNumber
provider_nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

Gusto

Gusto

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

benefit_plan_typeString
company_contributionNumber
employeeString
employee_contributionNumber
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

HR Partner

HR Partner

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

benefit_plan_typeString
company_contributionNumber
employeeString
provider_nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

Paychex

Paychex

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

benefit_plan_typeString
company_contributionNumber
employeeString
employee_contributionNumber
remote_idString

Paylocity

Paylocity

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

benefit_plan_typeString
employeeString
employee_contributionNumber
remote_dataRemoteData[]
pathstring
dataobject

Rippling

Rippling

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

benefit_plan_typeString
company_contributionNumber
employeeString
employee_contributionNumber
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

UKG Pro

UKG Pro

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

benefit_plan_typeString
company_contributionNumber
employeeString
employee_contributionNumber
provider_nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

UKG Ready

UKG Ready

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

benefit_plan_typeString
company_contributionNumber
employeeString
employee_contributionNumber
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Not seeing a platform that you're looking for? Submit a request for it here.
Hint: Use the /linked-accounts endpoint to pull platform support information.

Previous

Bank Info

Next Up

Companies