Deprecation Notice

Merge has released a new version of our Python 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 Python 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 Python SDK, see the Python Migration Guide.

MergeHRISClient

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

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 1.0
• Package version: 1.4.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://www.merge.dev/

Requirements.

Python >= 3.6

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/merge-api/merge-hris-python.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/merge-api/merge-hris-python.git)

Then import the package:

import MergeHRISClient

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import MergeHRISClient

Getting Started

Please follow the installation procedure and then run the following:

import time
import MergeHRISClient
from pprint import pprint
from MergeHRISClient.api import account_details_api
from MergeHRISClient.model.account_details import AccountDetails
# Defining the host is optional and defaults to https://api.merge.dev/api/hris/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = MergeHRISClient.Configuration(
    host = "https://api.merge.dev/api/hris/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: tokenAuth
configuration.api_key['tokenAuth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'


# Enter a context with an instance of the API client
with MergeHRISClient.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = account_details_api.AccountDetailsApi(api_client)
    x_account_token = "X-Account-Token_example" # str | Token identifying the end user.

    try:
        api_response = api_instance.account_details_retrieve(x_account_token)
        pprint(api_response)
    except MergeHRISClient.ApiException as e:
        print("Exception when calling AccountDetailsApi->account_details_retrieve: %s\n" % e)

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
AccountDetailsApi	account_details_retrieve	GET /account-details
AccountTokenApi	account_token_retrieve	GET /account-token/{public_token}
AvailableActionsApi	available_actions_retrieve	GET /available-actions
BankInfoApi	bank_info_list	GET /bank-info
BankInfoApi	bank_info_retrieve	GET /bank-info/{id}
BenefitsApi	benefits_list	GET /benefits
BenefitsApi	benefits_retrieve	GET /benefits/{id}
CommonModelScopesApi	common_model_scopes_create	POST /common-model-scopes
CommonModelScopesApi	common_model_scopes_retrieve	GET /common-model-scopes
CompaniesApi	companies_list	GET /companies
CompaniesApi	companies_retrieve	GET /companies/{id}
DeleteAccountApi	delete_account_create	POST /delete-account
EmployeePayrollRunsApi	employee_payroll_runs_list	GET /employee-payroll-runs
EmployeePayrollRunsApi	employee_payroll_runs_retrieve	GET /employee-payroll-runs/{id}
EmployeesApi	employees_create	POST /employees
EmployeesApi	employees_ignore_create	POST /employees/ignore/{model_id}
EmployeesApi	employees_list	GET /employees
EmployeesApi	employees_meta_post_retrieve	GET /employees/meta/post
EmployeesApi	employees_retrieve	GET /employees/{id}
EmploymentsApi	employments_list	GET /employments
EmploymentsApi	employments_retrieve	GET /employments/{id}
ForceResyncApi	sync_status_resync_create	POST /sync-status/resync
GenerateKeyApi	generate_key_create	POST /generate-key
GroupsApi	groups_list	GET /groups
GroupsApi	groups_retrieve	GET /groups/{id}
IssuesApi	issues_list	GET /issues
IssuesApi	issues_retrieve	GET /issues/{id}
LinkTokenApi	link_token_create	POST /link-token
LinkedAccountsApi	linked_accounts_list	GET /linked-accounts
LocationsApi	locations_list	GET /locations
LocationsApi	locations_retrieve	GET /locations/{id}
PassthroughApi	passthrough_create	POST /passthrough
PayGroupsApi	pay_groups_list	GET /pay-groups
PayGroupsApi	pay_groups_retrieve	GET /pay-groups/{id}
PayrollRunsApi	payroll_runs_list	GET /payroll-runs
PayrollRunsApi	payroll_runs_retrieve	GET /payroll-runs/{id}
RegenerateKeyApi	regenerate_key_create	POST /regenerate-key
SelectiveSyncApi	selective_sync_configurations_list	GET /selective-sync/configurations
SelectiveSyncApi	selective_sync_configurations_update	PUT /selective-sync/configurations
SelectiveSyncApi	selective_sync_meta_list	GET /selective-sync/meta
SyncStatusApi	sync_status_list	GET /sync-status
TeamsApi	teams_list	GET /teams
TeamsApi	teams_retrieve	GET /teams/{id}
TimeOffApi	time_off_create	POST /time-off
TimeOffApi	time_off_list	GET /time-off
TimeOffApi	time_off_meta_post_retrieve	GET /time-off/meta/post
TimeOffApi	time_off_retrieve	GET /time-off/{id}
TimeOffBalancesApi	time_off_balances_list	GET /time-off-balances
TimeOffBalancesApi	time_off_balances_retrieve	GET /time-off-balances/{id}
WebhookReceiversApi	webhook_receivers_create	POST /webhook-receivers
WebhookReceiversApi	webhook_receivers_list	GET /webhook-receivers

Documentation For Models

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

Documentation For Authorization

tokenAuth

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

Author

hello@merge.dev

Notes for Large OpenAPI documents

If the OpenAPI document is large, imports in MergeHRISClient.apis and MergeHRISClient.models may fail with a RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:

Solution 1: Use specific imports for apis and models like:

• from MergeHRISClient.api.default_api import DefaultApi
• from MergeHRISClient.model.pet import Pet

Solution 2: Before importing the package, adjust the maximum recursion limit as shown below:

import sys
sys.setrecursionlimit(1500)
import MergeHRISClient
from MergeHRISClient.apis import *
from MergeHRISClient.models import *