MergeHRISClient v1.0.3

MergeHRISClient.Api.BankInfo (MergeHRISClient v1.0.3) View Source

API calls for all endpoints tagged BankInfo.

Link to this section Summary

Functions

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

Returns a list of BankInfo objects.

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

Returns a BankInfo object with the given id.

Link to this section Functions

Link to this function

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

View Source

Specs

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

Returns a list of BankInfo objects.

Parameters

  • connection (MergeHRISClient.Connection): Connection to server
  • authorization (String.t): Should include 'Bearer ' followed by your test/production API Key.
  • x_account_token (String.t): Token identifying the end user.
  • opts (KeywordList): [optional] Optional parameters
    • :account_type (String.t): If provided, will only return BankInfo's with this account type. Options: ('SAVINGS', 'CHECKING')
    • :bank_name (String.t): If provided, will only return BankInfo's with this bank name.
    • :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.
    • :employee_id (String.t): If provided, will only return bank accounts for this employee.
    • :include_deleted_data (boolean()): Whether to include data that was marked as deleted by third party webhooks.
    • :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.
    • :order_by (String.t): Overrides the default ordering for this endpoint.
    • :page_size (integer()): Number of results to return per page.
    • :remote_fields (String.t): Which fields should be returned in non-normalized form.
    • :remote_id (String.t): The API provider's ID for the given object.

      Returns

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

Link to this function

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

View Source

Specs

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

Returns a BankInfo object with the given id.

Parameters

  • connection (MergeHRISClient.Connection): Connection to server
  • authorization (String.t): Should include 'Bearer ' followed by your test/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.
    • :remote_fields (String.t): Which fields should be returned in non-normalized form.

      Returns

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