Class: Buildium::OwnershipAccountTransactionsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/buildium-ruby/api/ownership_account_transactions_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ OwnershipAccountTransactionsApi

Returns a new instance of OwnershipAccountTransactionsApi.



19
20
21
 
# File 'lib/buildium-ruby/api/ownership_account_transactions_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/buildium-ruby/api/ownership_account_transactions_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_ownership_account_auto_allocated_payment(ownership_account_id, ownership_account_auto_allocated_payment_post_message, opts = {}) ⇒ OwnershipAccountTransactionMessage

Create a payment (auto allocated) Creates a payment on the ownership account ledger. Note that the recorded payment will be automatically allocated to the general ledger accounts based on the payment allocation settings. These settings can be found under the Settings &gt; Application Settings &gt; Residents page in your account. If you’d like to specify the general ledger accounts the payment should apply to, please use the <a href="#operation/CreateOwnershipAccountLedgerPayment">Create a payment</a> endpoint. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Associations &gt; Ownership account transactions</span> - ‘View` `Edit`

Parameters:

Returns:



28
29
30
31
 
# File 'lib/buildium-ruby/api/ownership_account_transactions_api.rb', line 28

def (, , opts = {})
  data, _status_code, _headers = (, , opts)
  data
end

#create_ownership_account_auto_allocated_payment_with_http_info(ownership_account_id, ownership_account_auto_allocated_payment_post_message, opts = {}) ⇒ Array<(OwnershipAccountTransactionMessage, Integer, Hash)>

Create a payment (auto allocated) Creates a payment on the ownership account ledger. Note that the recorded payment will be automatically allocated to the general ledger accounts based on the payment allocation settings. These settings can be found under the Settings &amp;gt; Application Settings &amp;gt; Residents page in your account. If you&#39;d like to specify the general ledger accounts the payment should apply to, please use the &lt;a href&#x3D;&quot;#operation/CreateOwnershipAccountLedgerPayment&quot;&gt;Create a payment&lt;/a&gt; endpoint. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Associations &amp;gt; Ownership account transactions&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;

Parameters:

Returns:



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/buildium-ruby/api/ownership_account_transactions_api.rb', line 39

def (, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OwnershipAccountTransactionsApi.create_ownership_account_auto_allocated_payment ...'
  end
  # verify the required parameter 'ownership_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'ownership_account_id' when calling OwnershipAccountTransactionsApi.create_ownership_account_auto_allocated_payment"
  end
  # verify the required parameter 'ownership_account_auto_allocated_payment_post_message' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'ownership_account_auto_allocated_payment_post_message' when calling OwnershipAccountTransactionsApi.create_ownership_account_auto_allocated_payment"
  end
  # resource path
  local_var_path = '/v1/associations/ownershipaccounts/{ownershipAccountId}/autoallocatedpayments'.sub('{' + 'ownershipAccountId' + '}', CGI.escape(.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'])
  # 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()

  # return_type
  return_type = opts[:debug_return_type] || 'OwnershipAccountTransactionMessage'

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

  new_options = opts.merge(
    :operation => :"OwnershipAccountTransactionsApi.create_ownership_account_auto_allocated_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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OwnershipAccountTransactionsApi#create_ownership_account_auto_allocated_payment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_ownership_account_credit(ownership_account_id, ownership_account_credit_post_message, opts = {}) ⇒ OwnershipAccountTransactionMessage

Create a credit Creates a ledger credit. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Associations &gt; Ownership account transactions</span> - ‘View` `Edit`

Parameters:

Returns:



102
103
104
105
 
# File 'lib/buildium-ruby/api/ownership_account_transactions_api.rb', line 102

def (, , opts = {})
  data, _status_code, _headers = (, , opts)
  data
end

#create_ownership_account_credit_recurring_transaction(ownership_account_id, credit_recurring_transaction_post_message, opts = {}) ⇒ OwnershipAccountRecurringCreditMessage

Create a recurring credit Creates a recurring credit transaction that will post automatically on the specified ownership account ledger. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Associations &gt; Ownership account transactions</span> - ‘View` `Edit`

Parameters:

Returns:



176
177
178
179
 
# File 'lib/buildium-ruby/api/ownership_account_transactions_api.rb', line 176

def (, credit_recurring_transaction_post_message, opts = {})
  data, _status_code, _headers = (, credit_recurring_transaction_post_message, opts)
  data
end

#create_ownership_account_credit_recurring_transaction_with_http_info(ownership_account_id, credit_recurring_transaction_post_message, opts = {}) ⇒ Array<(OwnershipAccountRecurringCreditMessage, Integer, Hash)>

Create a recurring credit Creates a recurring credit transaction that will post automatically on the specified ownership account ledger. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Associations &amp;gt; Ownership account transactions&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;

Parameters:

Returns:



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/buildium-ruby/api/ownership_account_transactions_api.rb', line 187

def (, credit_recurring_transaction_post_message, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OwnershipAccountTransactionsApi.create_ownership_account_credit_recurring_transaction ...'
  end
  # verify the required parameter 'ownership_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'ownership_account_id' when calling OwnershipAccountTransactionsApi.create_ownership_account_credit_recurring_transaction"
  end
  # verify the required parameter 'credit_recurring_transaction_post_message' is set
  if @api_client.config.client_side_validation && credit_recurring_transaction_post_message.nil?
    fail ArgumentError, "Missing the required parameter 'credit_recurring_transaction_post_message' when calling OwnershipAccountTransactionsApi.create_ownership_account_credit_recurring_transaction"
  end
  # resource path
  local_var_path = '/v1/associations/ownershipaccounts/{ownershipAccountId}/recurringcredits'.sub('{' + 'ownershipAccountId' + '}', CGI.escape(.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'])
  # 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(credit_recurring_transaction_post_message)

  # return_type
  return_type = opts[:debug_return_type] || 'OwnershipAccountRecurringCreditMessage'

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

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

#create_ownership_account_credit_with_http_info(ownership_account_id, ownership_account_credit_post_message, opts = {}) ⇒ Array<(OwnershipAccountTransactionMessage, Integer, Hash)>

Create a credit Creates a ledger credit. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Associations &amp;gt; Ownership account transactions&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;

Parameters:

Returns:



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/buildium-ruby/api/ownership_account_transactions_api.rb', line 113

def (, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OwnershipAccountTransactionsApi.create_ownership_account_credit ...'
  end
  # verify the required parameter 'ownership_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'ownership_account_id' when calling OwnershipAccountTransactionsApi.create_ownership_account_credit"
  end
  # verify the required parameter 'ownership_account_credit_post_message' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'ownership_account_credit_post_message' when calling OwnershipAccountTransactionsApi.create_ownership_account_credit"
  end
  # resource path
  local_var_path = '/v1/associations/ownershipaccounts/{ownershipAccountId}/credits'.sub('{' + 'ownershipAccountId' + '}', CGI.escape(.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'])
  # 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()

  # return_type
  return_type = opts[:debug_return_type] || 'OwnershipAccountTransactionMessage'

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

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

#create_ownership_account_deposit_withholding(ownership_account_id, ownership_account_deposit_withholding_post_message, opts = {}) ⇒ OwnershipAccountTransactionMessage

Create a deposit withholding Withholds an association owner deposit by reallocating the funds from a liability account to an income account to cover an expense(s). <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Associations &gt; Ownership account transactions</span> - ‘View` `Edit` <span class="permissionBlock">Accounting &gt; General Ledger Accounts</span> - `View`

