Method: Propertyware::BillsApi#get_bill_payment_with_http_info

Defined in:
lib/propertyware/api/bills_api.rb

#get_bill_payment_with_http_info(bill_payment_id, opts = {}) ⇒ Array<(BillPayment, Integer, Hash)>

Retrieve a bill payment (BETA) &lt;p class&#x3D;&quot;betaWarning&quot;&gt;&lt;b&gt;Note: &lt;/b&gt;This operation is still in beta and might be subject to breaking changes. Production integrations should be avoided at this stage.&lt;/p&gt; Retrieves a specific bill payment.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;BILLS&lt;/span&gt; - &lt;code&gt;Read&lt;/code&gt;

Parameters:

  • bill_payment_id (Integer) —

    Bill Payment ID

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

    the optional parameters

Returns:

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

    BillPayment data, response status code and response headers



571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
 
# File 'lib/propertyware/api/bills_api.rb', line 571

def get_bill_payment_with_http_info(bill_payment_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BillsApi.get_bill_payment ...'
  end
  # verify the required parameter 'bill_payment_id' is set
  if @api_client.config.client_side_validation && bill_payment_id.nil?
    fail ArgumentError, "Missing the required parameter 'bill_payment_id' when calling BillsApi.get_bill_payment"
  end
  # resource path
  local_var_path = '/bills/payments/{billPaymentID}'.sub('{' + 'billPaymentID' + '}', CGI.escape(bill_payment_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] || 'BillPayment'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']

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