MergeHRISClient.Api.Employments.employments_list

You're seeing just the function employments_list, go back to MergeHRISClient.Api.Employments module for more information.
Link to this function

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

View Source

Specs

Returns a list of Employment 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.
    • :employee_id (String.t): If provided, will only return employments for this employee.
    • :expand (String.t): Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
    • :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.
    • :order_by (String.t): Overrides the default ordering for this endpoint.
    • :page_size (integer()): Number of results to return per page.
    • :remote_id (String.t): The API provider's ID for the given object.

      Returns

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