Merge.HRISClient 2.1.0

dotnet add package Merge.HRISClient --version 2.1.0
NuGet\Install-Package Merge.HRISClient -Version 2.1.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Merge.HRISClient" Version="2.1.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Merge.HRISClient --version 2.1.0
#r "nuget: Merge.HRISClient, 2.1.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Merge.HRISClient as a Cake Addin
#addin nuget:?package=Merge.HRISClient&version=2.1.0

// Install Merge.HRISClient as a Cake Tool
#tool nuget:?package=Merge.HRISClient&version=2.1.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: 2.1.0
  • 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

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);
            var xAccountToken = xAccountToken_example;  // string | Token identifying the end user.

            try
            {
                AccountDetails result = apiInstance.AccountDetailsRetrieve(xAccountToken);
                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

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}
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
SelectiveSyncApi SelectiveSyncConfigurationsList GET /selective-sync/configurations
SelectiveSyncApi SelectiveSyncConfigurationsUpdate PUT /selective-sync/configurations
SelectiveSyncApi SelectiveSyncMetaList GET /selective-sync/meta
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

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

Documentation for Models

<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
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2.1.0 7,427 6/20/2023
2.0.2 8,595 9/21/2022
2.0.1 417 9/9/2022
2.0.0 4,794 2/28/2022
2.0.0-snapshot 126 2/28/2022

Minor update