lib/velopayments/api/payment_audit_service_api.rb
# Export Transactions
# Download a CSV file containing payments in a date range. Uses Transfer-Encoding - chunked to stream to the client. Date range is inclusive of both the start and end dates.
# @param [Hash] opts the optional parameters
# @option opts [String] :payor_id &lt;p&gt;The Payor ID for whom you wish to run the report.&lt;/p&gt; &lt;p&gt;For a Payor requesting the report, this could be their exact Payor, or it could be a child/descendant Payor.&lt;/p&gt; 
# @option opts [Date] :start_date Start date, inclusive. Format is YYYY-MM-DD
# @option opts [Date] :end_date End date, inclusive. Format is YYYY-MM-DD
# @option opts [String] :include &lt;p&gt;Mode to determine whether to include other Payor&#39;s data in the results.&lt;/p&gt; &lt;p&gt;May only be used if payorId is specified.&lt;/p&gt; &lt;p&gt;Can be omitted or set to &#39;payorOnly&#39; or &#39;payorAndDescendants&#39;.&lt;/p&gt; &lt;p&gt;payorOnly: Only include results for the specified Payor. This is the default if &#39;include&#39; is omitted.&lt;/p&gt; &lt;p&gt;payorAndDescendants: Aggregate results for all descendant Payors of the specified Payor. Should only be used if the Payor with the specified payorId has at least one child Payor.&lt;/p&gt; &lt;p&gt;Note when a Payor requests the report and include&#x3D;payorAndDescendants is used, the following additional columns are included in the CSV: Payor Name, Payor Id&lt;/p&gt; 
# @return [Array<(PayorAmlTransaction, Integer, Hash)>] PayorAmlTransaction data, response status code and response headers
Export Transactions
Download a CSV file containing payments in a date range. Uses Transfer-Encoding - chunked to stream to the client. Date range is inclusive of both the start and end dates.
Export Transactions Download a CSV file containing payments in a date range . Uses Transfer - Encoding - chunked to stream to the client . Date range is inclusive of both the start and end dates .
def export_transactions_csvv4_with_http_info(opts = {})
      if @api_client.config.debugging
        @api_client.config.logger.debug 'Calling API: PaymentAuditServiceApi.export_transactions_csvv4 ...'
      end
      allowable_values = ["payorOnly", "payorAndDescendants"]
      if @api_client.config.client_side_validation && opts[:'include'] && !allowable_values.include?(opts[:'include'])
        fail ArgumentError, "invalid value for \"include\", must be one of #{allowable_values}"
      end
      local_var_path = '/v4/paymentaudit/transactions'
      query_params = opts[:query_params] || {}
      query_params[:'payorId'] = opts[:'payor_id'] if !opts[:'payor_id'].nil?
      query_params[:'startDate'] = opts[:'start_date'] if !opts[:'start_date'].nil?
      query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil?
      query_params[:'include'] = opts[:'include'] if !opts[:'include'].nil?
      header_params = opts[:header_params] || {}
      header_params['Accept'] = @api_client.select_header_accept(['application/csv'])
      form_params = opts[:form_params] || {}
      post_body = opts[:debug_body]
      return_type = opts[:debug_return_type] || 'PayorAmlTransaction'
      auth_names = opts[:debug_auth_names] || ['OAuth2']
      new_options = opts.merge(
        :operation => :"PaymentAuditServiceApi.export_transactions_csvv4",
        :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: PaymentAuditServiceApi#export_transactions_csvv4\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
      end
      return data, status_code, headers
    end
def export_transactions_csvv4_with_http_info ( opts = { } ) if @api_client . config . debugging @api_client . config . logger . debug 'Calling API: PaymentAuditServiceApi.export_transactions_csvv4 ...' end allowable_values = [ "payorOnly" , "payorAndDescendants" ] if @api_client . config . client_side_validation && opts [ :' include ' ] && ! allowable_values . include? ( opts [ :' include ' ] ) fail ArgumentError , "invalid value for \"include\", must be one of #{allowable_values}" end local_var_path = '/v4/paymentaudit/transactions' query_params = opts [ :query_params ] || { } query_params [ :' payorId ' ] = opts [ :' payor_id ' ] if ! opts [ :' payor_id ' ] . nil? query_params [ :' startDate ' ] = opts [ :' start_date ' ] if ! opts [ :' start_date ' ] . nil? query_params [ :' endDate ' ] = opts [ :' end_date ' ] if ! opts [ :' end_date ' ] . nil? query_params [ :' include ' ] = opts [ :' include ' ] if ! opts [ :' include ' ] . nil? header_params = opts [ :header_params ] || { } header_params [ 'Accept' ] = @api_client . select_header_accept ( [ 'application/csv' ] ) form_params = opts [ :form_params ] || { } post_body = opts [ :debug_body ] return_type = opts [ :debug_return_type ] || 'PayorAmlTransaction' auth_names = opts [ :debug_auth_names ] || [ 'OAuth2' ] new_options = opts . merge ( :operation => :" PaymentAuditServiceApi.export_transactions_csvv4 " , :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: PaymentAuditServiceApi#export_transactions_csvv4\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data , status_code , headers end
Export Transactions
Download a CSV file containing payments in a date range.
Export Transactions Download a CSV file containing payments in a date range .
# resource path # query parameters # header parameters # HTTP header 'Accept' (if needed) # form parameters # http body (model) # return_type # auth_names
PayorAmlTransaction data, response status code and response headers
PayorAmlTransaction data response status code and response headers
Array<(PayorAmlTransaction, Integer, Hash)>
opts
:include <p>Mode to determine whether to include other Payor's data in the results.</p> <p>May only be used if payorId is specified.</p> <p>Can be omitted or set to 'payorOnly' or 'payorAndDescendants'.</p> <p>payorOnly: Only include results for the specified Payor. This is the default if 'include' is omitted.</p> <p>payorAndDescendants: Aggregate results for all descendant Payors of the specified Payor. Should only be used if the Payor with the specified payorId has at least one child Payor.</p> <p>Note when a Payor requests the report and include=payorAndDescendants is used, the following additional columns are included in the CSV: Payor Name, Payor Id</p>.
: include <p > Mode to determine whether to include other Payor ' s data in the results . < / p > <p > May only be used if payorId is specified . < / p > <p > Can be omitted or set to ' payorOnly ' or ' payorAndDescendants ' . < / p > <p > payorOnly : Only include results for the specified Payor . This is the default if ' include ' is omitted . < / p > <p > payorAndDescendants : Aggregate results for all descendant Payors of the specified Payor . Should only be used if the Payor with the specified payorId has at least one child Payor . < / p > <p > Note when a Payor requests the report and include = payorAndDescendants is used the following additional columns are included in the CSV : Payor Name Payor Id< / p > .
<not_specific>
opts the optional parameters
opts the optional parameters