Merge.HRISClient 2.0.0

Merge.HRISClient - the C# library for the Merge HRIS API

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

This C# SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.0
• SDK version: 1.0.2
• Build package: org.openapitools.codegen.languages.CSharpNetCoreClientCodegen For more information, please visit https://www.merge.dev/

<a name="frameworks-supported"></a>

Frameworks supported

• .NET Core >=1.0
• .NET Framework >=4.6
• Mono/Xamarin >=vNext

<a name="dependencies"></a>

Dependencies

• RestSharp - 106.11.8-alpha.0.40 or later
• Json.NET - 12.0.3 or later
• JsonSubTypes - 1.8.0 or later
• System.ComponentModel.Annotations - 5.0.0 or later

The DLLs included in the package may not be the latest version. We recommend using NuGet to obtain the latest version of the packages:

Install-Package RestSharp
Install-Package Newtonsoft.Json
Install-Package JsonSubTypes
Install-Package System.ComponentModel.Annotations

NOTE: RestSharp versions greater than 105.1.0 have a bug which causes file uploads to fail. See RestSharp#742. NOTE: RestSharp for .Net Core creates a new socket for each api call, which can lead to a socket exhaustion problem. See RestSharp#1406.

<a name="installation"></a>

Installation

Generate the DLL using your preferred tool (e.g. dotnet build)

Then include the DLL (under the bin folder) in the C# project, and use the namespaces:

using Merge.HRISClient.Api;
using Merge.HRISClient.Client;
using Merge.HRISClient.Model;

<a name="usage"></a>

Usage

To use the API client with a HTTP proxy, setup a System.Net.WebProxy

Configuration c = new Configuration();
System.Net.WebProxy webProxy = new System.Net.WebProxy("http://myProxyUrl:80/");
webProxy.Credentials = System.Net.CredentialCache.DefaultCredentials;
c.Proxy = webProxy;

<a name="getting-started"></a>

Getting Started

using System.Collections.Generic;
using System.Diagnostics;
using Merge.HRISClient.Api;
using Merge.HRISClient.Client;
using Merge.HRISClient.Model;

namespace Example
{
    public class Example
    {
        public static void Main()
        {

            Configuration config = new Configuration();
            config.BasePath = "https://api.merge.dev/api/hris/v1";
            // Configure API key authorization: tokenAuth
            config.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new AccountDetailsApi(config);

            try
            {
                AccountDetails result = apiInstance.AccountDetailsRetrieve();
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling AccountDetailsApi.AccountDetailsRetrieve: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }

        }
    }
}

<a name="documentation-for-api-endpoints"></a>

Documentation for API Endpoints

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

<a name="documentation-for-models"></a>

Documentation for Models

• Model.AccountDetails
• Model.AccountDetailsAndActions
• Model.AccountDetailsAndActionsIntegration
• Model.AccountIntegration
• Model.AccountToken
• Model.AvailableActions
• Model.BankInfo
• Model.Benefit
• Model.CategoriesEnum
• Model.CategoryEnum
• Model.Company
• Model.CountryEnum
• Model.DataPassthroughRequest
• Model.Deduction
• Model.Earning
• Model.Employee
• Model.EmployeePayrollRun
• Model.Employment
• Model.EndUserDetailsRequest
• Model.ErrorValidationProblem
• Model.GenerateRemoteKeyRequest
• Model.Issue
• Model.LinkToken
• Model.Location
• Model.ModelOperation
• Model.PaginatedAccountDetailsAndActionsList
• Model.PaginatedBankInfoList
• Model.PaginatedBenefitList
• Model.PaginatedCompanyList
• Model.PaginatedDeductionList
• Model.PaginatedEmployeeList
• Model.PaginatedEmployeePayrollRunList
• Model.PaginatedEmploymentList
• Model.PaginatedIssueList
• Model.PaginatedLocationList
• Model.PaginatedPayGroupList
• Model.PaginatedPayrollRunList
• Model.PaginatedSyncStatusList
• Model.PaginatedTeamList
• Model.PaginatedTimeOffBalanceList
• Model.PaginatedTimeOffList
• Model.PayGroup
• Model.PayrollRun
• Model.RemoteData
• Model.RemoteDataRequest
• Model.RemoteKey
• Model.RemoteKeyForRegenerationRequest
• Model.RemoteResponse
• Model.SyncStatus
• Model.Tax
• Model.Team
• Model.TimeOff
• Model.TimeOffBalance
• Model.TimeOffEndpointRequest
• Model.TimeOffRequest
• Model.TimeOffResponse
• Model.ValidationProblemSource
• Model.WarningValidationProblem

<a name="documentation-for-authorization"></a>

Documentation for Authorization

<a name="tokenAuth"></a>

tokenAuth

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