Skip to content

Latest commit

 

History

History
216 lines (164 loc) · 11.2 KB

PayrollRunsApi.md

File metadata and controls

216 lines (164 loc) · 11.2 KB
Raw

MergeHRISClient.PayrollRunsApi

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

Method HTTP request Description
payroll_runs_list GET /payroll-runs
payroll_runs_retrieve GET /payroll-runs/{id}

payroll_runs_list

PaginatedPayrollRunList payroll_runs_list(x_account_token)

Returns a list of PayrollRun objects.

Example

  • Api Key Authentication (tokenAuth):
import time
import MergeHRISClient
from MergeHRISClient.api import payroll_runs_api
from MergeHRISClient.model.paginated_payroll_run_list import PaginatedPayrollRunList
from pprint import pprint
# 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 = payroll_runs_api.PayrollRunsApi(api_client)
    x_account_token = "X-Account-Token_example" # str | Token identifying the end user.
    created_after = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | If provided, will only return objects created after this datetime. (optional)
    created_before = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | If provided, will only return objects created before this datetime. (optional)
    cursor = "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw" # str | The pagination cursor value. (optional)
    ended_after = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime, none_type | If provided, will only return payroll runs ended after this datetime. (optional)
    ended_before = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime, none_type | If provided, will only return payroll runs ended before this datetime. (optional)
    include_deleted_data = True # bool | Whether to include data that was marked as deleted by third party webhooks. (optional)
    include_remote_data = True # bool | Whether to include the original data Merge fetched from the third-party to produce these models. (optional)
    modified_after = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | If provided, will only return objects modified after this datetime. (optional)
    modified_before = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | If provided, will only return objects modified before this datetime. (optional)
    page_size = 1 # int | Number of results to return per page. (optional)
    remote_fields = "run_state,run_type" # str | Deprecated. Use show_enum_origins. (optional)
    remote_id = "remote_id_example" # str, none_type | The API provider's ID for the given object. (optional)
    run_type = "CORRECTION" # str, none_type | If provided, will only return PayrollRun's with this status. Options: ('REGULAR', 'OFF_CYCLE', 'CORRECTION', 'TERMINATION', 'SIGN_ON_BONUS') (optional)
    show_enum_origins = "run_state,run_type" # str | Which fields should be returned in non-normalized form. (optional)
    started_after = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime, none_type | If provided, will only return payroll runs started after this datetime. (optional)
    started_before = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime, none_type | If provided, will only return payroll runs started before this datetime. (optional)

    # example passing only required values which don't have defaults set
    try:
        api_response = api_instance.payroll_runs_list(x_account_token)
        pprint(api_response)
    except MergeHRISClient.ApiException as e:
        print("Exception when calling PayrollRunsApi->payroll_runs_list: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        api_response = api_instance.payroll_runs_list(x_account_token, created_after=created_after, created_before=created_before, cursor=cursor, ended_after=ended_after, ended_before=ended_before, include_deleted_data=include_deleted_data, include_remote_data=include_remote_data, modified_after=modified_after, modified_before=modified_before, page_size=page_size, remote_fields=remote_fields, remote_id=remote_id, run_type=run_type, show_enum_origins=show_enum_origins, started_after=started_after, started_before=started_before)
        pprint(api_response)
    except MergeHRISClient.ApiException as e:
        print("Exception when calling PayrollRunsApi->payroll_runs_list: %s\n" % e)

Parameters

Name Type Description Notes
x_account_token str Token identifying the end user.
created_after datetime If provided, will only return objects created after this datetime. [optional]
created_before datetime If provided, will only return objects created before this datetime. [optional]
cursor str The pagination cursor value. [optional]
ended_after datetime, none_type If provided, will only return payroll runs ended after this datetime. [optional]
ended_before datetime, none_type If provided, will only return payroll runs ended before this datetime. [optional]
include_deleted_data bool Whether to include data that was marked as deleted by third party webhooks. [optional]
include_remote_data bool Whether to include the original data Merge fetched from the third-party to produce these models. [optional]
modified_after datetime If provided, will only return objects modified after this datetime. [optional]
modified_before datetime If provided, will only return objects modified before this datetime. [optional]
page_size int Number of results to return per page. [optional]
remote_fields str Deprecated. Use show_enum_origins. [optional]
remote_id str, none_type The API provider's ID for the given object. [optional]
run_type str, none_type If provided, will only return PayrollRun's with this status. Options: ('REGULAR', 'OFF_CYCLE', 'CORRECTION', 'TERMINATION', 'SIGN_ON_BONUS') [optional]
show_enum_origins str Which fields should be returned in non-normalized form. [optional]
started_after datetime, none_type If provided, will only return payroll runs started after this datetime. [optional]
started_before datetime, none_type If provided, will only return payroll runs started before this datetime. [optional]

Return type

PaginatedPayrollRunList

Authorization

tokenAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

payroll_runs_retrieve

PayrollRun payroll_runs_retrieve(x_account_token, id)

Returns a PayrollRun object with the given id.

Example

  • Api Key Authentication (tokenAuth):
import time
import MergeHRISClient
from MergeHRISClient.api import payroll_runs_api
from MergeHRISClient.model.payroll_run import PayrollRun
from pprint import pprint
# 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 = payroll_runs_api.PayrollRunsApi(api_client)
    x_account_token = "X-Account-Token_example" # str | Token identifying the end user.
    id = "id_example" # str | 
    include_remote_data = True # bool | Whether to include the original data Merge fetched from the third-party to produce these models. (optional)
    remote_fields = "run_state,run_type" # str | Deprecated. Use show_enum_origins. (optional)
    show_enum_origins = "run_state,run_type" # str | Which fields should be returned in non-normalized form. (optional)

    # example passing only required values which don't have defaults set
    try:
        api_response = api_instance.payroll_runs_retrieve(x_account_token, id)
        pprint(api_response)
    except MergeHRISClient.ApiException as e:
        print("Exception when calling PayrollRunsApi->payroll_runs_retrieve: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        api_response = api_instance.payroll_runs_retrieve(x_account_token, id, include_remote_data=include_remote_data, remote_fields=remote_fields, show_enum_origins=show_enum_origins)
        pprint(api_response)
    except MergeHRISClient.ApiException as e:
        print("Exception when calling PayrollRunsApi->payroll_runs_retrieve: %s\n" % e)

Parameters

Name Type Description Notes
x_account_token str Token identifying the end user.
id str
include_remote_data bool Whether to include the original data Merge fetched from the third-party to produce these models. [optional]
remote_fields str Deprecated. Use show_enum_origins. [optional]
show_enum_origins str Which fields should be returned in non-normalized form. [optional]

Return type

PayrollRun

Authorization

tokenAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 -

[Back to top] [Back to API list] [Back to Model list] [Back to README]