Class: Buildium::BankAccountsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ BankAccountsApi

Returns a new instance of BankAccountsApi.



19
20
21
 
# File 'lib/buildium-ruby/api/bank_accounts_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/bank_accounts_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_bank_account(bank_account_post_message, opts = {}) ⇒ BankAccountMessage

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

Parameters:

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

    the optional parameters

Returns:



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

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

#create_bank_account_check(bank_account_id, bank_account_check_post_message, opts = {}) ⇒ BankAccountCheckMessage

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

Parameters:

  • bank_account_id (Integer)
  • bank_account_check_post_message (BankAccountCheckPostMessage)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



96
97
98
99
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 96

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

#create_bank_account_check_with_http_info(bank_account_id, bank_account_check_post_message, opts = {}) ⇒ Array<(BankAccountCheckMessage, Integer, Hash)>

Create a check Creates a check. &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:

  • bank_account_id (Integer)
  • bank_account_check_post_message (BankAccountCheckPostMessage)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    BankAccountCheckMessage data, response status code and response headers



107
108
109
110
111
112
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
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 107

def (, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BankAccountsApi.create_bank_account_check ...'
  end
  # verify the required parameter 'bank_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'bank_account_id' when calling BankAccountsApi.create_bank_account_check"
  end
  # verify the required parameter 'bank_account_check_post_message' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'bank_account_check_post_message' when calling BankAccountsApi.create_bank_account_check"
  end
  # resource path
  local_var_path = '/v1/bankaccounts/{bankAccountId}/checks'.sub('{' + 'bankAccountId' + '}', 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] || 'BankAccountCheckMessage'

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

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

#create_bank_account_deposit(bank_account_id, bank_account_deposit_post_message, opts = {}) ⇒ BankAccountDepositMessage

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

Parameters:

  • bank_account_id (Integer)
  • bank_account_deposit_post_message (BankAccountDepositPostMessage)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



170
171
172
173
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 170

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

#create_bank_account_deposit_with_http_info(bank_account_id, bank_account_deposit_post_message, opts = {}) ⇒ Array<(BankAccountDepositMessage, Integer, Hash)>

Create a deposit Creates a deposit. &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:

  • bank_account_id (Integer)
  • bank_account_deposit_post_message (BankAccountDepositPostMessage)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    BankAccountDepositMessage data, response status code and response headers



181
182
183
184
185
186
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
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 181

def (, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BankAccountsApi.create_bank_account_deposit ...'
  end
  # verify the required parameter 'bank_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'bank_account_id' when calling BankAccountsApi.create_bank_account_deposit"
  end
  # verify the required parameter 'bank_account_deposit_post_message' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'bank_account_deposit_post_message' when calling BankAccountsApi.create_bank_account_deposit"
  end
  # resource path
  local_var_path = '/v1/bankaccounts/{bankAccountId}/deposits'.sub('{' + 'bankAccountId' + '}', 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] || 'BankAccountDepositMessage'

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

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

#create_bank_account_transfer(bank_account_id, bank_account_transfer_save_message, opts = {}) ⇒ BankAccountTransferMessage

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

Parameters:

  • bank_account_id (Integer)
  • bank_account_transfer_save_message (BankAccountTransferSaveMessage)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



244
245
246
247
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 244

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

#create_bank_account_transfer_with_http_info(bank_account_id, bank_account_transfer_save_message, opts = {}) ⇒ Array<(BankAccountTransferMessage, Integer, Hash)>

Create a transfer Creates a bank account transfer. &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:

  • bank_account_id (Integer)
  • bank_account_transfer_save_message (BankAccountTransferSaveMessage)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    BankAccountTransferMessage data, response status code and response headers



255
256
257
258
259
260
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
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 255

def (, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BankAccountsApi.create_bank_account_transfer ...'
  end
  # verify the required parameter 'bank_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'bank_account_id' when calling BankAccountsApi.create_bank_account_transfer"
  end
  # verify the required parameter 'bank_account_transfer_save_message' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'bank_account_transfer_save_message' when calling BankAccountsApi.create_bank_account_transfer"
  end
  # resource path
  local_var_path = '/v1/bankaccounts/{bankAccountId}/transfers'.sub('{' + 'bankAccountId' + '}', 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] || 'BankAccountTransferMessage'

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

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

#create_bank_account_with_http_info(bank_account_post_message, opts = {}) ⇒ Array<(BankAccountMessage, Integer, Hash)>

Create a bank account Creates a bank account. &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; Banking&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;

Parameters:

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

    the optional parameters

Returns:

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

    BankAccountMessage data, response status code and response headers



37
38
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
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 37

def (, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BankAccountsApi.create_bank_account ...'
  end
  # verify the required parameter 'bank_account_post_message' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'bank_account_post_message' when calling BankAccountsApi.create_bank_account"
  end
  # resource path
  local_var_path = '/v1/bankaccounts'

  # 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] || 'BankAccountMessage'

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

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

#create_quick_deposit(bank_account_id, bank_account_quick_deposit_save_message, opts = {}) ⇒ BankAccountQuickDepositMessage

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

Parameters:

Returns:



318
319
320
321
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 318

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

#create_quick_deposit_with_http_info(bank_account_id, bank_account_quick_deposit_save_message, opts = {}) ⇒ Array<(BankAccountQuickDepositMessage, Integer, Hash)>

Create a quick deposit Creates a quick deposit. &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; BankAccount&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;

Parameters:

Returns:



329
330
331
332
333
334
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
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 329

def create_quick_deposit_with_http_info(, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BankAccountsApi.create_quick_deposit ...'
  end
  # verify the required parameter 'bank_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'bank_account_id' when calling BankAccountsApi.create_quick_deposit"
  end
  # verify the required parameter 'bank_account_quick_deposit_save_message' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'bank_account_quick_deposit_save_message' when calling BankAccountsApi.create_quick_deposit"
  end
  # resource path
  local_var_path = '/v1/bankaccounts/{bankAccountId}/quickdeposits'.sub('{' + 'bankAccountId' + '}', 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] || 'BankAccountQuickDepositMessage'

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

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

#create_withdrawal_for_bank_account(bank_account_id, bank_account_withdrawal_save_message, opts = {}) ⇒ BankAccountWithdrawalMessage

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

Parameters:

Returns:



392
393
394
395
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 392

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

#create_withdrawal_for_bank_account_with_http_info(bank_account_id, bank_account_withdrawal_save_message, opts = {}) ⇒ Array<(BankAccountWithdrawalMessage, Integer, Hash)>

Create a withdrawal Creates a bank account withdrawal. &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:



403
404
405
406
407
408
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
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 403

def (, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BankAccountsApi.create_withdrawal_for_bank_account ...'
  end
  # verify the required parameter 'bank_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'bank_account_id' when calling BankAccountsApi.create_withdrawal_for_bank_account"
  end
  # verify the required parameter 'bank_account_withdrawal_save_message' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'bank_account_withdrawal_save_message' when calling BankAccountsApi.create_withdrawal_for_bank_account"
  end
  # resource path
  local_var_path = '/v1/bankaccounts/{bankAccountId}/withdrawals'.sub('{' + 'bankAccountId' + '}', 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] || 'BankAccountWithdrawalMessage'

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

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

#get_all_bank_accounts(opts = {}) ⇒ Array<BankAccountMessage>

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

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :bankaccountstatus (String) —

    Filters results by the status of the bank account. If no status is specified, bank accounts with any status will be returned.

  • :bankname (String) —

    Filters results to any bank account whose name contains the specified value.

  • :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:



469
470
471
472
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 469

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

#get_all_bank_accounts_with_http_info(opts = {}) ⇒ Array<(Array<BankAccountMessage>, Integer, Hash)>

Retrieve all bank accounts Retrieves a list of bank accounts. &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:

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

    the optional parameters

Options Hash (opts):

  • :bankaccountstatus (String) —

    Filters results by the status of the bank account. If no status is specified, bank accounts with any status will be returned.

  • :bankname (String) —

    Filters results to any bank account whose name contains the specified value.

  • :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<BankAccountMessage>, Integer, Hash)>) —

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



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
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 483

def get_all_bank_accounts_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BankAccountsApi.get_all_bank_accounts ...'
  end
  allowable_values = ["Active", "InActive"]
  if @api_client.config.client_side_validation && opts[:'bankaccountstatus'] && !allowable_values.include?(opts[:'bankaccountstatus'])
    fail ArgumentError, "invalid value for \"bankaccountstatus\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/v1/bankaccounts'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'bankaccountstatus'] = opts[:'bankaccountstatus'] if !opts[:'bankaccountstatus'].nil?
  query_params[:'bankname'] = opts[:'bankname'] if !opts[:'bankname'].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<BankAccountMessage>'

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

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

#get_all_quick_deposits(bank_account_id, startdate, enddate, opts = {}) ⇒ Array<BankAccountQuickDepositMessage>

Retrieve all quick deposits Retrieves all quick deposits. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Accounting &gt; BankAccount</span> - ‘View`

Parameters:

  • bank_account_id (Integer)
  • startdate (Date) —

    Filters results to any transactions that were recorded on or after the specified date. The value must be formatted as YYYY-MM-DD.

  • enddate (Date) —

    Filters results to any transactions that were recorded on or before the specified date. The value must be formatted as YYYY-MM-DD.

  • 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:



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

def get_all_quick_deposits(, startdate, enddate, opts = {})
  data, _status_code, _headers = get_all_quick_deposits_with_http_info(, startdate, enddate, opts)
  data
end

#get_all_quick_deposits_with_http_info(bank_account_id, startdate, enddate, opts = {}) ⇒ Array<(Array<BankAccountQuickDepositMessage>, Integer, Hash)>

Retrieve all quick deposits Retrieves all quick deposits. &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; BankAccount&lt;/span&gt; - &#x60;View&#x60;

Parameters:

  • bank_account_id (Integer)
  • startdate (Date) —

    Filters results to any transactions that were recorded on or after the specified date. The value must be formatted as YYYY-MM-DD.

  • enddate (Date) —

    Filters results to any transactions that were recorded on or before the specified date. The value must be formatted as YYYY-MM-DD.

  • 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<BankAccountQuickDepositMessage>, Integer, Hash)>) —

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



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
613
614
615
616
617
618
619
620
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 561

def get_all_quick_deposits_with_http_info(, startdate, enddate, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BankAccountsApi.get_all_quick_deposits ...'
  end
  # verify the required parameter 'bank_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'bank_account_id' when calling BankAccountsApi.get_all_quick_deposits"
  end
  # verify the required parameter 'startdate' is set
  if @api_client.config.client_side_validation && startdate.nil?
    fail ArgumentError, "Missing the required parameter 'startdate' when calling BankAccountsApi.get_all_quick_deposits"
  end
  # verify the required parameter 'enddate' is set
  if @api_client.config.client_side_validation && enddate.nil?
    fail ArgumentError, "Missing the required parameter 'enddate' when calling BankAccountsApi.get_all_quick_deposits"
  end
  # resource path
  local_var_path = '/v1/bankaccounts/{bankAccountId}/quickdeposits'.sub('{' + 'bankAccountId' + '}', CGI.escape(.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'startdate'] = startdate
  query_params[:'enddate'] = enddate
  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<BankAccountQuickDepositMessage>'

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

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

#get_bank_account(bank_account_id, opts = {}) ⇒ BankAccountMessage

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

Parameters:

  • bank_account_id (Integer) —

    The bank account identifier.

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

    the optional parameters

Returns:



627
628
629
630
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 627

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

#get_bank_account_checks(bank_account_id, startdate, enddate, opts = {}) ⇒ Array<BankAccountCheckMessage>

Retrieve all checks Retrieves all bank account checks. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Accounting &gt; Bank Accounts</span> - ‘View` <br /><span class="permissionBlock">Accounting &gt; General Ledger Transactions</span> - `View` <span class="permissionBlock">(Required for checks associated with a Company) </span>

Parameters:

  • bank_account_id (Integer)
  • startdate (Date) —

    Filters results to any transactions that were recorded on or after the specified date. The value must be formatted as YYYY-MM-DD.

  • enddate (Date) —

    Filters results to any transactions that were recorded on or before the specified date. The value must be formatted as YYYY-MM-DD.

  • 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:



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

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

#get_bank_account_checks_with_http_info(bank_account_id, startdate, enddate, opts = {}) ⇒ Array<(Array<BankAccountCheckMessage>, Integer, Hash)>

Retrieve all checks Retrieves all bank account checks. &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; &lt;br /&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Accounting &amp;gt; General Ledger Transactions&lt;/span&gt; - &#x60;View&#x60; &lt;span class&#x3D;&quot;permissionBlock&quot;&gt;(Required for checks associated with a Company) &lt;/span&gt;

Parameters:

  • bank_account_id (Integer)
  • startdate (Date) —

    Filters results to any transactions that were recorded on or after the specified date. The value must be formatted as YYYY-MM-DD.

  • enddate (Date) —

    Filters results to any transactions that were recorded on or before the specified date. The value must be formatted as YYYY-MM-DD.

  • 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<BankAccountCheckMessage>, Integer, Hash)>) —

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



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
759
760
761
762
763
764
765
766
767
768
769
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 710

def (, startdate, enddate, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BankAccountsApi.get_bank_account_checks ...'
  end
  # verify the required parameter 'bank_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'bank_account_id' when calling BankAccountsApi.get_bank_account_checks"
  end
  # verify the required parameter 'startdate' is set
  if @api_client.config.client_side_validation && startdate.nil?
    fail ArgumentError, "Missing the required parameter 'startdate' when calling BankAccountsApi.get_bank_account_checks"
  end
  # verify the required parameter 'enddate' is set
  if @api_client.config.client_side_validation && enddate.nil?
    fail ArgumentError, "Missing the required parameter 'enddate' when calling BankAccountsApi.get_bank_account_checks"
  end
  # resource path
  local_var_path = '/v1/bankaccounts/{bankAccountId}/checks'.sub('{' + 'bankAccountId' + '}', CGI.escape(.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'startdate'] = startdate
  query_params[:'enddate'] = enddate
  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<BankAccountCheckMessage>'

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

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

#get_bank_account_deposit_by_id(bank_account_id, deposit_id, opts = {}) ⇒ BankAccountDepositMessage

Retrieve a deposit Retrieves a bank account deposit. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Accounting &gt; BankAccount</span> - ‘View` <br /><span class="permissionBlock">Accounting &gt; General Ledger Transactions</span> - `View` <span class="permissionBlock">(Required for deposits associated with a Company) </span>

Parameters:

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

    the optional parameters

Returns:



777
778
779
780
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 777

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

#get_bank_account_deposit_by_id_with_http_info(bank_account_id, deposit_id, opts = {}) ⇒ Array<(BankAccountDepositMessage, Integer, Hash)>

Retrieve a deposit Retrieves a bank account deposit. &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; BankAccount&lt;/span&gt; - &#x60;View&#x60; &lt;br /&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Accounting &amp;gt; General Ledger Transactions&lt;/span&gt; - &#x60;View&#x60; &lt;span class&#x3D;&quot;permissionBlock&quot;&gt;(Required for deposits associated with a Company) &lt;/span&gt;

Parameters:

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

    the optional parameters

Returns:

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

    BankAccountDepositMessage data, response status code and response headers



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
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 788

def (, deposit_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BankAccountsApi.get_bank_account_deposit_by_id ...'
  end
  # verify the required parameter 'bank_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'bank_account_id' when calling BankAccountsApi.get_bank_account_deposit_by_id"
  end
  # verify the required parameter 'deposit_id' is set
  if @api_client.config.client_side_validation && deposit_id.nil?
    fail ArgumentError, "Missing the required parameter 'deposit_id' when calling BankAccountsApi.get_bank_account_deposit_by_id"
  end
  # resource path
  local_var_path = '/v1/bankaccounts/{bankAccountId}/deposits/{depositId}'.sub('{' + 'bankAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'depositId' + '}', CGI.escape(deposit_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] || 'BankAccountDepositMessage'

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

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

#get_bank_account_deposits(bank_account_id, startdate, enddate, opts = {}) ⇒ Array<BankAccountDepositMessage>

Retrieve all deposits Retrieves all bank account deposits. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Accounting &gt; BankAccount</span> - ‘View` <br /><span class="permissionBlock">Accounting &gt; General Ledger Transactions</span> - `View` <span class="permissionBlock">(Required for deposits associated with a Company) </span>

Parameters:

  • bank_account_id (Integer)
  • startdate (Date) —

    Filters results to any deposits that were recorded on or after the specified date. The value must be formatted as YYYY-MM-DD.

  • enddate (Date) —

    Filters results to any deposits that were recorded on or before the specified date. The value must be formatted as YYYY-MM-DD.

  • 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:



850
851
852
853
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 850

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

#get_bank_account_deposits_with_http_info(bank_account_id, startdate, enddate, opts = {}) ⇒ Array<(Array<BankAccountDepositMessage>, Integer, Hash)>

Retrieve all deposits Retrieves all bank account deposits. &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; BankAccount&lt;/span&gt; - &#x60;View&#x60; &lt;br /&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Accounting &amp;gt; General Ledger Transactions&lt;/span&gt; - &#x60;View&#x60; &lt;span class&#x3D;&quot;permissionBlock&quot;&gt;(Required for deposits associated with a Company) &lt;/span&gt;

Parameters:

  • bank_account_id (Integer)
  • startdate (Date) —

    Filters results to any deposits that were recorded on or after the specified date. The value must be formatted as YYYY-MM-DD.

  • enddate (Date) —

    Filters results to any deposits that were recorded on or before the specified date. The value must be formatted as YYYY-MM-DD.

  • 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<BankAccountDepositMessage>, Integer, Hash)>) —

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



865
866
867
868
869
870
871
872
873
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
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 865

def (, startdate, enddate, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BankAccountsApi.get_bank_account_deposits ...'
  end
  # verify the required parameter 'bank_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'bank_account_id' when calling BankAccountsApi.get_bank_account_deposits"
  end
  # verify the required parameter 'startdate' is set
  if @api_client.config.client_side_validation && startdate.nil?
    fail ArgumentError, "Missing the required parameter 'startdate' when calling BankAccountsApi.get_bank_account_deposits"
  end
  # verify the required parameter 'enddate' is set
  if @api_client.config.client_side_validation && enddate.nil?
    fail ArgumentError, "Missing the required parameter 'enddate' when calling BankAccountsApi.get_bank_account_deposits"
  end
  # resource path
  local_var_path = '/v1/bankaccounts/{bankAccountId}/deposits'.sub('{' + 'bankAccountId' + '}', CGI.escape(.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'startdate'] = startdate
  query_params[:'enddate'] = enddate
  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<BankAccountDepositMessage>'

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

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

#get_bank_account_transaction_by_id(bank_account_id, transaction_id, opts = {}) ⇒ BankAccountTransactionMessage

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

Parameters:

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

    the optional parameters

Returns:



932
933
934
935
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 932

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

#get_bank_account_transaction_by_id_with_http_info(bank_account_id, transaction_id, opts = {}) ⇒ Array<(BankAccountTransactionMessage, Integer, Hash)>

Retrieve a transaction Retrieves a specific bank account transaction. &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 Account&lt;/span&gt; - &#x60;View&#x60;

Parameters:

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

    the optional parameters

Returns:



943
944
945
946
947
948
949
950
951
952
953
954
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
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 943

def (, transaction_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BankAccountsApi.get_bank_account_transaction_by_id ...'
  end
  # verify the required parameter 'bank_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'bank_account_id' when calling BankAccountsApi.get_bank_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 BankAccountsApi.get_bank_account_transaction_by_id"
  end
  # resource path
  local_var_path = '/v1/bankaccounts/{bankAccountId}/transactions/{transactionId}'.sub('{' + 'bankAccountId' + '}', 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] || 'BankAccountTransactionMessage'

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

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

#get_bank_account_transactions(bank_account_id, startdate, enddate, opts = {}) ⇒ Array<BankAccountTransactionMessage>

Retrieve all transactions Retrieves all bank account transactions. <br /><br /> Note: When using the ‘orderby` query string parameter, the only supported parameter is `EntryDate`. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Accounting &gt; Bank Accounts</span> - `View`

Parameters:

  • bank_account_id (Integer)
  • startdate (Date) —

    Filters results to any transactions that were recorded on or after the specified date. The value must be formatted as YYYY-MM-DD.

  • enddate (Date) —

    Filters results to any transactions that were recorded on or before the specified date. The value must be formatted as YYYY-MM-DD.

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

    the optional parameters

Options Hash (opts):

  • :selectionentityid (Integer) —

    Filters results to any transaction containing journal lines for an entity associated with the specified entity id value. The id must be of the type specified in SelectionEntityType.

  • :selectionentitytype (String) —

    Specifies the type of entity that SelectionEntityId refers to.

  • :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:



1007
1008
1009
1010
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 1007

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

#get_bank_account_transactions_with_http_info(bank_account_id, startdate, enddate, opts = {}) ⇒ Array<(Array<BankAccountTransactionMessage>, Integer, Hash)>

Retrieve all transactions Retrieves all bank account transactions. &lt;br /&gt;&lt;br /&gt; Note: When using the &#x60;orderby&#x60; query string parameter, the only supported parameter is &#x60;EntryDate&#x60;. &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:

  • bank_account_id (Integer)
  • startdate (Date) —

    Filters results to any transactions that were recorded on or after the specified date. The value must be formatted as YYYY-MM-DD.

  • enddate (Date) —

    Filters results to any transactions that were recorded on or before the specified date. The value must be formatted as YYYY-MM-DD.

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

    the optional parameters

Options Hash (opts):

  • :selectionentityid (Integer) —

    Filters results to any transaction containing journal lines for an entity associated with the specified entity id value. The id must be of the type specified in SelectionEntityType.

  • :selectionentitytype (String) —

    Specifies the type of entity that SelectionEntityId refers to.

  • :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<BankAccountTransactionMessage>, Integer, Hash)>) —

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



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
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 1024

def (, startdate, enddate, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BankAccountsApi.get_bank_account_transactions ...'
  end
  # verify the required parameter 'bank_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'bank_account_id' when calling BankAccountsApi.get_bank_account_transactions"
  end
  # verify the required parameter 'startdate' is set
  if @api_client.config.client_side_validation && startdate.nil?
    fail ArgumentError, "Missing the required parameter 'startdate' when calling BankAccountsApi.get_bank_account_transactions"
  end
  # verify the required parameter 'enddate' is set
  if @api_client.config.client_side_validation && enddate.nil?
    fail ArgumentError, "Missing the required parameter 'enddate' when calling BankAccountsApi.get_bank_account_transactions"
  end
  allowable_values = ["Company", "Rental", "RentalOwner", "Association"]
  if @api_client.config.client_side_validation && opts[:'selectionentitytype'] && !allowable_values.include?(opts[:'selectionentitytype'])
    fail ArgumentError, "invalid value for \"selectionentitytype\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/v1/bankaccounts/{bankAccountId}/transactions'.sub('{' + 'bankAccountId' + '}', CGI.escape(.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'startdate'] = startdate
  query_params[:'enddate'] = enddate
  query_params[:'selectionentityid'] = opts[:'selectionentityid'] if !opts[:'selectionentityid'].nil?
  query_params[:'selectionentitytype'] = opts[:'selectionentitytype'] if !opts[:'selectionentitytype'].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<BankAccountTransactionMessage>'

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

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

#get_bank_account_transfer_by_id(bank_account_id, transfer_id, opts = {}) ⇒ BankAccountMessage

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

Parameters:

  • bank_account_id (Integer) —

    The bank account identifier.

  • transfer_id (Integer) —

    The transfer identifier.

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

    the optional parameters

Returns:



1097
1098
1099
1100
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 1097

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

#get_bank_account_transfer_by_id_with_http_info(bank_account_id, transfer_id, opts = {}) ⇒ Array<(BankAccountMessage, Integer, Hash)>

Retrieve a transfer Retrieves a bank account transfer. &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:

  • bank_account_id (Integer) —

    The bank account identifier.

  • transfer_id (Integer) —

    The transfer identifier.

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

    the optional parameters

Returns:

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

    BankAccountMessage data, response status code and response headers



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
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 1108

def (, transfer_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BankAccountsApi.get_bank_account_transfer_by_id ...'
  end
  # verify the required parameter 'bank_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'bank_account_id' when calling BankAccountsApi.get_bank_account_transfer_by_id"
  end
  # verify the required parameter 'transfer_id' is set
  if @api_client.config.client_side_validation && transfer_id.nil?
    fail ArgumentError, "Missing the required parameter 'transfer_id' when calling BankAccountsApi.get_bank_account_transfer_by_id"
  end
  # resource path
  local_var_path = '/v1/bankaccounts/{bankAccountId}/transfers/{transferId}'.sub('{' + 'bankAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'transferId' + '}', CGI.escape(transfer_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] || 'BankAccountMessage'

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

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

#get_bank_account_transfers(bank_account_id, startdate, enddate, opts = {}) ⇒ Array<BankAccountTransferMessage>

Retrieve all transfers Retrieves all bank account transfers. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Accounting &gt; BankAccount</span> - ‘View`

Parameters:

  • bank_account_id (Integer)
  • startdate (Date) —

    Filters results to any transfers that were recorded on or after the specified date. The value must be formatted as YYYY-MM-DD.

  • enddate (Date) —

    Filters results to any transfers that were recorded on or before the specified date. The value must be formatted as YYYY-MM-DD.

  • 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:



1170
1171
1172
1173
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 1170

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

#get_bank_account_transfers_with_http_info(bank_account_id, startdate, enddate, opts = {}) ⇒ Array<(Array<BankAccountTransferMessage>, Integer, Hash)>

Retrieve all transfers Retrieves all bank account transfers. &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; BankAccount&lt;/span&gt; - &#x60;View&#x60;

Parameters:

  • bank_account_id (Integer)
  • startdate (Date) —

    Filters results to any transfers that were recorded on or after the specified date. The value must be formatted as YYYY-MM-DD.

  • enddate (Date) —

    Filters results to any transfers that were recorded on or before the specified date. The value must be formatted as YYYY-MM-DD.

  • 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<BankAccountTransferMessage>, Integer, Hash)>) —

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



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
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 1185

def (, startdate, enddate, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BankAccountsApi.get_bank_account_transfers ...'
  end
  # verify the required parameter 'bank_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'bank_account_id' when calling BankAccountsApi.get_bank_account_transfers"
  end
  # verify the required parameter 'startdate' is set
  if @api_client.config.client_side_validation && startdate.nil?
    fail ArgumentError, "Missing the required parameter 'startdate' when calling BankAccountsApi.get_bank_account_transfers"
  end
  # verify the required parameter 'enddate' is set
  if @api_client.config.client_side_validation && enddate.nil?
    fail ArgumentError, "Missing the required parameter 'enddate' when calling BankAccountsApi.get_bank_account_transfers"
  end
  # resource path
  local_var_path = '/v1/bankaccounts/{bankAccountId}/transfers'.sub('{' + 'bankAccountId' + '}', CGI.escape(.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'startdate'] = startdate
  query_params[:'enddate'] = enddate
  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<BankAccountTransferMessage>'

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

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

#get_bank_account_with_http_info(bank_account_id, opts = {}) ⇒ Array<(BankAccountMessage, Integer, Hash)>

Retrieve a bank account Retrieves a specific bank account. &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:

  • bank_account_id (Integer) —

    The bank account identifier.

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

    the optional parameters

Returns:

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

    BankAccountMessage data, response status code and response headers



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
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 637

def (, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BankAccountsApi.get_bank_account ...'
  end
  # verify the required parameter 'bank_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'bank_account_id' when calling BankAccountsApi.get_bank_account"
  end
  # resource path
  local_var_path = '/v1/bankaccounts/{bankAccountId}'.sub('{' + 'bankAccountId' + '}', 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'])

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

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

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

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

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

#get_bank_account_withdrawal_by_id(bank_account_id, withdrawal_id, opts = {}) ⇒ BankAccountWithdrawalMessage

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

Parameters:

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

    the optional parameters

Returns:



1252
1253
1254
1255
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 1252

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

#get_bank_account_withdrawal_by_id_with_http_info(bank_account_id, withdrawal_id, opts = {}) ⇒ Array<(BankAccountWithdrawalMessage, Integer, Hash)>

Retrieve a withdrawal Retrieves a bank account withdrawal. &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; BankAccounts&lt;/span&gt; - &#x60;View&#x60;

Parameters:

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

    the optional parameters

Returns:



1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 1263

def (, withdrawal_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BankAccountsApi.get_bank_account_withdrawal_by_id ...'
  end
  # verify the required parameter 'bank_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'bank_account_id' when calling BankAccountsApi.get_bank_account_withdrawal_by_id"
  end
  # verify the required parameter 'withdrawal_id' is set
  if @api_client.config.client_side_validation && withdrawal_id.nil?
    fail ArgumentError, "Missing the required parameter 'withdrawal_id' when calling BankAccountsApi.get_bank_account_withdrawal_by_id"
  end
  # resource path
  local_var_path = '/v1/bankaccounts/{bankAccountId}/withdrawals/{withdrawalId}'.sub('{' + 'bankAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'withdrawalId' + '}', CGI.escape(withdrawal_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] || 'BankAccountWithdrawalMessage'

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

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

#get_bank_account_withdrawals(bank_account_id, startdate, enddate, opts = {}) ⇒ Array<BankAccountWithdrawalMessage>

Retrieve all withdrawals Retrieves all bank account withdrawals. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Accounting &gt; BankAccounts</span> - ‘View`

Parameters:

  • bank_account_id (Integer)
  • startdate (Date) —

    Filters results to any transactions that were recorded on or after the specified date. The value must be formatted as YYYY-MM-DD.

  • enddate (Date) —

    Filters results to any transactions that were recorded on or before the specified date. The value must be formatted as YYYY-MM-DD.

  • 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:



1325
1326
1327
1328
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 1325

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

#get_bank_account_withdrawals_with_http_info(bank_account_id, startdate, enddate, opts = {}) ⇒ Array<(Array<BankAccountWithdrawalMessage>, Integer, Hash)>

Retrieve all withdrawals Retrieves all bank account withdrawals. &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; BankAccounts&lt;/span&gt; - &#x60;View&#x60;

Parameters:

  • bank_account_id (Integer)
  • startdate (Date) —

    Filters results to any transactions that were recorded on or after the specified date. The value must be formatted as YYYY-MM-DD.

  • enddate (Date) —

    Filters results to any transactions that were recorded on or before the specified date. The value must be formatted as YYYY-MM-DD.

  • 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<BankAccountWithdrawalMessage>, Integer, Hash)>) —

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



1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 1340

def (, startdate, enddate, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BankAccountsApi.get_bank_account_withdrawals ...'
  end
  # verify the required parameter 'bank_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'bank_account_id' when calling BankAccountsApi.get_bank_account_withdrawals"
  end
  # verify the required parameter 'startdate' is set
  if @api_client.config.client_side_validation && startdate.nil?
    fail ArgumentError, "Missing the required parameter 'startdate' when calling BankAccountsApi.get_bank_account_withdrawals"
  end
  # verify the required parameter 'enddate' is set
  if @api_client.config.client_side_validation && enddate.nil?
    fail ArgumentError, "Missing the required parameter 'enddate' when calling BankAccountsApi.get_bank_account_withdrawals"
  end
  # resource path
  local_var_path = '/v1/bankaccounts/{bankAccountId}/withdrawals'.sub('{' + 'bankAccountId' + '}', CGI.escape(.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'startdate'] = startdate
  query_params[:'enddate'] = enddate
  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<BankAccountWithdrawalMessage>'

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

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

#get_check_for_bank_account(bank_account_id, check_id, opts = {}) ⇒ BankAccountCheckMessage

Retrieve a check Retrieves a bank account check. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Accounting &gt; Bank Accounts</span> - ‘View` <br /><span class="permissionBlock">Accounting &gt; General Ledger Transactions</span> - `View` <span class="permissionBlock">(Required for checks associated with a Company) </span>

Parameters:

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

    the optional parameters

Returns:



1407
1408
1409
1410
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 1407

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

#get_check_for_bank_account_with_http_info(bank_account_id, check_id, opts = {}) ⇒ Array<(BankAccountCheckMessage, Integer, Hash)>

Retrieve a check Retrieves a bank account check. &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; &lt;br /&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Accounting &amp;gt; General Ledger Transactions&lt;/span&gt; - &#x60;View&#x60; &lt;span class&#x3D;&quot;permissionBlock&quot;&gt;(Required for checks associated with a Company) &lt;/span&gt;

Parameters:

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

    the optional parameters

Returns:

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

    BankAccountCheckMessage data, response status code and response headers



1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 1418

def (, check_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BankAccountsApi.get_check_for_bank_account ...'
  end
  # verify the required parameter 'bank_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'bank_account_id' when calling BankAccountsApi.get_check_for_bank_account"
  end
  # verify the required parameter 'check_id' is set
  if @api_client.config.client_side_validation && check_id.nil?
    fail ArgumentError, "Missing the required parameter 'check_id' when calling BankAccountsApi.get_check_for_bank_account"
  end
  # resource path
  local_var_path = '/v1/bankaccounts/{bankAccountId}/checks/{checkId}'.sub('{' + 'bankAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'checkId' + '}', CGI.escape(check_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] || 'BankAccountCheckMessage'

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

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

#get_quick_deposit_by_id(bank_account_id, quick_deposit_id, opts = {}) ⇒ BankAccountQuickDepositMessage

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

Parameters:

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

    the optional parameters

Returns:



1476
1477
1478
1479
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 1476

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

#get_quick_deposit_by_id_with_http_info(bank_account_id, quick_deposit_id, opts = {}) ⇒ Array<(BankAccountQuickDepositMessage, Integer, Hash)>

Retrieve a quick deposit Retrieves a quick deposit. &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; BankAccount&lt;/span&gt; - &#x60;View&#x60;

Parameters:

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

    the optional parameters

Returns:



1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 1487

def get_quick_deposit_by_id_with_http_info(, quick_deposit_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BankAccountsApi.get_quick_deposit_by_id ...'
  end
  # verify the required parameter 'bank_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'bank_account_id' when calling BankAccountsApi.get_quick_deposit_by_id"
  end
  # verify the required parameter 'quick_deposit_id' is set
  if @api_client.config.client_side_validation && quick_deposit_id.nil?
    fail ArgumentError, "Missing the required parameter 'quick_deposit_id' when calling BankAccountsApi.get_quick_deposit_by_id"
  end
  # resource path
  local_var_path = '/v1/bankaccounts/{bankAccountId}/quickdeposits/{quickDepositId}'.sub('{' + 'bankAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'quickDepositId' + '}', CGI.escape(quick_deposit_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] || 'BankAccountQuickDepositMessage'

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

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

#get_undeposited_funds(bank_account_id, opts = {}) ⇒ Array<UndepositedFundsMessage>

Retrieve all undeposited funds Retrieve all bank account undeposited funds. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Accounting &gt; Bank Accounts</span> - ‘View`

Parameters:

  • bank_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:



1547
1548
1549
1550
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 1547

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

#get_undeposited_funds_with_http_info(bank_account_id, opts = {}) ⇒ Array<(Array<UndepositedFundsMessage>, Integer, Hash)>

Retrieve all undeposited funds Retrieve all bank account undeposited funds. &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:

  • bank_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<UndepositedFundsMessage>, Integer, Hash)>) —

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



1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 1560

def get_undeposited_funds_with_http_info(, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BankAccountsApi.get_undeposited_funds ...'
  end
  # verify the required parameter 'bank_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'bank_account_id' when calling BankAccountsApi.get_undeposited_funds"
  end
  # resource path
  local_var_path = '/v1/bankaccounts/{bankAccountId}/undepositedfunds'.sub('{' + 'bankAccountId' + '}', 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<UndepositedFundsMessage>'

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

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

#update_bank_account(bank_account_id, bank_account_put_message, opts = {}) ⇒ BankAccountMessage

Update a bank account Updates a bank account. <br /><br /><strong>NOTE:</strong> Any field not included in the update request will be set to either an empty string or ‘null` in the database depending on the field definition. <br />The recommended workflow to ensure no data is inadvertently overwritten is to execute a `GET` request for the resource you’re about to update and then use this response to fill any of the fields that are not being updated. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Accounting &gt; Banking</span> - ‘View` `Edit`

Parameters:

  • bank_account_id (Integer)
  • bank_account_put_message (BankAccountPutMessage)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1617
1618
1619
1620
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 1617

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

#update_bank_account_deposit(bank_account_id, deposit_id, bank_account_deposit_put_message, opts = {}) ⇒ BankAccountDepositMessage

Update a deposit Updates a deposit. <br /><br /><strong>NOTE:</strong> Any field not included in the update request will be set to either an empty string or ‘null` in the database depending on the field definition. <br />The recommended workflow to ensure no data is inadvertently overwritten is to execute a `GET` request for the resource you’re about to update and then use this response to fill any of the fields that are not being updated. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Accounting &gt; Bank Accounts</span> - ‘View` `Edit`

Parameters:

  • bank_account_id (Integer)
  • deposit_id (Integer)
  • bank_account_deposit_put_message (BankAccountDepositPutMessage)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1692
1693
1694
1695
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 1692

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

#update_bank_account_deposit_with_http_info(bank_account_id, deposit_id, bank_account_deposit_put_message, opts = {}) ⇒ Array<(BankAccountDepositMessage, Integer, Hash)>

Update a deposit Updates a deposit. &lt;br /&gt;&lt;br /&gt;&lt;strong&gt;NOTE:&lt;/strong&gt; Any field not included in the update request will be set to either an empty string or &#x60;null&#x60; in the database depending on the field definition. &lt;br /&gt;The recommended workflow to ensure no data is inadvertently overwritten is to execute a &#x60;GET&#x60; request for the resource you&#39;re about to update and then use this response to fill any of the fields that are not being updated. &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:

  • bank_account_id (Integer)
  • deposit_id (Integer)
  • bank_account_deposit_put_message (BankAccountDepositPutMessage)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    BankAccountDepositMessage data, response status code and response headers



1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 1704

def (, deposit_id, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BankAccountsApi.update_bank_account_deposit ...'
  end
  # verify the required parameter 'bank_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'bank_account_id' when calling BankAccountsApi.update_bank_account_deposit"
  end
  # verify the required parameter 'deposit_id' is set
  if @api_client.config.client_side_validation && deposit_id.nil?
    fail ArgumentError, "Missing the required parameter 'deposit_id' when calling BankAccountsApi.update_bank_account_deposit"
  end
  # verify the required parameter 'bank_account_deposit_put_message' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'bank_account_deposit_put_message' when calling BankAccountsApi.update_bank_account_deposit"
  end
  # resource path
  local_var_path = '/v1/bankaccounts/{bankAccountId}/deposits/{depositId}'.sub('{' + 'bankAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'depositId' + '}', CGI.escape(deposit_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] || 'BankAccountDepositMessage'

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

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

#update_bank_account_transfer(bank_account_id, transfer_id, bank_account_transfer_save_message, opts = {}) ⇒ BankAccountTransferMessage

Update a transfer Updates a bank account transfer. <br /><br /><strong>NOTE:</strong> Any field not included in the update request will be set to either an empty string or ‘null` in the database depending on the field definition. <br />The recommended workflow to ensure no data is inadvertently overwritten is to execute a `GET` request for the resource you’re about to update and then use this response to fill any of the fields that are not being updated. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Accounting &gt; Bank Accounts</span> - ‘View` `Edit`

Parameters:

  • bank_account_id (Integer)
  • transfer_id (Integer)
  • bank_account_transfer_save_message (BankAccountTransferSaveMessage)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1772
1773
1774
1775
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 1772

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

#update_bank_account_transfer_with_http_info(bank_account_id, transfer_id, bank_account_transfer_save_message, opts = {}) ⇒ Array<(BankAccountTransferMessage, Integer, Hash)>

Update a transfer Updates a bank account transfer. &lt;br /&gt;&lt;br /&gt;&lt;strong&gt;NOTE:&lt;/strong&gt; Any field not included in the update request will be set to either an empty string or &#x60;null&#x60; in the database depending on the field definition. &lt;br /&gt;The recommended workflow to ensure no data is inadvertently overwritten is to execute a &#x60;GET&#x60; request for the resource you&#39;re about to update and then use this response to fill any of the fields that are not being updated. &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:

  • bank_account_id (Integer)
  • transfer_id (Integer)
  • bank_account_transfer_save_message (BankAccountTransferSaveMessage)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    BankAccountTransferMessage data, response status code and response headers



1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 1784

def (, transfer_id, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BankAccountsApi.update_bank_account_transfer ...'
  end
  # verify the required parameter 'bank_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'bank_account_id' when calling BankAccountsApi.update_bank_account_transfer"
  end
  # verify the required parameter 'transfer_id' is set
  if @api_client.config.client_side_validation && transfer_id.nil?
    fail ArgumentError, "Missing the required parameter 'transfer_id' when calling BankAccountsApi.update_bank_account_transfer"
  end
  # verify the required parameter 'bank_account_transfer_save_message' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'bank_account_transfer_save_message' when calling BankAccountsApi.update_bank_account_transfer"
  end
  # resource path
  local_var_path = '/v1/bankaccounts/{bankAccountId}/transfers/{transferId}'.sub('{' + 'bankAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'transferId' + '}', CGI.escape(transfer_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] || 'BankAccountTransferMessage'

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

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

#update_bank_account_with_http_info(bank_account_id, bank_account_put_message, opts = {}) ⇒ Array<(BankAccountMessage, Integer, Hash)>

Update a bank account Updates a bank account. &lt;br /&gt;&lt;br /&gt;&lt;strong&gt;NOTE:&lt;/strong&gt; Any field not included in the update request will be set to either an empty string or &#x60;null&#x60; in the database depending on the field definition. &lt;br /&gt;The recommended workflow to ensure no data is inadvertently overwritten is to execute a &#x60;GET&#x60; request for the resource you&#39;re about to update and then use this response to fill any of the fields that are not being updated. &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; Banking&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;

Parameters:

  • bank_account_id (Integer)
  • bank_account_put_message (BankAccountPutMessage)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    BankAccountMessage data, response status code and response headers



1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 1628

def (, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BankAccountsApi.update_bank_account ...'
  end
  # verify the required parameter 'bank_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'bank_account_id' when calling BankAccountsApi.update_bank_account"
  end
  # verify the required parameter 'bank_account_put_message' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'bank_account_put_message' when calling BankAccountsApi.update_bank_account"
  end
  # resource path
  local_var_path = '/v1/bankaccounts/{bankAccountId}'.sub('{' + 'bankAccountId' + '}', 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] || 'BankAccountMessage'

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

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

#update_bank_account_withdrawal(bank_account_id, withdrawal_id, bank_account_withdrawal_save_message, opts = {}) ⇒ BankAccountWithdrawalMessage

Update a withdrawal Updates a bank account withdrawal. <br /><br /><strong>NOTE:</strong> Any field not included in the update request will be set to either an empty string or ‘null` in the database depending on the field definition. <br />The recommended workflow to ensure no data is inadvertently overwritten is to execute a `GET` request for the resource you’re about to update and then use this response to fill any of the fields that are not being updated. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Accounting &gt; Bank Accounts</span> - ‘View` `Edit`

Parameters:

  • bank_account_id (Integer)
  • withdrawal_id (Integer)
  • bank_account_withdrawal_save_message (BankAccountWithdrawalSaveMessage)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1852
1853
1854
1855
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 1852

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

#update_bank_account_withdrawal_with_http_info(bank_account_id, withdrawal_id, bank_account_withdrawal_save_message, opts = {}) ⇒ Array<(BankAccountWithdrawalMessage, Integer, Hash)>

Update a withdrawal Updates a bank account withdrawal. &lt;br /&gt;&lt;br /&gt;&lt;strong&gt;NOTE:&lt;/strong&gt; Any field not included in the update request will be set to either an empty string or &#x60;null&#x60; in the database depending on the field definition. &lt;br /&gt;The recommended workflow to ensure no data is inadvertently overwritten is to execute a &#x60;GET&#x60; request for the resource you&#39;re about to update and then use this response to fill any of the fields that are not being updated. &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:

  • bank_account_id (Integer)
  • withdrawal_id (Integer)
  • bank_account_withdrawal_save_message (BankAccountWithdrawalSaveMessage)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 1864

def (, withdrawal_id, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BankAccountsApi.update_bank_account_withdrawal ...'
  end
  # verify the required parameter 'bank_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'bank_account_id' when calling BankAccountsApi.update_bank_account_withdrawal"
  end
  # verify the required parameter 'withdrawal_id' is set
  if @api_client.config.client_side_validation && withdrawal_id.nil?
    fail ArgumentError, "Missing the required parameter 'withdrawal_id' when calling BankAccountsApi.update_bank_account_withdrawal"
  end
  # verify the required parameter 'bank_account_withdrawal_save_message' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'bank_account_withdrawal_save_message' when calling BankAccountsApi.update_bank_account_withdrawal"
  end
  # resource path
  local_var_path = '/v1/bankaccounts/{bankAccountId}/withdrawals/{withdrawalId}'.sub('{' + 'bankAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'withdrawalId' + '}', CGI.escape(withdrawal_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] || 'BankAccountWithdrawalMessage'

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

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

#update_check_for_bank_account(bank_account_id, check_id, bank_account_check_put_message, opts = {}) ⇒ BankAccountCheckMessage

Update a check Updates a check. <br /><br /><strong>NOTE:</strong> Any field not included in the update request will be set to either an empty string or ‘null` in the database depending on the field definition. <br />The recommended workflow to ensure no data is inadvertently overwritten is to execute a `GET` request for the resource you’re about to update and then use this response to fill any of the fields that are not being updated. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Accounting &gt; Bank Accounts</span> - ‘View` `Edit`

Parameters:

  • bank_account_id (Integer)
  • check_id (Integer)
  • bank_account_check_put_message (BankAccountCheckPutMessage)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1932
1933
1934
1935
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 1932

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

#update_check_for_bank_account_with_http_info(bank_account_id, check_id, bank_account_check_put_message, opts = {}) ⇒ Array<(BankAccountCheckMessage, Integer, Hash)>

Update a check Updates a check. &lt;br /&gt;&lt;br /&gt;&lt;strong&gt;NOTE:&lt;/strong&gt; Any field not included in the update request will be set to either an empty string or &#x60;null&#x60; in the database depending on the field definition. &lt;br /&gt;The recommended workflow to ensure no data is inadvertently overwritten is to execute a &#x60;GET&#x60; request for the resource you&#39;re about to update and then use this response to fill any of the fields that are not being updated. &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:

  • bank_account_id (Integer)
  • check_id (Integer)
  • bank_account_check_put_message (BankAccountCheckPutMessage)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    BankAccountCheckMessage data, response status code and response headers



1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 1944

def (, check_id, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BankAccountsApi.update_check_for_bank_account ...'
  end
  # verify the required parameter 'bank_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'bank_account_id' when calling BankAccountsApi.update_check_for_bank_account"
  end
  # verify the required parameter 'check_id' is set
  if @api_client.config.client_side_validation && check_id.nil?
    fail ArgumentError, "Missing the required parameter 'check_id' when calling BankAccountsApi.update_check_for_bank_account"
  end
  # verify the required parameter 'bank_account_check_put_message' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'bank_account_check_put_message' when calling BankAccountsApi.update_check_for_bank_account"
  end
  # resource path
  local_var_path = '/v1/bankaccounts/{bankAccountId}/checks/{checkId}'.sub('{' + 'bankAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'checkId' + '}', CGI.escape(check_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] || 'BankAccountCheckMessage'

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

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

#update_quick_deposit(bank_account_id, quick_deposit_id, bank_account_quick_deposit_save_message, opts = {}) ⇒ BankAccountQuickDepositMessage

Update a quick deposit Updates a quick deposit. <br /><br /><strong>NOTE:</strong> Any field not included in the update request will be set to either an empty string or ‘null` in the database depending on the field definition. <br />The recommended workflow to ensure no data is inadvertently overwritten is to execute a `GET` request for the resource you’re about to update and then use this response to fill any of the fields that are not being updated. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Accounting &gt; Bank Accounts</span> - ‘View` `Edit`

Parameters:

  • bank_account_id (Integer)
  • quick_deposit_id (Integer)
  • bank_account_quick_deposit_save_message (BankAccountQuickDepositSaveMessage)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2012
2013
2014
2015
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 2012

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

#update_quick_deposit_with_http_info(bank_account_id, quick_deposit_id, bank_account_quick_deposit_save_message, opts = {}) ⇒ Array<(BankAccountQuickDepositMessage, Integer, Hash)>

Update a quick deposit Updates a quick deposit. &lt;br /&gt;&lt;br /&gt;&lt;strong&gt;NOTE:&lt;/strong&gt; Any field not included in the update request will be set to either an empty string or &#x60;null&#x60; in the database depending on the field definition. &lt;br /&gt;The recommended workflow to ensure no data is inadvertently overwritten is to execute a &#x60;GET&#x60; request for the resource you&#39;re about to update and then use this response to fill any of the fields that are not being updated. &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:

  • bank_account_id (Integer)
  • quick_deposit_id (Integer)
  • bank_account_quick_deposit_save_message (BankAccountQuickDepositSaveMessage)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 2024

def update_quick_deposit_with_http_info(, quick_deposit_id, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BankAccountsApi.update_quick_deposit ...'
  end
  # verify the required parameter 'bank_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'bank_account_id' when calling BankAccountsApi.update_quick_deposit"
  end
  # verify the required parameter 'quick_deposit_id' is set
  if @api_client.config.client_side_validation && quick_deposit_id.nil?
    fail ArgumentError, "Missing the required parameter 'quick_deposit_id' when calling BankAccountsApi.update_quick_deposit"
  end
  # verify the required parameter 'bank_account_quick_deposit_save_message' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'bank_account_quick_deposit_save_message' when calling BankAccountsApi.update_quick_deposit"
  end
  # resource path
  local_var_path = '/v1/bankaccounts/{bankAccountId}/quickdeposits/{quickDepositId}'.sub('{' + 'bankAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'quickDepositId' + '}', CGI.escape(quick_deposit_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] || 'BankAccountQuickDepositMessage'

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

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