MergeHRISClient.Api.PayrollRuns (MergeHRISClient v1.0.2) View Source

API calls for all endpoints tagged PayrollRuns.

Link to this section Summary

Link to this section Functions

Link to this function

payroll_runs_list(connection, authorization, x_account_token, opts \\ [])

View Source

Specs

Returns a list of PayrollRun objects.

Parameters

  • connection (MergeHRISClient.Connection): Connection to server
  • authorization (String.t): Should include 'Bearer ' followed by your production API Key.
  • x_account_token (String.t): Token identifying the end user.
  • opts (KeywordList): [optional] Optional parameters
    • :created_after (DateTime.t): If provided, will only return objects created after this datetime.
    • :created_before (DateTime.t): If provided, will only return objects created before this datetime.
    • :cursor (String.t): The pagination cursor value.
    • :ended_after (DateTime.t): If provided, will only return payroll runs ended after this datetime.
    • :ended_before (DateTime.t): If provided, will only return payroll runs ended before this datetime.
    • :include_deleted_data (boolean()): Whether to include data that was deleted in the third-party service.
    • :include_remote_data (boolean()): Whether to include the original data Merge fetched from the third-party to produce these models.
    • :modified_after (DateTime.t): If provided, will only return objects modified after this datetime.
    • :modified_before (DateTime.t): If provided, will only return objects modified before this datetime.
    • :page_size (integer()): Number of results to return per page.
    • :remote_id (String.t): The API provider's ID for the given object.
    • :run_type (String.t): If provided, will only return PayrollRun's with this status. Options: ('REGULAR', 'OFF_CYCLE', 'CORRECTION', 'TERMINATION', 'SIGN_ON_BONUS')
    • :started_after (DateTime.t): If provided, will only return payroll runs started after this datetime.
    • :started_before (DateTime.t): If provided, will only return payroll runs started before this datetime.

      Returns

on success {:error, Tesla.Env.t} on failure

Link to this function

payroll_runs_retrieve(connection, authorization, x_account_token, id, opts \\ [])

View Source

Specs

payroll_runs_retrieve(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) :: {:ok, MergeHRISClient.Model.PayrollRun.t()} | {:error, Tesla.Env.t()}

Returns a PayrollRun object with the given id.

Parameters

  • connection (MergeHRISClient.Connection): Connection to server
  • authorization (String.t): Should include 'Bearer ' followed by your production API Key.
  • x_account_token (String.t): Token identifying the end user.
  • id (String.t):
  • opts (KeywordList): [optional] Optional parameters
    • :include_remote_data (boolean()): Whether to include the original data Merge fetched from the third-party to produce these models.

      Returns

on success {:error, Tesla.Env.t} on failure