factorial_api 3.0.1

data/lib/factorial_api/api/compensations_payroll_result_api.rb

@@ -0,0 +1,221 @@
+=begin
+#Factorial API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 2026-10-01
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.23.0
+
+=end
+
+require 'cgi'
+
+module F::Api
+  class CompensationsPayrollResultApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Bulk creates a Payroll result
+    # Imports payroll result amounts for employees of an existing payroll run, for example the figures returned by an external payroll provider. Only Factorial ids are accepted.  The import is atomic: the whole request is validated before anything is written, and any error rejects it entirely. A 4xx or 5xx response means nothing was written, so a failed request can be retried as is.  The request is rejected when: - it has no results, an employee entry has no items, it carries more than 1,000 amounts,   or it repeats an employee or a concept for the same employee - the payroll run, an employee or a payroll concept does not exist in the company - an employee is not part of the payroll run, that is, is not one of the employees   Factorial lists in that run. On regular runs the employee's contract must cover the run   period, they must not have been terminated more than 60 days before the run starts and,   when the run's cycle is limited to a people group, they must belong to it. Off-cycle   runs only apply the people group and a 365-day termination window. The error lists   these employees in `errors.employee_ids`, so they can be removed and the rest resent. - a concept is a base salary concept or is disabled - an employee entry does not include the company's net_pay concept (find its id with   compensations/concepts) - an amount is outside the signed 32-bit integer range  Re-posting an (employee, concept) pair replaces its amount and keeps the row id. Pairs not included in the request are left untouched; there is no delete. Split larger payrolls into requests of up to 1,000 amounts, keeping all of an employee's items in the same request. Requires the \"Import payroll results\" permission. 
+    # @param [Hash] opts the optional parameters
+    # @option opts [CompensationsPayrollResultsBulkCreatePostRequest] :compensations_payroll_results_bulk_create_post_request 
+    # @return [Array<CompensationsPayrollResult>]
+    def compensations_payroll_results_bulk_create_post(opts = {})
+      data, _status_code, _headers = compensations_payroll_results_bulk_create_post_with_http_info(opts)
+      data
+    end
+
+    # Bulk creates a Payroll result
+    # Imports payroll result amounts for employees of an existing payroll run, for example the figures returned by an external payroll provider. Only Factorial ids are accepted.  The import is atomic: the whole request is validated before anything is written, and any error rejects it entirely. A 4xx or 5xx response means nothing was written, so a failed request can be retried as is.  The request is rejected when: - it has no results, an employee entry has no items, it carries more than 1,000 amounts,   or it repeats an employee or a concept for the same employee - the payroll run, an employee or a payroll concept does not exist in the company - an employee is not part of the payroll run, that is, is not one of the employees   Factorial lists in that run. On regular runs the employee&#39;s contract must cover the run   period, they must not have been terminated more than 60 days before the run starts and,   when the run&#39;s cycle is limited to a people group, they must belong to it. Off-cycle   runs only apply the people group and a 365-day termination window. The error lists   these employees in &#x60;errors.employee_ids&#x60;, so they can be removed and the rest resent. - a concept is a base salary concept or is disabled - an employee entry does not include the company&#39;s net_pay concept (find its id with   compensations/concepts) - an amount is outside the signed 32-bit integer range  Re-posting an (employee, concept) pair replaces its amount and keeps the row id. Pairs not included in the request are left untouched; there is no delete. Split larger payrolls into requests of up to 1,000 amounts, keeping all of an employee&#39;s items in the same request. Requires the \&quot;Import payroll results\&quot; permission. 
+    # @param [Hash] opts the optional parameters
+    # @option opts [CompensationsPayrollResultsBulkCreatePostRequest] :compensations_payroll_results_bulk_create_post_request 
+    # @return [Array<(Array<CompensationsPayrollResult>, Integer, Hash)>] Array<CompensationsPayrollResult> data, response status code and response headers
+    def compensations_payroll_results_bulk_create_post_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CompensationsPayrollResultApi.compensations_payroll_results_bulk_create_post ...'
+      end
+      # resource path
+      local_var_path = '/api/2026-10-01/resources/compensations/payroll_results/bulk_create'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'compensations_payroll_results_bulk_create_post_request'])
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Array<CompensationsPayrollResult>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['apikey', 'oauth2']
+
+      new_options = opts.merge(
+        :operation => :"CompensationsPayrollResultApi.compensations_payroll_results_bulk_create_post",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CompensationsPayrollResultApi#compensations_payroll_results_bulk_create_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Reads all Payroll results
+    # Retrieves payroll result rows (result_type=payroll_result)
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :ids Payroll result ids
+    # @option opts [Array<String>] :payroll_run_ids Filter by payroll run ids, refers to compensations/payroll_runs endpoint.
+    # @option opts [Array<String>] :cycle_ids Filter by parent cycle ids, refers to compensations/cycles endpoint.
+    # @option opts [Array<String>] :payroll_run_employee_ids Filter by employee ids (participants of the payroll run)
+    # @option opts [Array<String>] :payroll_concept_ids Filter by payroll concept ids, refers to compensations/concepts endpoint.
+    # @return [CompensationsPayrollResultsGet200Response]
+    def compensations_payroll_results_get(opts = {})
+      data, _status_code, _headers = compensations_payroll_results_get_with_http_info(opts)
+      data
+    end
+
+    # Reads all Payroll results
+    # Retrieves payroll result rows (result_type&#x3D;payroll_result)
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :ids Payroll result ids
+    # @option opts [Array<String>] :payroll_run_ids Filter by payroll run ids, refers to compensations/payroll_runs endpoint.
+    # @option opts [Array<String>] :cycle_ids Filter by parent cycle ids, refers to compensations/cycles endpoint.
+    # @option opts [Array<String>] :payroll_run_employee_ids Filter by employee ids (participants of the payroll run)
+    # @option opts [Array<String>] :payroll_concept_ids Filter by payroll concept ids, refers to compensations/concepts endpoint.
+    # @return [Array<(CompensationsPayrollResultsGet200Response, Integer, Hash)>] CompensationsPayrollResultsGet200Response data, response status code and response headers
+    def compensations_payroll_results_get_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CompensationsPayrollResultApi.compensations_payroll_results_get ...'
+      end
+      # resource path
+      local_var_path = '/api/2026-10-01/resources/compensations/payroll_results'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'ids[]'] = @api_client.build_collection_param(opts[:'ids'], :multi) if !opts[:'ids'].nil?
+      query_params[:'payroll_run_ids[]'] = @api_client.build_collection_param(opts[:'payroll_run_ids'], :multi) if !opts[:'payroll_run_ids'].nil?
+      query_params[:'cycle_ids[]'] = @api_client.build_collection_param(opts[:'cycle_ids'], :multi) if !opts[:'cycle_ids'].nil?
+      query_params[:'payroll_run_employee_ids[]'] = @api_client.build_collection_param(opts[:'payroll_run_employee_ids'], :multi) if !opts[:'payroll_run_employee_ids'].nil?
+      query_params[:'payroll_concept_ids[]'] = @api_client.build_collection_param(opts[:'payroll_concept_ids'], :multi) if !opts[:'payroll_concept_ids'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CompensationsPayrollResultsGet200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['apikey', 'oauth2']
+
+      new_options = opts.merge(
+        :operation => :"CompensationsPayrollResultApi.compensations_payroll_results_get",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CompensationsPayrollResultApi#compensations_payroll_results_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Reads a single Payroll result
+    # Retrieves payroll result rows (result_type=payroll_result)
+    # @param id [String] Payroll result ids
+    # @param [Hash] opts the optional parameters
+    # @return [CompensationsPayrollResult]
+    def compensations_payroll_results_id_get(id, opts = {})
+      data, _status_code, _headers = compensations_payroll_results_id_get_with_http_info(id, opts)
+      data
+    end
+
+    # Reads a single Payroll result
+    # Retrieves payroll result rows (result_type&#x3D;payroll_result)
+    # @param id [String] Payroll result ids
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CompensationsPayrollResult, Integer, Hash)>] CompensationsPayrollResult data, response status code and response headers
+    def compensations_payroll_results_id_get_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CompensationsPayrollResultApi.compensations_payroll_results_id_get ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling CompensationsPayrollResultApi.compensations_payroll_results_id_get"
+      end
+      # resource path
+      local_var_path = '/api/2026-10-01/resources/compensations/payroll_results/{id}'.sub('{id}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CompensationsPayrollResult'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['apikey', 'oauth2']
+
+      new_options = opts.merge(
+        :operation => :"CompensationsPayrollResultApi.compensations_payroll_results_id_get",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CompensationsPayrollResultApi#compensations_payroll_results_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/factorial_api/api/compensations_payroll_run_api.rb

@@ -0,0 +1,166 @@
+=begin
+#Factorial API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 2026-10-01
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.23.0
+
+=end
+
+require 'cgi'
+
+module F::Api
+  class CompensationsPayrollRunApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Reads all Payroll runs
+    # Retrieves payroll runs
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :ids Filter by payroll run ids
+    # @option opts [String] :from Lower bound for the run end date (ends_on &gt;&#x3D; from)
+    # @option opts [String] :to Upper bound for the run start date (starts_on &lt;&#x3D; to)
+    # @option opts [String] :company_id Filter by company id (single)
+    # @option opts [Array<String>] :cycle_ids Filter by parent cycle ids
+    # @option opts [Array<String>] :statuses Filter by run statuses
+    # @option opts [Array<String>] :payment_types Filter by payment types (regular, extra_pay)
+    # @option opts [Boolean] :include_hidden Include hidden cycles&#39; runs in the response
+    # @return [CompensationsPayrollRunsGet200Response]
+    def compensations_payroll_runs_get(opts = {})
+      data, _status_code, _headers = compensations_payroll_runs_get_with_http_info(opts)
+      data
+    end
+
+    # Reads all Payroll runs
+    # Retrieves payroll runs
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :ids Filter by payroll run ids
+    # @option opts [String] :from Lower bound for the run end date (ends_on &gt;&#x3D; from)
+    # @option opts [String] :to Upper bound for the run start date (starts_on &lt;&#x3D; to)
+    # @option opts [String] :company_id Filter by company id (single)
+    # @option opts [Array<String>] :cycle_ids Filter by parent cycle ids
+    # @option opts [Array<String>] :statuses Filter by run statuses
+    # @option opts [Array<String>] :payment_types Filter by payment types (regular, extra_pay)
+    # @option opts [Boolean] :include_hidden Include hidden cycles&#39; runs in the response
+    # @return [Array<(CompensationsPayrollRunsGet200Response, Integer, Hash)>] CompensationsPayrollRunsGet200Response data, response status code and response headers
+    def compensations_payroll_runs_get_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CompensationsPayrollRunApi.compensations_payroll_runs_get ...'
+      end
+      # resource path
+      local_var_path = '/api/2026-10-01/resources/compensations/payroll_runs'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'ids[]'] = @api_client.build_collection_param(opts[:'ids'], :multi) if !opts[:'ids'].nil?
+      query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
+      query_params[:'to'] = opts[:'to'] if !opts[:'to'].nil?
+      query_params[:'company_id'] = opts[:'company_id'] if !opts[:'company_id'].nil?
+      query_params[:'cycle_ids[]'] = @api_client.build_collection_param(opts[:'cycle_ids'], :multi) if !opts[:'cycle_ids'].nil?
+      query_params[:'statuses[]'] = @api_client.build_collection_param(opts[:'statuses'], :multi) if !opts[:'statuses'].nil?
+      query_params[:'payment_types[]'] = @api_client.build_collection_param(opts[:'payment_types'], :multi) if !opts[:'payment_types'].nil?
+      query_params[:'include_hidden'] = opts[:'include_hidden'] if !opts[:'include_hidden'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CompensationsPayrollRunsGet200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['apikey', 'oauth2']
+
+      new_options = opts.merge(
+        :operation => :"CompensationsPayrollRunApi.compensations_payroll_runs_get",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CompensationsPayrollRunApi#compensations_payroll_runs_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Reads a single Payroll run
+    # Retrieves payroll runs
+    # @param id [String] Filter by payroll run ids
+    # @param [Hash] opts the optional parameters
+    # @return [CompensationsPayrollRun]
+    def compensations_payroll_runs_id_get(id, opts = {})
+      data, _status_code, _headers = compensations_payroll_runs_id_get_with_http_info(id, opts)
+      data
+    end
+
+    # Reads a single Payroll run
+    # Retrieves payroll runs
+    # @param id [String] Filter by payroll run ids
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CompensationsPayrollRun, Integer, Hash)>] CompensationsPayrollRun data, response status code and response headers
+    def compensations_payroll_runs_id_get_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CompensationsPayrollRunApi.compensations_payroll_runs_id_get ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling CompensationsPayrollRunApi.compensations_payroll_runs_id_get"
+      end
+      # resource path
+      local_var_path = '/api/2026-10-01/resources/compensations/payroll_runs/{id}'.sub('{id}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CompensationsPayrollRun'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['apikey', 'oauth2']
+
+      new_options = opts.merge(
+        :operation => :"CompensationsPayrollRunApi.compensations_payroll_runs_id_get",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CompensationsPayrollRunApi#compensations_payroll_runs_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/factorial_api/api/compensations_payroll_run_employees_compensation_api.rb

@@ -0,0 +1,164 @@
+=begin
+#Factorial API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 2026-10-01
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.23.0
+
+=end
+
+require 'cgi'
+
+module F::Api
+  class CompensationsPayrollRunEmployeesCompensationApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Reads all Payroll run employees compensations
+    # Retrieves payroll-run employee compensation records.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :ids Payroll run employee compensation ids
+    # @option opts [Array<String>] :payroll_run_ids Filter by payroll run ids, refers to compensations/payroll_runs endpoint.
+    # @option opts [Array<String>] :payroll_run_employee_ids Filter by employee ids (participants of the payroll run)
+    # @option opts [Array<String>] :payroll_concept_ids Filter by payroll concept ids, refers to compensations/concepts endpoint.
+    # @option opts [String] :result_type Filter by record projection type — &#x60;compensation&#x60; (input) or &#x60;payroll_result&#x60; (computed)
+    # @option opts [Array<String>] :legal_entity_ids Filter by legal entity ids, refers to companies/legal_entities endpoint.
+    # @return [CompensationsPayrollRunEmployeesCompensationsGet200Response]
+    def compensations_payroll_run_employees_compensations_get(opts = {})
+      data, _status_code, _headers = compensations_payroll_run_employees_compensations_get_with_http_info(opts)
+      data
+    end
+
+    # Reads all Payroll run employees compensations
+    # Retrieves payroll-run employee compensation records.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :ids Payroll run employee compensation ids
+    # @option opts [Array<String>] :payroll_run_ids Filter by payroll run ids, refers to compensations/payroll_runs endpoint.
+    # @option opts [Array<String>] :payroll_run_employee_ids Filter by employee ids (participants of the payroll run)
+    # @option opts [Array<String>] :payroll_concept_ids Filter by payroll concept ids, refers to compensations/concepts endpoint.
+    # @option opts [String] :result_type Filter by record projection type — &#x60;compensation&#x60; (input) or &#x60;payroll_result&#x60; (computed)
+    # @option opts [Array<String>] :legal_entity_ids Filter by legal entity ids, refers to companies/legal_entities endpoint.
+    # @return [Array<(CompensationsPayrollRunEmployeesCompensationsGet200Response, Integer, Hash)>] CompensationsPayrollRunEmployeesCompensationsGet200Response data, response status code and response headers
+    def compensations_payroll_run_employees_compensations_get_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CompensationsPayrollRunEmployeesCompensationApi.compensations_payroll_run_employees_compensations_get ...'
+      end
+      allowable_values = ["compensation", "payroll_result"]
+      if @api_client.config.client_side_validation && opts[:'result_type'] && !allowable_values.include?(opts[:'result_type'])
+        fail ArgumentError, "invalid value for \"result_type\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/api/2026-10-01/resources/compensations/payroll_run_employees_compensations'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'ids[]'] = @api_client.build_collection_param(opts[:'ids'], :multi) if !opts[:'ids'].nil?
+      query_params[:'payroll_run_ids[]'] = @api_client.build_collection_param(opts[:'payroll_run_ids'], :multi) if !opts[:'payroll_run_ids'].nil?
+      query_params[:'payroll_run_employee_ids[]'] = @api_client.build_collection_param(opts[:'payroll_run_employee_ids'], :multi) if !opts[:'payroll_run_employee_ids'].nil?
+      query_params[:'payroll_concept_ids[]'] = @api_client.build_collection_param(opts[:'payroll_concept_ids'], :multi) if !opts[:'payroll_concept_ids'].nil?
+      query_params[:'result_type'] = opts[:'result_type'] if !opts[:'result_type'].nil?
+      query_params[:'legal_entity_ids[]'] = @api_client.build_collection_param(opts[:'legal_entity_ids'], :multi) if !opts[:'legal_entity_ids'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CompensationsPayrollRunEmployeesCompensationsGet200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['apikey', 'oauth2']
+
+      new_options = opts.merge(
+        :operation => :"CompensationsPayrollRunEmployeesCompensationApi.compensations_payroll_run_employees_compensations_get",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CompensationsPayrollRunEmployeesCompensationApi#compensations_payroll_run_employees_compensations_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Reads a single Payroll run employees compensation
+    # Retrieves payroll-run employee compensation records.
+    # @param id [String] Payroll run employee compensation ids
+    # @param [Hash] opts the optional parameters
+    # @return [CompensationsPayrollRunEmployeesCompensation]
+    def compensations_payroll_run_employees_compensations_id_get(id, opts = {})
+      data, _status_code, _headers = compensations_payroll_run_employees_compensations_id_get_with_http_info(id, opts)
+      data
+    end
+
+    # Reads a single Payroll run employees compensation
+    # Retrieves payroll-run employee compensation records.
+    # @param id [String] Payroll run employee compensation ids
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CompensationsPayrollRunEmployeesCompensation, Integer, Hash)>] CompensationsPayrollRunEmployeesCompensation data, response status code and response headers
+    def compensations_payroll_run_employees_compensations_id_get_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CompensationsPayrollRunEmployeesCompensationApi.compensations_payroll_run_employees_compensations_id_get ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling CompensationsPayrollRunEmployeesCompensationApi.compensations_payroll_run_employees_compensations_id_get"
+      end
+      # resource path
+      local_var_path = '/api/2026-10-01/resources/compensations/payroll_run_employees_compensations/{id}'.sub('{id}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CompensationsPayrollRunEmployeesCompensation'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['apikey', 'oauth2']
+
+      new_options = opts.merge(
+        :operation => :"CompensationsPayrollRunEmployeesCompensationApi.compensations_payroll_run_employees_compensations_id_get",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CompensationsPayrollRunEmployeesCompensationApi#compensations_payroll_run_employees_compensations_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end