Method: OpenapiClient::XHRVerticallyIntegratedApi#xhr_payslips20230301_with_http_info

Defined in:
lib/openapi_client/api/xhr_vertically_integrated_api.rb

#xhr_payslips20230301_with_http_info(payrun_id, opts = {}) ⇒ Array<(Array<PayslipResponse>, Integer, Hash)>

Payslips Retrieves payslips from a specific payrun. Supported integrations: - brain payroll - brightpay connect - deel - gusto - justworks - moorepay - onpay - oyster - parolla.ie - paycircle - payfit - pento.io - quickbooks online - remote.com - sageone - shape payroll - simplepay.ie - staffology - xero uk

Parameters:

  • payrun_id (String) —

    The id of the payrun.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Array<PayslipResponse>, Integer, Hash)>) —

    Array<PayslipResponse> data, response status code and response headers



339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
 
# File 'lib/openapi_client/api/xhr_vertically_integrated_api.rb', line 339

def xhr_payslips20230301_with_http_info(payrun_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: XHRVerticallyIntegratedApi.xhr_payslips20230301 ...'
  end
  # verify the required parameter 'payrun_id' is set
  if @api_client.config.client_side_validation && payrun_id.nil?
    fail ArgumentError, "Missing the required parameter 'payrun_id' when calling XHRVerticallyIntegratedApi.xhr_payslips20230301"
  end
  # resource path
  local_var_path = '/2023-03-01/xhr/payruns/{payrun_id}'.sub('{' + 'payrun_id' + '}', CGI.escape(payrun_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'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<PayslipResponse>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['access-token']

  new_options = opts.merge(
    :operation => :"XHRVerticallyIntegratedApi.xhr_payslips20230301",
    :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: XHRVerticallyIntegratedApi#xhr_payslips20230301\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end