Deprecation Notice

Merge has released a new version of our Java SDK. As part of that release, we are providing a deprecation notice of our legacy SDKs.

To help give you time to plan your migration to our latest SDK:

• August 2023: SDK deprecation notice on our legacy Java SDKs.
• Until February 2024: we’ll support updates as needed and address bugs in priority order
• After February 2024: we’ll no longer make updates or bug fixes to the deprecated SDKs

For information about the deprecation notice see our help center and for information about migrating to the Java SDK, see the Java Migration Guide.

merge-hris-client

Merge HRIS API

• API version: 1.0
  • Build date: 2023-07-20T10:57:27.935941Z[Etc/UTC]

The unified API for building rich integrations with multiple HR Information System platforms.

For more information, please visit https://www.merge.dev/

Automatically generated by the OpenAPI Generator

Requirements

Building the API client library requires:

1. Java 1.7+
2. Maven/Gradle

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>dev.merge.hris</groupId>
  <artifactId>merge-hris-client</artifactId>
  <version>1.4.2</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

compile "dev.merge.hris:merge-hris-client:1.4.2"

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

• target/merge-hris-client-1.4.2.jar
• target/lib/*.jar

Getting Started

Please follow the installation instruction and execute the following Java code:

// Import classes:
import merge_hris_client.ApiClient;
import merge_hris_client.ApiException;
import merge_hris_client.Configuration;
import merge_hris_client.auth.*;
import merge_hris_client.models.*;
import merge_hris_client.api.AccountDetailsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.merge.dev/api/hris/v1");
    
    // Configure API key authorization: tokenAuth
    ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
    tokenAuth.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //tokenAuth.setApiKeyPrefix("Token");

    AccountDetailsApi apiInstance = new AccountDetailsApi(defaultClient);
    String xAccountToken = "xAccountToken_example"; // String | Token identifying the end user.
    try {
      AccountDetails result = apiInstance.accountDetailsRetrieve(xAccountToken);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling AccountDetailsApi#accountDetailsRetrieve");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Documentation for API Endpoints

All URIs are relative to https://api.merge.dev/api/hris/v1

Class	Method	HTTP request	Description
AccountDetailsApi	accountDetailsRetrieve	GET /account-details
AccountTokenApi	accountTokenRetrieve	GET /account-token/{public_token}
AvailableActionsApi	availableActionsRetrieve	GET /available-actions
BankInfoApi	bankInfoList	GET /bank-info
BankInfoApi	bankInfoRetrieve	GET /bank-info/{id}
BenefitsApi	benefitsList	GET /benefits
BenefitsApi	benefitsRetrieve	GET /benefits/{id}
CompaniesApi	companiesList	GET /companies
CompaniesApi	companiesRetrieve	GET /companies/{id}
DeductionsApi	deductionsList	GET /deductions
DeductionsApi	deductionsRetrieve	GET /deductions/{id}
DeleteAccountApi	deleteAccountCreate	POST /delete-account
EmployeePayrollRunsApi	employeePayrollRunsList	GET /employee-payroll-runs
EmployeePayrollRunsApi	employeePayrollRunsRetrieve	GET /employee-payroll-runs/{id}
EmployeesApi	employeesCreate	POST /employees
EmployeesApi	employeesIgnoreCreate	POST /employees/ignore/{model_id}
EmployeesApi	employeesList	GET /employees
EmployeesApi	employeesMetaPostRetrieve	GET /employees/meta/post
EmployeesApi	employeesRetrieve	GET /employees/{id}
EmploymentsApi	employmentsList	GET /employments
EmploymentsApi	employmentsRetrieve	GET /employments/{id}
ForceResyncApi	syncStatusResyncCreate	POST /sync-status/resync
GenerateKeyApi	generateKeyCreate	POST /generate-key
GroupsApi	groupsList	GET /groups
GroupsApi	groupsRetrieve	GET /groups/{id}
IssuesApi	issuesList	GET /issues
IssuesApi	issuesRetrieve	GET /issues/{id}
LinkTokenApi	linkTokenCreate	POST /link-token
LinkedAccountsApi	linkedAccountsList	GET /linked-accounts
LocationsApi	locationsList	GET /locations
LocationsApi	locationsRetrieve	GET /locations/{id}
PassthroughApi	passthroughCreate	POST /passthrough
PayGroupsApi	payGroupsList	GET /pay-groups
PayGroupsApi	payGroupsRetrieve	GET /pay-groups/{id}
PayrollRunsApi	payrollRunsList	GET /payroll-runs
PayrollRunsApi	payrollRunsRetrieve	GET /payroll-runs/{id}
RegenerateKeyApi	regenerateKeyCreate	POST /regenerate-key
SyncStatusApi	syncStatusList	GET /sync-status
TeamsApi	teamsList	GET /teams
TeamsApi	teamsRetrieve	GET /teams/{id}
TimeOffApi	timeOffCreate	POST /time-off
TimeOffApi	timeOffList	GET /time-off
TimeOffApi	timeOffMetaPostRetrieve	GET /time-off/meta/post
TimeOffApi	timeOffRetrieve	GET /time-off/{id}
TimeOffBalancesApi	timeOffBalancesList	GET /time-off-balances
TimeOffBalancesApi	timeOffBalancesRetrieve	GET /time-off-balances/{id}
WebhookReceiversApi	webhookReceiversCreate	POST /webhook-receivers
WebhookReceiversApi	webhookReceiversList	GET /webhook-receivers

Documentation for Models

• AccountDetails
• AccountDetailsAndActions
• AccountDetailsAndActionsIntegration
• AccountDetailsAndActionsStatusEnum
• AccountIntegration
• AccountToken
• AccountTypeEnum
• AvailableActions
• BankInfo
• Benefit
• CategoriesEnum
• CategoryEnum
• Company
• CountryEnum
• DataPassthroughRequest
• DebugModeLog
• DebugModelLogSummary
• Deduction
• Earning
• EarningTypeEnum
• Employee
• EmployeeEndpointRequest
• EmployeePayrollRun
• EmployeeRequest
• EmployeeResponse
• Employment
• EmploymentStatusEnum
• EmploymentTypeEnum
• EncodingEnum
• EndUserDetailsRequest
• ErrorValidationProblem
• EthnicityEnum
• FlsaStatusEnum
• GenderEnum
• GenerateRemoteKeyRequest
• Group
• GroupTypeEnum
• IgnoreCommonModel
• IgnoreCommonModelRequest
• Issue
• IssueStatusEnum
• LinkToken
• LinkedAccountStatus
• Location
• LocationTypeEnum
• MaritalStatusEnum
• MetaResponse
• MethodEnum
• ModelOperation
• MultipartFormFieldRequest
• PaginatedAccountDetailsAndActionsList
• PaginatedBankInfoList
• PaginatedBenefitList
• PaginatedCompanyList
• PaginatedDeductionList
• PaginatedEmployeeList
• PaginatedEmployeePayrollRunList
• PaginatedEmploymentList
• PaginatedGroupList
• PaginatedIssueList
• PaginatedLocationList
• PaginatedPayGroupList
• PaginatedPayrollRunList
• PaginatedSyncStatusList
• PaginatedTeamList
• PaginatedTimeOffBalanceList
• PaginatedTimeOffList
• PayCurrencyEnum
• PayFrequencyEnum
• PayGroup
• PayPeriodEnum
• PayrollRun
• PolicyTypeEnum
• ReasonEnum
• RemoteData
• RemoteDataRequest
• RemoteKey
• RemoteKeyForRegenerationRequest
• RemoteResponse
• RequestFormatEnum
• RequestTypeEnum
• RunStateEnum
• RunTypeEnum
• SyncStatus
• SyncStatusStatusEnum
• Tax
• Team
• TimeOff
• TimeOffBalance
• TimeOffEndpointRequest
• TimeOffRequest
• TimeOffResponse
• TimeOffStatusEnum
• UnitsEnum
• ValidationProblemSource
• WarningValidationProblem
• WebhookReceiver
• WebhookReceiverRequest

Documentation for Authorization

Authentication schemes defined for the API:

tokenAuth

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author

[email protected]