API Reference MergeHRISClient v1.0.2

Modules

API calls for all endpoints tagged AccountDetails.

API calls for all endpoints tagged AccountToken.

API calls for all endpoints tagged AvailableActions.

API calls for all endpoints tagged BankInfo.

API calls for all endpoints tagged Benefits.

API calls for all endpoints tagged Companies.

API calls for all endpoints tagged Deductions.

API calls for all endpoints tagged DeleteAccount.

API calls for all endpoints tagged EmployeePayrollRuns.

API calls for all endpoints tagged Employees.

API calls for all endpoints tagged Employments.

API calls for all endpoints tagged ForceResync.

API calls for all endpoints tagged GenerateKey.

API calls for all endpoints tagged Issues.

API calls for all endpoints tagged LinkToken.

API calls for all endpoints tagged LinkedAccounts.

API calls for all endpoints tagged Locations.

API calls for all endpoints tagged Passthrough.

API calls for all endpoints tagged PayGroups.

API calls for all endpoints tagged PayrollRuns.

API calls for all endpoints tagged RegenerateKey.

API calls for all endpoints tagged SyncStatus.

API calls for all endpoints tagged Teams.

API calls for all endpoints tagged TimeOff.

API calls for all endpoints tagged TimeOffBalances.

Handle Tesla connections for MergeHRISClient.

Helper functions for deserializing responses into models

The LinkedAccount Object ### Description The LinkedAccount object is used to represent an end user's link with a specific integration. ### Usage Example View a list of your organization's LinkedAccount objects.

The AvailableActions Object ### Description The Activity object is used to see all available model/operation combinations for an integration. ### Usage Example Fetch all the actions available for the Zenefits integration.

The BankInfo Object ### Description The BankInfo object is used to represent the Bank Account information for an Employee. This is often referenced with an Employee object. ### Usage Example Fetch from the LIST BankInfo endpoint and filter by ID to show all bank information.

The Benefit Object ### Description The Benefit object is used to represent a Benefit for an employee. ### Usage Example Fetch from the LIST Benefits endpoint and filter by ID to show all benefits.

The Company Object ### Description The Company object is used to represent a Company. ### Usage Example Fetch from the LIST Companies endpoint and filter by ID to show all companies.

The DataPassthrough Object ### Description The DataPassthrough object is used to send information to an otherwise-unsupported third-party endpoint. ### Usage Example Create a DataPassthrough to get team hierarchies from your Rippling integration.

The Deduction Object ### Description The Deduction object is used to represent a deduction for a given employee's payroll run. One run could include several deductions. ### Usage Example Fetch from the LIST Deductions endpoint and filter by ID to show all deductions.

The Earning Object ### Description The Earning object is used to represent an earning for a given employee's payroll run. One run could include several earnings. ### Usage Example Fetch from the LIST Earnings endpoint and filter by ID to show all earnings.

The Employee Object ### Description The Employee object is used to represent an Employee for a company. ### Usage Example Fetch from the LIST Employee endpoint and filter by ID to show all employees.

The EmployeePayrollRun Object ### Description The EmployeePayrollRun object is used to represent a payroll run for a specific employee. ### Usage Example Fetch from the LIST EmployeePayrollRun endpoint and filter by ID to show all employee payroll runs.

The Employment Object ### Description The Employment object is used to represent an employment position at a company. These are associated with the employee filling the role. ### Usage Example Fetch from the LIST Employments endpoint and filter by ID to show all employees.

The GenerateRemoteKey Object ### Description The GenerateRemoteKey object is used to represent a request for a new remote key. ### Usage Example Post a GenerateRemoteKey to create a new remote key.

The Location Object ### Description The Location object is used to represent a Location for a Company or Employee address. This is shared across many models and is referenced whenever a location is stored. ### Usage Example Fetch from the LIST Locations endpoint and filter by ID to show all office locations.

The ModelOperation Object ### Description The ModelOperation object is used to represent the operations that are currently supported for a given model. ### Usage Example View what operations are supported for the Candidate endpoint.

The PayGroup Object ### Description The PayGroup object is used to represent Pay Group information that employees belong to. This is often referenced with an Employee object. ### Usage Example Fetch from the LIST PayGroup endpoint and filter by ID to show all pay group information.

The PayrollRun Object ### Description The PayrollRun object is used to represent a payroll run. ### Usage Example Fetch from the LIST PayrollRuns endpoint and filter by ID to show all payroll runs.

The RemoteKey Object ### Description The RemoteKey object is used to represent a request for a new remote key. ### Usage Example Post a GenerateRemoteKey to receive a new RemoteKey.

The RemoteKeyForRegeneration Object ### Description The RemoteKeyForRegeneration object is used to exchange an old remote key for a new one ### Usage Example Post a RemoteKeyForRegeneration to swap out an old remote key for a new one

The RemoteResponse Object ### Description The RemoteResponse object is used to represent information returned from a third-party endpoint. ### Usage Example View the RemoteResponse returned from your DataPassthrough.

The SyncStatus Object ### Description The SyncStatus object is used to represent the syncing state of an account ### Usage Example View the SyncStatus for an account to see how recently its models were synced.

The Tax Object ### Description The Tax object is used to represent a tax for a given employee's payroll run. One run could include several taxes. ### Usage Example Fetch from the LIST Taxes endpoint and filter by ID to show all taxes.

The Team Object ### Description The Team object is used to represent a Team within a company. Employee objects are often grouped this way. Note that in the Merge HRIS API, company subdivisions are all represented with Teams, rather than Teams and Departments. ### Usage Example If you're building a way to filter by Team, you'd hit the GET Teams endpoint to fetch the Teams, and then use the ID of the team your user selects to filter the GET Employees endpoint.

The TimeOff Object ### Description The TimeOff object is used to represent a Time Off Request filed by an employee. ### Usage Example Fetch from the LIST TimeOffs endpoint and filter by ID to show all time off requests.

The TimeOffBalance Object ### Description The TimeOffBalance object is used to represent a Time Off Balance for an employee. ### Usage Example Fetch from the LIST TimeOffBalances endpoint and filter by ID to show all time off balances.

The TimeOff Object ### Description The TimeOff object is used to represent a Time Off Request filed by an employee. ### Usage Example Fetch from the LIST TimeOffs endpoint and filter by ID to show all time off requests.

Helper functions for building Tesla requests