Parameters:

Returns:



250
251
252
253
 
# File 'lib/buildium-ruby/api/ownership_account_transactions_api.rb', line 250

def (, , opts = {})
  data, _status_code, _headers = (, , opts)
  data
end

#create_ownership_account_deposit_withholding_with_http_info(ownership_account_id, ownership_account_deposit_withholding_post_message, opts = {}) ⇒ Array<(OwnershipAccountTransactionMessage, Integer, Hash)>

Create a deposit withholding Withholds an association owner deposit by reallocating the funds from a liability account to an income account to cover an expense(s). &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Associations &amp;gt; Ownership account transactions&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60; &lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Accounting &amp;gt; General Ledger Accounts&lt;/span&gt; - &#x60;View&#x60;

Parameters:

Returns:



261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/buildium-ruby/api/ownership_account_transactions_api.rb', line 261

def (, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OwnershipAccountTransactionsApi.create_ownership_account_deposit_withholding ...'
  end
  # verify the required parameter 'ownership_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'ownership_account_id' when calling OwnershipAccountTransactionsApi.create_ownership_account_deposit_withholding"
  end
  # verify the required parameter 'ownership_account_deposit_withholding_post_message' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'ownership_account_deposit_withholding_post_message' when calling OwnershipAccountTransactionsApi.create_ownership_account_deposit_withholding"
  end
  # resource path
  local_var_path = '/v1/associations/ownershipaccounts/{ownershipAccountId}/applieddeposits'.sub('{' + 'ownershipAccountId' + '}', CGI.escape(.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'])
  # 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()

  # return_type
  return_type = opts[:debug_return_type] || 'OwnershipAccountTransactionMessage'

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

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

#create_ownership_account_ledger_charge(ownership_account_id, ownership_account_ledger_charge_post_message, opts = {}) ⇒ OwnershipAccountTransactionMessage

Create a charge Creates a ledger charge. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Associations &gt; Ownership account transactions</span> - ‘View` `Edit` <br />

Parameters:

  • ownership_account_id (Integer) —

    The ownership account identifier.

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

    the optional parameters

Returns:



324
325
326
327
 
# File 'lib/buildium-ruby/api/ownership_account_transactions_api.rb', line 324

def (, , opts = {})
  data, _status_code, _headers = (, , opts)
  data
end

#create_ownership_account_ledger_charge_with_http_info(ownership_account_id, ownership_account_ledger_charge_post_message, opts = {}) ⇒ Array<(OwnershipAccountTransactionMessage, Integer, Hash)>

Create a charge Creates a ledger charge. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Associations &amp;gt; Ownership account transactions&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60; &lt;br /&gt;

Parameters:

  • ownership_account_id (Integer) —

    The ownership account identifier.

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

    the optional parameters

Returns:



335
336
337
338
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
386
387
388
389
390
 
# File 'lib/buildium-ruby/api/ownership_account_transactions_api.rb', line 335

def (, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OwnershipAccountTransactionsApi.create_ownership_account_ledger_charge ...'
  end
  # verify the required parameter 'ownership_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'ownership_account_id' when calling OwnershipAccountTransactionsApi.create_ownership_account_ledger_charge"
  end
  # verify the required parameter 'ownership_account_ledger_charge_post_message' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'ownership_account_ledger_charge_post_message' when calling OwnershipAccountTransactionsApi.create_ownership_account_ledger_charge"
  end
  # resource path
  local_var_path = '/v1/associations/ownershipaccounts/{ownershipAccountId}/charges'.sub('{' + 'ownershipAccountId' + '}', CGI.escape(.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'])
  # 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()

  # return_type
  return_type = opts[:debug_return_type] || 'OwnershipAccountTransactionMessage'

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

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

#create_ownership_account_ledger_payment(ownership_account_id, ownership_account_ledger_payment_post_message, opts = {}) ⇒ OwnershipAccountTransactionMessage

Create a payment Creates a ledger payment. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Associations &gt; Ownership account transactions</span> - ‘View` `Edit`

Parameters:

Returns:



398
399
400
401
 
# File 'lib/buildium-ruby/api/ownership_account_transactions_api.rb', line 398

def (, , opts = {})
  data, _status_code, _headers = (, , opts)
  data
end

#create_ownership_account_ledger_payment_with_http_info(ownership_account_id, ownership_account_ledger_payment_post_message, opts = {}) ⇒ Array<(OwnershipAccountTransactionMessage, Integer, Hash)>

Create a payment Creates a ledger payment. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Associations &amp;gt; Ownership account transactions&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;

Parameters:

Returns:



409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
 
# File 'lib/buildium-ruby/api/ownership_account_transactions_api.rb', line 409

def (, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OwnershipAccountTransactionsApi.create_ownership_account_ledger_payment ...'
  end
  # verify the required parameter 'ownership_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'ownership_account_id' when calling OwnershipAccountTransactionsApi.create_ownership_account_ledger_payment"
  end
  # verify the required parameter 'ownership_account_ledger_payment_post_message' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'ownership_account_ledger_payment_post_message' when calling OwnershipAccountTransactionsApi.create_ownership_account_ledger_payment"
  end
  # resource path
  local_var_path = '/v1/associations/ownershipaccounts/{ownershipAccountId}/payments'.sub('{' + 'ownershipAccountId' + '}', CGI.escape(.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'])
  # 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()

  # return_type
  return_type = opts[:debug_return_type] || 'OwnershipAccountTransactionMessage'

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

  new_options = opts.merge(
    :operation => :"OwnershipAccountTransactionsApi.create_ownership_account_ledger_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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OwnershipAccountTransactionsApi#create_ownership_account_ledger_payment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_ownership_account_recurring_payment(ownership_account_id, payment_recurring_transaction_post_message, opts = {}) ⇒ OwnershipAccountRecurringPaymentMessage

Create a recurring payment Creates a recurring payment that will post automatically on the specified ownership account ledger. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Associations &gt; Ownership account transactions</span> - ‘View` `Edit`

Parameters:

Returns:



472
473
474
475
 
# File 'lib/buildium-ruby/api/ownership_account_transactions_api.rb', line 472

def (, payment_recurring_transaction_post_message, opts = {})
  data, _status_code, _headers = (, payment_recurring_transaction_post_message, opts)
  data
end

#create_ownership_account_recurring_payment_with_http_info(ownership_account_id, payment_recurring_transaction_post_message, opts = {}) ⇒ Array<(OwnershipAccountRecurringPaymentMessage, Integer, Hash)>

Create a recurring payment Creates a recurring payment that will post automatically on the specified ownership account ledger. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Associations &amp;gt; Ownership account transactions&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;

Parameters:

Returns:



483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
 
# File 'lib/buildium-ruby/api/ownership_account_transactions_api.rb', line 483

def (, payment_recurring_transaction_post_message, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OwnershipAccountTransactionsApi.create_ownership_account_recurring_payment ...'
  end
  # verify the required parameter 'ownership_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'ownership_account_id' when calling OwnershipAccountTransactionsApi.create_ownership_account_recurring_payment"
  end
  # verify the required parameter 'payment_recurring_transaction_post_message' is set
  if @api_client.config.client_side_validation && payment_recurring_transaction_post_message.nil?
    fail ArgumentError, "Missing the required parameter 'payment_recurring_transaction_post_message' when calling OwnershipAccountTransactionsApi.create_ownership_account_recurring_payment"
  end
  # resource path
  local_var_path = '/v1/associations/ownershipaccounts/{ownershipAccountId}/recurringpayments'.sub('{' + 'ownershipAccountId' + '}', CGI.escape(.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'])
  # 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(payment_recurring_transaction_post_message)

  # return_type
  return_type = opts[:debug_return_type] || 'OwnershipAccountRecurringPaymentMessage'

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

  new_options = opts.merge(
    :operation => :"OwnershipAccountTransactionsApi.create_ownership_account_recurring_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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OwnershipAccountTransactionsApi#create_ownership_account_recurring_payment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_ownership_account_refund(ownership_account_id, ownership_account_refund_post_message, opts = {}) ⇒ OwnershipAccountRefundMessage

Create a refund Creates a refund. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Accounting &gt; Bank Accounts</span> - ‘View` `Edit`

Parameters:

Returns:



546
547
548
549
 
# File 'lib/buildium-ruby/api/ownership_account_transactions_api.rb', line 546

def (, , opts = {})
  data, _status_code, _headers = (, , opts)
  data
end

#create_ownership_account_refund_with_http_info(ownership_account_id, ownership_account_refund_post_message, opts = {}) ⇒ Array<(OwnershipAccountRefundMessage, Integer, Hash)>

Create a refund Creates a refund. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Accounting &amp;gt; Bank Accounts&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;

Parameters:

Returns:



557
558
559
560
561
562
563
564
565
566
567
568
569
570
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
 
# File 'lib/buildium-ruby/api/ownership_account_transactions_api.rb', line 557

def (, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OwnershipAccountTransactionsApi.create_ownership_account_refund ...'
  end
  # verify the required parameter 'ownership_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'ownership_account_id' when calling OwnershipAccountTransactionsApi.create_ownership_account_refund"
  end
  # verify the required parameter 'ownership_account_refund_post_message' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'ownership_account_refund_post_message' when calling OwnershipAccountTransactionsApi.create_ownership_account_refund"
  end
  # resource path
  local_var_path = '/v1/associations/ownershipaccounts/{ownershipAccountId}/refunds'.sub('{' + 'ownershipAccountId' + '}', CGI.escape(.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'])
  # 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()

  # return_type
  return_type = opts[:debug_return_type] || 'OwnershipAccountRefundMessage'

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

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

#create_ownership_accounts_charge_recurring_transaction(ownership_account_id, charge_recurring_transaction_post_message, opts = {}) ⇒ OwnershipAccountChargeRecurringTransactionMessage

Create a recurring charge Creates a recurring charge transaction that will post automatically on the specified ownership account ledger. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Associations &gt; Ownership account transactions</span> - ‘View` `Edit`

Parameters:

Returns:



620
621
622
623
 
# File 'lib/buildium-ruby/api/ownership_account_transactions_api.rb', line 620

def create_ownership_accounts_charge_recurring_transaction(, charge_recurring_transaction_post_message, opts = {})
  data, _status_code, _headers = create_ownership_accounts_charge_recurring_transaction_with_http_info(, charge_recurring_transaction_post_message, opts)
  data
end

#create_ownership_accounts_charge_recurring_transaction_with_http_info(ownership_account_id, charge_recurring_transaction_post_message, opts = {}) ⇒ Array<(OwnershipAccountChargeRecurringTransactionMessage, Integer, Hash)>

Create a recurring charge Creates a recurring charge transaction that will post automatically on the specified ownership account ledger. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Associations &amp;gt; Ownership account transactions&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;

Parameters:

Returns:



631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
 
# File 'lib/buildium-ruby/api/ownership_account_transactions_api.rb', line 631

def create_ownership_accounts_charge_recurring_transaction_with_http_info(, charge_recurring_transaction_post_message, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OwnershipAccountTransactionsApi.create_ownership_accounts_charge_recurring_transaction ...'
  end
  # verify the required parameter 'ownership_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'ownership_account_id' when calling OwnershipAccountTransactionsApi.create_ownership_accounts_charge_recurring_transaction"
  end
  # verify the required parameter 'charge_recurring_transaction_post_message' is set
  if @api_client.config.client_side_validation && charge_recurring_transaction_post_message.nil?
    fail ArgumentError, "Missing the required parameter 'charge_recurring_transaction_post_message' when calling OwnershipAccountTransactionsApi.create_ownership_accounts_charge_recurring_transaction"
  end
  # resource path
  local_var_path = '/v1/associations/ownershipaccounts/{ownershipAccountId}/recurringcharges'.sub('{' + 'ownershipAccountId' + '}', CGI.escape(.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'])
  # 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(charge_recurring_transaction_post_message)

  # return_type
  return_type = opts[:debug_return_type] || 'OwnershipAccountChargeRecurringTransactionMessage'

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

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

#get_association_recurring_transaction(ownership_account_id, opts = {}) ⇒ Array<RecurringTransactionMessage>

Retrieve all recurring transactions Retrieves all recurring transactions for an ownership account. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Associations &gt; Ownership account transactions</span> - ‘View`

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :orderby (String) —

    &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;&quot;#section/API-Overview/Bulk-Request-Options&quot;&gt;Bulk Request Options&lt;/a&gt; for more information.

  • :offset (Integer) —

    &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0.

  • :limit (Integer) —

    &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 1000 and the default is 50.

Returns:



696
697
698
699
 
# File 'lib/buildium-ruby/api/ownership_account_transactions_api.rb', line 696

def get_association_recurring_transaction(, opts = {})
  data, _status_code, _headers = get_association_recurring_transaction_with_http_info(, opts)
  data
end

#get_association_recurring_transaction_with_http_info(ownership_account_id, opts = {}) ⇒ Array<(Array<RecurringTransactionMessage>, Integer, Hash)>

Retrieve all recurring transactions Retrieves all recurring transactions for an ownership account. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Associations &amp;gt; Ownership account transactions&lt;/span&gt; - &#x60;View&#x60;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :orderby (String) —

    &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;&quot;#section/API-Overview/Bulk-Request-Options&quot;&gt;Bulk Request Options&lt;/a&gt; for more information.

  • :offset (Integer) —

    &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0.

  • :limit (Integer) —

    &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 1000 and the default is 50.

Returns:

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

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



709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
 
# File 'lib/buildium-ruby/api/ownership_account_transactions_api.rb', line 709

def get_association_recurring_transaction_with_http_info(, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OwnershipAccountTransactionsApi.get_association_recurring_transaction ...'
  end
  # verify the required parameter 'ownership_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'ownership_account_id' when calling OwnershipAccountTransactionsApi.get_association_recurring_transaction"
  end
  # resource path
  local_var_path = '/v1/associations/ownershipaccounts/{ownershipAccountId}/recurringtransactions'.sub('{' + 'ownershipAccountId' + '}', CGI.escape(.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

  # 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<RecurringTransactionMessage>'

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

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

#get_ownership_account_ledger(ownership_account_id, opts = {}) ⇒ Array<OwnershipAccountTransactionMessage>

Retrieve all transactions Retrieves all ledger transactions for a specific ownership account. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Associations &gt; Ownership account transactions</span> - ‘View`

Parameters:

  • ownership_account_id (Integer) —

    The ownership account identifier.

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

    the optional parameters

Options Hash (opts):

  • :transactiondatefrom (Date) —

    Filters results to any lease transaction whose start date is greater than or equal to the specified value.

  • :transactiondateto (Date) —

    Filters results to any lease transaction whose end date is less than or equal to the specified value.

  • :transactiontypes (Array<String>) —

    Filters results to any lease transaction whose lease transaction type matches the specified status. If no type is specified, lease transactions with any type will be returned.

  • :orderby (String) —

    &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;&quot;#section/API-Overview/Bulk-Request-Options&quot;&gt;Bulk Request Options&lt;/a&gt; for more information.

  • :offset (Integer) —

    &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0.

  • :limit (Integer) —

    &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 1000 and the default is 50.

Returns:



771
772
773
774
 
# File 'lib/buildium-ruby/api/ownership_account_transactions_api.rb', line 771

def (, opts = {})
  data, _status_code, _headers = (, opts)
  data
end

#get_ownership_account_ledger_with_http_info(ownership_account_id, opts = {}) ⇒ Array<(Array<OwnershipAccountTransactionMessage>, Integer, Hash)>

Retrieve all transactions Retrieves all ledger transactions for a specific ownership account. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Associations &amp;gt; Ownership account transactions&lt;/span&gt; - &#x60;View&#x60;

Parameters:

  • ownership_account_id (Integer) —

    The ownership account identifier.

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

    the optional parameters

Options Hash (opts):

  • :transactiondatefrom (Date) —

    Filters results to any lease transaction whose start date is greater than or equal to the specified value.

  • :transactiondateto (Date) —

    Filters results to any lease transaction whose end date is less than or equal to the specified value.

  • :transactiontypes (Array<String>) —

    Filters results to any lease transaction whose lease transaction type matches the specified status. If no type is specified, lease transactions with any type will be returned.

  • :orderby (String) —

    &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;&quot;#section/API-Overview/Bulk-Request-Options&quot;&gt;Bulk Request Options&lt;/a&gt; for more information.

  • :offset (Integer) —

    &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0.

  • :limit (Integer) —

    &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 1000 and the default is 50.

Returns:



787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
 
# File 'lib/buildium-ruby/api/ownership_account_transactions_api.rb', line 787

def (, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OwnershipAccountTransactionsApi.get_ownership_account_ledger ...'
  end
  # verify the required parameter 'ownership_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'ownership_account_id' when calling OwnershipAccountTransactionsApi.get_ownership_account_ledger"
  end
  allowable_values = ["Bill", "Check", "Charge", "Payment", "Credit", "Refund", "ApplyDeposit", "ElectronicFundsTransfer", "Other", "Deposit", "GeneralJournalEntry", "OwnerContribution", "ReversePayment", "ReverseElectronicFundsTransfer", "VendorCredit", "RentalApplicationFeePayment", "ReverseRentalApplicationFeePayment", "ReverseOwnerContribution", "VendorRefund", "UnreversedPayment", "UnreversedElectronicFundsTransfer", "UnreversedOwnerContribution", "UnreversedRentalApplicationFeePayment"]
  if @api_client.config.client_side_validation && opts[:'transactiontypes'] && !opts[:'transactiontypes'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"transactiontypes\", must include one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/v1/associations/ownershipaccounts/{ownershipAccountId}/transactions'.sub('{' + 'ownershipAccountId' + '}', CGI.escape(.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'transactiondatefrom'] = opts[:'transactiondatefrom'] if !opts[:'transactiondatefrom'].nil?
  query_params[:'transactiondateto'] = opts[:'transactiondateto'] if !opts[:'transactiondateto'].nil?
  query_params[:'transactiontypes'] = @api_client.build_collection_param(opts[:'transactiontypes'], :multi) if !opts[:'transactiontypes'].nil?
  query_params[:'orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

  # 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<OwnershipAccountTransactionMessage>'

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

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

#get_ownership_account_outstanding_balances(opts = {}) ⇒ Array<OwnershipAccountOutstandingBalanceMessage>

Retrieve all outstanding balances Retrieves a list of ownership account outstanding balances. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Associations &gt; Outstanding Balances</span> - ‘View`

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :associationid (Integer) —

    Association unique identifier

  • :ownershipaccountstatuses (Array<String>) —

    List of ownership account statuses

  • :ownershipaccountids (Array<Integer>) —

    List of ownership account ids

  • :pastdueemail (String) —

    Status of notification of outstanding balances

  • :balanceduration (String) —

    Duration of outstanding balances

  • :orderby (String) —

    &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;&quot;#section/API-Overview/Bulk-Request-Options&quot;&gt;Bulk Request Options&lt;/a&gt; for more information.

  • :offset (Integer) —

    &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0.

  • :limit (Integer) —

    &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 1000 and the default is 50.

Returns:



857
858
859
860
 
# File 'lib/buildium-ruby/api/ownership_account_transactions_api.rb', line 857

def (opts = {})
  data, _status_code, _headers = (opts)
  data
end

#get_ownership_account_outstanding_balances_with_http_info(opts = {}) ⇒ Array<(Array<OwnershipAccountOutstandingBalanceMessage>, Integer, Hash)>

Retrieve all outstanding balances Retrieves a list of ownership account outstanding balances. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Associations &amp;gt; Outstanding Balances&lt;/span&gt; - &#x60;View&#x60;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :associationid (Integer) —

    Association unique identifier

  • :ownershipaccountstatuses (Array<String>) —

    List of ownership account statuses

  • :ownershipaccountids (Array<Integer>) —

    List of ownership account ids

  • :pastdueemail (String) —

    Status of notification of outstanding balances

  • :balanceduration (String) —

    Duration of outstanding balances

  • :orderby (String) —

    &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;&quot;#section/API-Overview/Bulk-Request-Options&quot;&gt;Bulk Request Options&lt;/a&gt; for more information.

  • :offset (Integer) —

    &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0.

  • :limit (Integer) —

    &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 1000 and the default is 50.

Returns:



874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
 
# File 'lib/buildium-ruby/api/ownership_account_transactions_api.rb', line 874

def (opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OwnershipAccountTransactionsApi.get_ownership_account_outstanding_balances ...'
  end
  allowable_values = ["Active", "Past", "Future"]
  if @api_client.config.client_side_validation && opts[:'ownershipaccountstatuses'] && !opts[:'ownershipaccountstatuses'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"ownershipaccountstatuses\", must include one of #{allowable_values}"
  end
  allowable_values = ["NoEmailAddress", "Sent"]
  if @api_client.config.client_side_validation && opts[:'pastdueemail'] && !allowable_values.include?(opts[:'pastdueemail'])
    fail ArgumentError, "invalid value for \"pastdueemail\", must be one of #{allowable_values}"
  end
  allowable_values = ["TotalBalance", "Balance0to30Days", "Balance31to60Days", "Balance61to90Days", "BalanceOver90Days"]
  if @api_client.config.client_side_validation && opts[:'balanceduration'] && !allowable_values.include?(opts[:'balanceduration'])
    fail ArgumentError, "invalid value for \"balanceduration\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/v1/associations/ownershipaccounts/outstandingbalances'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'associationid'] = opts[:'associationid'] if !opts[:'associationid'].nil?
  query_params[:'ownershipaccountstatuses'] = @api_client.build_collection_param(opts[:'ownershipaccountstatuses'], :multi) if !opts[:'ownershipaccountstatuses'].nil?
  query_params[:'ownershipaccountids'] = @api_client.build_collection_param(opts[:'ownershipaccountids'], :multi) if !opts[:'ownershipaccountids'].nil?
  query_params[:'pastdueemail'] = opts[:'pastdueemail'] if !opts[:'pastdueemail'].nil?
  query_params[:'balanceduration'] = opts[:'balanceduration'] if !opts[:'balanceduration'].nil?
  query_params[:'orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

  # 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<OwnershipAccountOutstandingBalanceMessage>'

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

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

#get_ownership_account_recurring_credit_by_id(ownership_account_id, transaction_id, opts = {}) ⇒ OwnershipAccountRecurringCreditMessage

Retrieve a recurring credit Retrieves a recurring credit. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Associations &gt; Ownership account transactions</span> - ‘View`

Parameters:

  • ownership_account_id (Integer)
  • transaction_id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



944
945
946
947
 
# File 'lib/buildium-ruby/api/ownership_account_transactions_api.rb', line 944

def (, transaction_id, opts = {})
  data, _status_code, _headers = (, transaction_id, opts)
  data
end

#get_ownership_account_recurring_credit_by_id_with_http_info(ownership_account_id, transaction_id, opts = {}) ⇒ Array<(OwnershipAccountRecurringCreditMessage, Integer, Hash)>

Retrieve a recurring credit Retrieves a recurring credit. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Associations &amp;gt; Ownership account transactions&lt;/span&gt; - &#x60;View&#x60;

Parameters:

  • ownership_account_id (Integer)
  • transaction_id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
 
# File 'lib/buildium-ruby/api/ownership_account_transactions_api.rb', line 955

def (, transaction_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OwnershipAccountTransactionsApi.get_ownership_account_recurring_credit_by_id ...'
  end
  # verify the required parameter 'ownership_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'ownership_account_id' when calling OwnershipAccountTransactionsApi.get_ownership_account_recurring_credit_by_id"
  end
  # verify the required parameter 'transaction_id' is set
  if @api_client.config.client_side_validation && transaction_id.nil?
    fail ArgumentError, "Missing the required parameter 'transaction_id' when calling OwnershipAccountTransactionsApi.get_ownership_account_recurring_credit_by_id"
  end
  # resource path
  local_var_path = '/v1/associations/ownershipaccounts/{ownershipAccountId}/recurringcredits/{transactionId}'.sub('{' + 'ownershipAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'transactionId' + '}', CGI.escape(transaction_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] || 'OwnershipAccountRecurringCreditMessage'

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

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

#get_ownership_account_refund_by_id(ownership_account_id, refund_id, opts = {}) ⇒ OwnershipAccountRefundMessage

Retrieve a refund Retrieves a refund. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Accounting &gt; Bank Accounts</span> - ‘View`

Parameters:

  • ownership_account_id (Integer)
  • refund_id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1013
1014
1015
1016
 
# File 'lib/buildium-ruby/api/ownership_account_transactions_api.rb', line 1013

def (, refund_id, opts = {})
  data, _status_code, _headers = (, refund_id, opts)
  data
end

#get_ownership_account_refund_by_id_with_http_info(ownership_account_id, refund_id, opts = {}) ⇒ Array<(OwnershipAccountRefundMessage, Integer, Hash)>

Retrieve a refund Retrieves a refund. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Accounting &amp;gt; Bank Accounts&lt;/span&gt; - &#x60;View&#x60;

Parameters:

  • ownership_account_id (Integer)
  • refund_id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
 
# File 'lib/buildium-ruby/api/ownership_account_transactions_api.rb', line 1024

def (, refund_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OwnershipAccountTransactionsApi.get_ownership_account_refund_by_id ...'
  end
  # verify the required parameter 'ownership_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'ownership_account_id' when calling OwnershipAccountTransactionsApi.get_ownership_account_refund_by_id"
  end
  # verify the required parameter 'refund_id' is set
  if @api_client.config.client_side_validation && refund_id.nil?
    fail ArgumentError, "Missing the required parameter 'refund_id' when calling OwnershipAccountTransactionsApi.get_ownership_account_refund_by_id"
  end
  # resource path
  local_var_path = '/v1/associations/ownershipaccounts/{ownershipAccountId}/refunds/{refundId}'.sub('{' + 'ownershipAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'refundId' + '}', CGI.escape(refund_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] || 'OwnershipAccountRefundMessage'

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

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

#get_ownership_account_transaction_by_id(ownership_account_id, transaction_id, opts = {}) ⇒ OwnershipAccountTransactionMessage

Retrieve a transaction Retrieves a specific ownership account ledger transaction. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Associations &gt; Ownership account transactions</span> - ‘View`

Parameters:

  • ownership_account_id (Integer) —

    The ownership account identifier.

  • transaction_id (Integer) —

    The transaction identifier.

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

    the optional parameters

Returns:



1082
1083
1084
1085
 
# File 'lib/buildium-ruby/api/ownership_account_transactions_api.rb', line 1082

def (, transaction_id, opts = {})
  data, _status_code, _headers = (, transaction_id, opts)
  data
end

#get_ownership_account_transaction_by_id_with_http_info(ownership_account_id, transaction_id, opts = {}) ⇒ Array<(OwnershipAccountTransactionMessage, Integer, Hash)>

Retrieve a transaction Retrieves a specific ownership account ledger transaction. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Associations &amp;gt; Ownership account transactions&lt;/span&gt; - &#x60;View&#x60;

Parameters:

  • ownership_account_id (Integer) —

    The ownership account identifier.

  • transaction_id (Integer) —

    The transaction identifier.

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

    the optional parameters

Returns:



1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
 
# File 'lib/buildium-ruby/api/ownership_account_transactions_api.rb', line 1093

def (, transaction_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OwnershipAccountTransactionsApi.get_ownership_account_transaction_by_id ...'
  end
  # verify the required parameter 'ownership_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'ownership_account_id' when calling OwnershipAccountTransactionsApi.get_ownership_account_transaction_by_id"
  end
  # verify the required parameter 'transaction_id' is set
  if @api_client.config.client_side_validation && transaction_id.nil?
    fail ArgumentError, "Missing the required parameter 'transaction_id' when calling OwnershipAccountTransactionsApi.get_ownership_account_transaction_by_id"
  end
  # resource path
  local_var_path = '/v1/associations/ownershipaccounts/{ownershipAccountId}/transactions/{transactionId}'.sub('{' + 'ownershipAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'transactionId' + '}', CGI.escape(transaction_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] || 'OwnershipAccountTransactionMessage'

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

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

#get_ownership_accounts_charge_recurring_transaction_by_id(ownership_account_id, transaction_id, opts = {}) ⇒ OwnershipAccountChargeRecurringTransactionMessage

Retrieve a recurring charge Retrieves a recurring charge. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Associations &gt; Ownership account transactions</span> - ‘View`

Parameters:

  • ownership_account_id (Integer)
  • transaction_id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1151
1152
1153
1154
 
# File 'lib/buildium-ruby/api/ownership_account_transactions_api.rb', line 1151

def get_ownership_accounts_charge_recurring_transaction_by_id(, transaction_id, opts = {})
  data, _status_code, _headers = get_ownership_accounts_charge_recurring_transaction_by_id_with_http_info(, transaction_id, opts)
  data
end

#get_ownership_accounts_charge_recurring_transaction_by_id_with_http_info(ownership_account_id, transaction_id, opts = {}) ⇒ Array<(OwnershipAccountChargeRecurringTransactionMessage, Integer, Hash)>

Retrieve a recurring charge Retrieves a recurring charge. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Associations &amp;gt; Ownership account transactions&lt;/span&gt; - &#x60;View&#x60;

Parameters:

  • ownership_account_id (Integer)
  • transaction_id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
 
# File 'lib/buildium-ruby/api/ownership_account_transactions_api.rb', line 1162

def get_ownership_accounts_charge_recurring_transaction_by_id_with_http_info(, transaction_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OwnershipAccountTransactionsApi.get_ownership_accounts_charge_recurring_transaction_by_id ...'
  end
  # verify the required parameter 'ownership_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'ownership_account_id' when calling OwnershipAccountTransactionsApi.get_ownership_accounts_charge_recurring_transaction_by_id"
  end
  # verify the required parameter 'transaction_id' is set
  if @api_client.config.client_side_validation && transaction_id.nil?
    fail ArgumentError, "Missing the required parameter 'transaction_id' when calling OwnershipAccountTransactionsApi.get_ownership_accounts_charge_recurring_transaction_by_id"
  end
  # resource path
  local_var_path = '/v1/associations/ownershipaccounts/{ownershipAccountId}/recurringcharges/{transactionId}'.sub('{' + 'ownershipAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'transactionId' + '}', CGI.escape(transaction_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] || 'OwnershipAccountChargeRecurringTransactionMessage'

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

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

#get_recurring_ownership_account_payments_by_id(ownership_account_id, payment_id, opts = {}) ⇒ OwnershipAccountRecurringPaymentMessage

Retrieve a recurring payment Retrieves a recurring payment. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Associations &gt; Ownership account transactions</span> - ‘View`

Parameters:

  • ownership_account_id (Integer)
  • payment_id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1220
1221
1222
1223
 
# File 'lib/buildium-ruby/api/ownership_account_transactions_api.rb', line 1220

def (, payment_id, opts = {})
  data, _status_code, _headers = (, payment_id, opts)
  data
end

#get_recurring_ownership_account_payments_by_id_with_http_info(ownership_account_id, payment_id, opts = {}) ⇒ Array<(OwnershipAccountRecurringPaymentMessage, Integer, Hash)>

Retrieve a recurring payment Retrieves a recurring payment. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Associations &amp;gt; Ownership account transactions&lt;/span&gt; - &#x60;View&#x60;

Parameters:

  • ownership_account_id (Integer)
  • payment_id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
 
# File 'lib/buildium-ruby/api/ownership_account_transactions_api.rb', line 1231

def (, payment_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OwnershipAccountTransactionsApi.get_recurring_ownership_account_payments_by_id ...'
  end
  # verify the required parameter 'ownership_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'ownership_account_id' when calling OwnershipAccountTransactionsApi.get_recurring_ownership_account_payments_by_id"
  end
  # verify the required parameter 'payment_id' is set
  if @api_client.config.client_side_validation && payment_id.nil?
    fail ArgumentError, "Missing the required parameter 'payment_id' when calling OwnershipAccountTransactionsApi.get_recurring_ownership_account_payments_by_id"
  end
  # resource path
  local_var_path = '/v1/associations/ownershipaccounts/{ownershipAccountId}/recurringpayments/{paymentId}'.sub('{' + 'ownershipAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'paymentId' + '}', CGI.escape(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] || 'OwnershipAccountRecurringPaymentMessage'

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

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

#update_ownership_account_charge(ownership_account_id, charge_id, ownership_account_ledger_charge_put_message, opts = {}) ⇒ OwnershipAccountTransactionMessage

Update a charge Updates a charge. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Associations &gt; Ownership account transactions</span> - ‘View` `Edit` <br />

Parameters:

  • ownership_account_id (Integer) —

    The ownership account identifier.

  • charge_id (Integer) —

    The charge identifier.

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

    the optional parameters

Returns:



1290
1291
1292
1293
 
# File 'lib/buildium-ruby/api/ownership_account_transactions_api.rb', line 1290

def (, charge_id, , opts = {})
  data, _status_code, _headers = (, charge_id, , opts)
  data
end

#update_ownership_account_charge_with_http_info(ownership_account_id, charge_id, ownership_account_ledger_charge_put_message, opts = {}) ⇒ Array<(OwnershipAccountTransactionMessage, Integer, Hash)>

Update a charge Updates a charge. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Associations &amp;gt; Ownership account transactions&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60; &lt;br /&gt;

Parameters:

  • ownership_account_id (Integer) —

    The ownership account identifier.

  • charge_id (Integer) —

    The charge identifier.

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

    the optional parameters

Returns:



1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
 
# File 'lib/buildium-ruby/api/ownership_account_transactions_api.rb', line 1302

def (, charge_id, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OwnershipAccountTransactionsApi.update_ownership_account_charge ...'
  end
  # verify the required parameter 'ownership_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'ownership_account_id' when calling OwnershipAccountTransactionsApi.update_ownership_account_charge"
  end
  # verify the required parameter 'charge_id' is set
  if @api_client.config.client_side_validation && charge_id.nil?
    fail ArgumentError, "Missing the required parameter 'charge_id' when calling OwnershipAccountTransactionsApi.update_ownership_account_charge"
  end
  # verify the required parameter 'ownership_account_ledger_charge_put_message' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'ownership_account_ledger_charge_put_message' when calling OwnershipAccountTransactionsApi.update_ownership_account_charge"
  end
  # resource path
  local_var_path = '/v1/associations/ownershipaccounts/{ownershipAccountId}/charges/{chargeId}'.sub('{' + 'ownershipAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'chargeId' + '}', CGI.escape(charge_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'])
  # 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()

  # return_type
  return_type = opts[:debug_return_type] || 'OwnershipAccountTransactionMessage'

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

  new_options = opts.merge(
    :operation => :"OwnershipAccountTransactionsApi.update_ownership_account_charge",
    :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(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OwnershipAccountTransactionsApi#update_ownership_account_charge\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_ownership_account_ledger_payment(ownership_account_id, payment_id, ownership_account_ledger_payment_put_message, opts = {}) ⇒ OwnershipAccountTransactionMessage

Update a payment Updates a ledger payment. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Associations &gt; Ownership account transactions</span> - ‘View` `Edit`

Parameters:

  • ownership_account_id (Integer)
  • payment_id (Integer)
  • ownership_account_ledger_payment_put_message (OwnershipAccountLedgerPaymentPutMessage)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1370
1371
1372
1373
 
# File 'lib/buildium-ruby/api/ownership_account_transactions_api.rb', line 1370

def (, payment_id, , opts = {})
  data, _status_code, _headers = (, payment_id, , opts)
  data
end

#update_ownership_account_ledger_payment_with_http_info(ownership_account_id, payment_id, ownership_account_ledger_payment_put_message, opts = {}) ⇒ Array<(OwnershipAccountTransactionMessage, Integer, Hash)>

Update a payment Updates a ledger payment. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Associations &amp;gt; Ownership account transactions&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;

Parameters:

  • ownership_account_id (Integer)
  • payment_id (Integer)
  • ownership_account_ledger_payment_put_message (OwnershipAccountLedgerPaymentPutMessage)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
 
# File 'lib/buildium-ruby/api/ownership_account_transactions_api.rb', line 1382

def (, payment_id, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OwnershipAccountTransactionsApi.update_ownership_account_ledger_payment ...'
  end
  # verify the required parameter 'ownership_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'ownership_account_id' when calling OwnershipAccountTransactionsApi.update_ownership_account_ledger_payment"
  end
  # verify the required parameter 'payment_id' is set
  if @api_client.config.client_side_validation && payment_id.nil?
    fail ArgumentError, "Missing the required parameter 'payment_id' when calling OwnershipAccountTransactionsApi.update_ownership_account_ledger_payment"
  end
  # verify the required parameter 'ownership_account_ledger_payment_put_message' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'ownership_account_ledger_payment_put_message' when calling OwnershipAccountTransactionsApi.update_ownership_account_ledger_payment"
  end
  # resource path
  local_var_path = '/v1/associations/ownershipaccounts/{ownershipAccountId}/payments/{paymentId}'.sub('{' + 'ownershipAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'paymentId' + '}', CGI.escape(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'])
  # 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()

  # return_type
  return_type = opts[:debug_return_type] || 'OwnershipAccountTransactionMessage'

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

  new_options = opts.merge(
    :operation => :"OwnershipAccountTransactionsApi.update_ownership_account_ledger_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(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OwnershipAccountTransactionsApi#update_ownership_account_ledger_payment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end