EmployeesApi

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

Method	HTTP request	Description
employeesCreate	POST /employees
employeesIgnoreCreate	POST /employees/ignore/{model_id}
employeesList	GET /employees
employeesMetaPostRetrieve	GET /employees/meta/post
employeesRetrieve	GET /employees/{id}

employeesCreate

EmployeeResponse employeesCreate(xAccountToken, employeeEndpointRequest, isDebugMode, runAsync)

Creates an `Employee` object with the given values.

Example

// 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.EmployeesApi;

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");

    EmployeesApi apiInstance = new EmployeesApi(defaultClient);
    String xAccountToken = "xAccountToken_example"; // String | Token identifying the end user.
    EmployeeEndpointRequest employeeEndpointRequest = new EmployeeEndpointRequest(); // EmployeeEndpointRequest | 
    Boolean isDebugMode = true; // Boolean | Whether to include debug fields (such as log file links) in the response.
    Boolean runAsync = true; // Boolean | Whether or not third-party updates should be run asynchronously.
    try {
      EmployeeResponse result = apiInstance.employeesCreate(xAccountToken, employeeEndpointRequest, isDebugMode, runAsync);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling EmployeesApi#employeesCreate");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
xAccountToken	String	Token identifying the end user.
employeeEndpointRequest	EmployeeEndpointRequest
isDebugMode	Boolean	Whether to include debug fields (such as log file links) in the response.	[optional]
runAsync	Boolean	Whether or not third-party updates should be run asynchronously.	[optional]

Return type

EmployeeResponse

Authorization

tokenAuth

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
Accept: application/json

HTTP response details

Status code	Description	Response headers
201		-

employeesIgnoreCreate

IgnoreCommonModel employeesIgnoreCreate(xAccountToken, modelId, ignoreCommonModelRequest)

Ignores a specific row based on the `model_id` in the url. These records will have their properties set to null, and will not be updated in future syncs. The "reason" and "message" fields in the request body will be stored for audit purposes.

Example

// 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.EmployeesApi;

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");

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

Parameters

Name	Type	Description
xAccountToken	String	Token identifying the end user.
modelId	UUID
ignoreCommonModelRequest	IgnoreCommonModelRequest

Return type

IgnoreCommonModel

Authorization

tokenAuth

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

employeesList

PaginatedEmployeeList employeesList(xAccountToken, companyId, createdAfter, createdBefore, cursor, includeDeletedData, includeRemoteData, includeSensitiveFields, managerId, modifiedAfter, modifiedBefore, pageSize, payGroupId, personalEmail, remoteId, teamId, workEmail, workLocationId)

Returns a list of `Employee` objects.

Example

// 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.EmployeesApi;

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");

    EmployeesApi apiInstance = new EmployeesApi(defaultClient);
    String xAccountToken = "xAccountToken_example"; // String | Token identifying the end user.
    String companyId = "companyId_example"; // String | If provided, will only return employees for this company.
    OffsetDateTime createdAfter = OffsetDateTime.now(); // OffsetDateTime | If provided, will only return objects created after this datetime.
    OffsetDateTime createdBefore = OffsetDateTime.now(); // OffsetDateTime | If provided, will only return objects created before this datetime.
    String cursor = "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"; // String | The pagination cursor value.
    Boolean includeDeletedData = true; // Boolean | Whether to include data that was deleted in the third-party service.
    Boolean includeRemoteData = true; // Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
    Boolean includeSensitiveFields = true; // Boolean | Whether to include sensitive fields (such as social security numbers) in the response.
    String managerId = "managerId_example"; // String | If provided, will only return employees for this manager.
    OffsetDateTime modifiedAfter = OffsetDateTime.now(); // OffsetDateTime | If provided, will only return objects modified after this datetime.
    OffsetDateTime modifiedBefore = OffsetDateTime.now(); // OffsetDateTime | If provided, will only return objects modified before this datetime.
    Integer pageSize = 56; // Integer | Number of results to return per page.
    String payGroupId = "payGroupId_example"; // String | If provided, will only return employees for this pay group
    String personalEmail = "personalEmail_example"; // String | If provided, will only return Employees with this personal email
    String remoteId = "remoteId_example"; // String | The API provider's ID for the given object.
    String teamId = "teamId_example"; // String | If provided, will only return employees for this team.
    String workEmail = "workEmail_example"; // String | If provided, will only return Employees with this work email
    String workLocationId = "workLocationId_example"; // String | If provided, will only return employees for this location.
    try {
      PaginatedEmployeeList result = apiInstance.employeesList(xAccountToken, companyId, createdAfter, createdBefore, cursor, includeDeletedData, includeRemoteData, includeSensitiveFields, managerId, modifiedAfter, modifiedBefore, pageSize, payGroupId, personalEmail, remoteId, teamId, workEmail, workLocationId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling EmployeesApi#employeesList");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
xAccountToken	String	Token identifying the end user.
companyId	String	If provided, will only return employees for this company.	[optional]
createdAfter	OffsetDateTime	If provided, will only return objects created after this datetime.	[optional]
createdBefore	OffsetDateTime	If provided, will only return objects created before this datetime.	[optional]
cursor	String	The pagination cursor value.	[optional]
includeDeletedData	Boolean	Whether to include data that was deleted in the third-party service.	[optional]
includeRemoteData	Boolean	Whether to include the original data Merge fetched from the third-party to produce these models.	[optional]
includeSensitiveFields	Boolean	Whether to include sensitive fields (such as social security numbers) in the response.	[optional]
managerId	String	If provided, will only return employees for this manager.	[optional]
modifiedAfter	OffsetDateTime	If provided, will only return objects modified after this datetime.	[optional]
modifiedBefore	OffsetDateTime	If provided, will only return objects modified before this datetime.	[optional]
pageSize	Integer	Number of results to return per page.	[optional]
payGroupId	String	If provided, will only return employees for this pay group	[optional]
personalEmail	String	If provided, will only return Employees with this personal email	[optional]
remoteId	String	The API provider's ID for the given object.	[optional]
teamId	String	If provided, will only return employees for this team.	[optional]
workEmail	String	If provided, will only return Employees with this work email	[optional]
workLocationId	String	If provided, will only return employees for this location.	[optional]

Return type

PaginatedEmployeeList

Authorization

tokenAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

employeesMetaPostRetrieve

MetaResponse employeesMetaPostRetrieve(xAccountToken)

Returns metadata for `Employee` POSTs.

Example

// 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.EmployeesApi;

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");

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

Parameters

Name	Type	Description	Notes
xAccountToken	String	Token identifying the end user.

Return type

MetaResponse

Authorization

tokenAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

employeesRetrieve

Employee employeesRetrieve(xAccountToken, id, includeRemoteData, includeSensitiveFields)

Returns an `Employee` object with the given `id`.

Example

// 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.EmployeesApi;

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");

    EmployeesApi apiInstance = new EmployeesApi(defaultClient);
    String xAccountToken = "xAccountToken_example"; // String | Token identifying the end user.
    UUID id = new UUID(); // UUID | 
    Boolean includeRemoteData = true; // Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
    Boolean includeSensitiveFields = true; // Boolean | Whether to include sensitive fields (such as social security numbers) in the response.
    try {
      Employee result = apiInstance.employeesRetrieve(xAccountToken, id, includeRemoteData, includeSensitiveFields);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling EmployeesApi#employeesRetrieve");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
xAccountToken	String	Token identifying the end user.
id	UUID
includeRemoteData	Boolean	Whether to include the original data Merge fetched from the third-party to produce these models.	[optional]
includeSensitiveFields	Boolean	Whether to include sensitive fields (such as social security numbers) in the response.	[optional]

Return type

Employee

Authorization

tokenAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

Files

EmployeesApi.md

Latest commit

History

EmployeesApi.md

File metadata and controls

EmployeesApi

employeesCreate

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

employeesIgnoreCreate

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

employeesList

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

employeesMetaPostRetrieve

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

employeesRetrieve

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details