Skip to content

merge-api/merge-hris-csharp-net

BranchesTags

Repository files navigation

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/

Frameworks supported

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

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.

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;

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;

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

        }
    }
}

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

Documentation for Models

Documentation for Authorization

tokenAuth

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

About

The C# API Client for the Merge HRIS API.

Resources

Readme

License

View license
Activity
Custom properties

Stars

3 stars

Watchers

10 watching

Forks

2 forks
Report repository

Releases

No releases published

Packages

 
 
 

Contributors 4

  •  
  •  
  •  
  •  

Languages