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

#clear_transactions(bank_account_id, reconciliation_id, clear_transactions_request, opts = {}) ⇒ nil

Clear transactions for a reconciliation Clears transactions for a reconciliation. Reconciliation transactions can only be cleared for bank accounts that are not linked externally. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Accounting > BankAccount</span> - ‘View` `Edit`

Parameters:

  • bank_account_id (Integer)
  • reconciliation_id (Integer)
  • clear_transactions_request (ClearTransactionsRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


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

def clear_transactions(, reconciliation_id, clear_transactions_request, opts = {})
  clear_transactions_with_http_info(, reconciliation_id, clear_transactions_request, opts)
  nil
end

#clear_transactions_with_http_info(bank_account_id, reconciliation_id, clear_transactions_request, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Clear transactions for a reconciliation Clears transactions for a reconciliation. Reconciliation transactions can only be cleared for bank accounts that are not linked externally. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Accounting &gt; BankAccount&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;

Parameters:

  • bank_account_id (Integer)
  • reconciliation_id (Integer)
  • clear_transactions_request (ClearTransactionsRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

def clear_transactions_with_http_info(, reconciliation_id, clear_transactions_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BankAccountsApi.clear_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.clear_transactions"
  end
  # verify the required parameter 'reconciliation_id' is set
  if @api_client.config.client_side_validation && reconciliation_id.nil?
    fail ArgumentError, "Missing the required parameter 'reconciliation_id' when calling BankAccountsApi.clear_transactions"
  end
  # verify the required parameter 'clear_transactions_request' is set
  if @api_client.config.client_side_validation && clear_transactions_request.nil?
    fail ArgumentError, "Missing the required parameter 'clear_transactions_request' when calling BankAccountsApi.clear_transactions"
  end
  # resource path
  local_var_path = '/v1/bankaccounts/{bankAccountId}/reconciliations/{reconciliationId}/cleartransactionsrequest'.sub('{' + 'bankAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'reconciliationId' + '}', CGI.escape(reconciliation_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(clear_transactions_request)

  # return_type
  return_type = opts[:debug_return_type]

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

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

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

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

Parameters:

Returns:



107
108
109
110
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 107

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

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

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

Parameters:

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

    the optional parameters

Returns:



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

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

#create_bank_account_check_with_http_info(bank_account_id, create_bank_account_check_request, 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 &gt; Bank Accounts&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;

Parameters:

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

    the optional parameters

Returns:

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

    BankAccountCheckMessage data, response status code and response headers



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

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 'create_bank_account_check_request' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'create_bank_account_check_request' 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, create_bank_account_deposit_request, opts = {}) ⇒ BankAccountDepositMessage

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

Parameters:

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

    the optional parameters

Returns:



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

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

#create_bank_account_deposit_with_http_info(bank_account_id, create_bank_account_deposit_request, 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 &gt; Bank Accounts&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;

Parameters:

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

    the optional parameters

Returns:

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

    BankAccountDepositMessage data, response status code and response headers



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

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 'create_bank_account_deposit_request' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'create_bank_account_deposit_request' 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, create_bank_account_transfer_request, opts = {}) ⇒ BankAccountTransferMessage

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

Parameters:

Returns:



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

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

#create_bank_account_transfer_with_http_info(bank_account_id, create_bank_account_transfer_request, 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 &gt; Bank Accounts&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;

Parameters:

Returns:

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

    BankAccountTransferMessage data, response status code and response headers



335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 335

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 'create_bank_account_transfer_request' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'create_bank_account_transfer_request' 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(create_bank_account_request, 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 &gt; Banking&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;

Parameters:

Returns:

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

    BankAccountMessage data, response status code and response headers



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

def (, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BankAccountsApi.create_bank_account ...'
  end
  # verify the required parameter 'create_bank_account_request' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'create_bank_account_request' 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_check_upload_file_request(bank_account_id, check_id, create_upload_file_request_request, opts = {}) ⇒ FileUploadTicketMessage

Upload a file for a check Uploads a file and associates it to the specified check record. <br /><br />Uploading a file requires making two API requests. Each step is outlined below. <br /><br /><strong>Step 1 - Save file metadata</strong><br /> The first step in the file upload process is to submit the file metadata to ‘/v1/bankaccounts/bankAccountId:int/checks/checkId:int/files/uploadrequests`. The response of this call will contain a URL and a collection of form data that will be used in step 2 to generate the request for the file binary upload. <br /><br /><strong>NOTE:</strong> The response data will expire after 5 minutes. The file metadata will not be saved in the Buildium system if step 2 of this process is not completed successfully. <br /><br /><strong>Step 2 - Upload the file binary</strong><br /> Uploading the file binary will require using the response from step 1 to form a POST request to the Buildium file provider. Follow these steps to create the request: <br /> 1. Form a POST request using the value of the `BucketUrl` property as the URL. <br /><br /> 2. Set the `Content-Type` header to `multipart/form-data`. <br /><br /> 3. Copy the fields from the `FormData` property to this request as form-data key/value pairs. <br /><strong>NOTE:</strong> These values must added to the request form-data in the order they were received in the response. <br /><br /> 4. Lastly create a form-data key named `file` and set the value to the file binary. <br /><strong>NOTE:</strong> This must be the last field in the form-data list. <br /><br />This image shows what the POST request should look like if you’re using Postman: <img src="file-upload-example.png" /><br /><br /> 5. Send the POST request! A successful request will return with a ‘204 - NO CONTENT` HTTP response code. For any failure responses, please refer to <a target="_blank" href="docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#RESTErrorResponses">AWS documentation</a> on REST error responses. <br /><br /><strong>NOTE:</strong> The file identifier is not generated in this response. To retrieve the file identifier, call `/v1/files` and pass the `PhysicalFileName` value received from the response of this endpoint into the `physicalfilenames` query parameter. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Checks</span> - `View` `Edit` <span class="permissionBlock">Accounting > General Ledger Transactions</span> - `View` <span class="permissionBlock">(Required for checks associated with a Company) </span>

Parameters:

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

    the optional parameters

Returns:



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

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

#create_check_upload_file_request_with_http_info(bank_account_id, check_id, create_upload_file_request_request, opts = {}) ⇒ Array<(FileUploadTicketMessage, Integer, Hash)>

Upload a file for a check Uploads a file and associates it to the specified check record. &lt;br /&gt;&lt;br /&gt;Uploading a file requires making two API requests. Each step is outlined below. &lt;br /&gt;&lt;br /&gt;&lt;strong&gt;Step 1 - Save file metadata&lt;/strong&gt;&lt;br /&gt; The first step in the file upload process is to submit the file metadata to &#x60;/v1/bankaccounts/bankAccountId:int/checks/checkId:int/files/uploadrequests&#x60;. The response of this call will contain a URL and a collection of form data that will be used in step 2 to generate the request for the file binary upload. &lt;br /&gt;&lt;br /&gt;&lt;strong&gt;NOTE:&lt;/strong&gt; The response data will expire after 5 minutes. The file metadata will not be saved in the Buildium system if step 2 of this process is not completed successfully. &lt;br /&gt;&lt;br /&gt;&lt;strong&gt;Step 2 - Upload the file binary&lt;/strong&gt;&lt;br /&gt; Uploading the file binary will require using the response from step 1 to form a POST request to the Buildium file provider. Follow these steps to create the request: &lt;br /&gt; 1. Form a POST request using the value of the &#x60;BucketUrl&#x60; property as the URL. &lt;br /&gt;&lt;br /&gt; 2. Set the &#x60;Content-Type&#x60; header to &#x60;multipart/form-data&#x60;. &lt;br /&gt;&lt;br /&gt; 3. Copy the fields from the &#x60;FormData&#x60; property to this request as form-data key/value pairs. &lt;br /&gt;&lt;strong&gt;NOTE:&lt;/strong&gt; These values must added to the request form-data in the order they were received in the response. &lt;br /&gt;&lt;br /&gt; 4. Lastly create a form-data key named &#x60;file&#x60; and set the value to the file binary. &lt;br /&gt;&lt;strong&gt;NOTE:&lt;/strong&gt; This must be the last field in the form-data list. &lt;br /&gt;&lt;br /&gt;This image shows what the POST request should look like if you&#39;re using Postman: &lt;img src&#x3D;&quot;file-upload-example.png&quot; /&gt;&lt;br /&gt;&lt;br /&gt; 5. Send the POST request! A successful request will return with a &#x60;204 - NO CONTENT&#x60; HTTP response code. For any failure responses, please refer to &lt;a target&#x3D;&quot;_blank&quot; href&#x3D;&quot;docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#RESTErrorResponses&quot;&gt;AWS documentation&lt;/a&gt; on REST error responses. &lt;br /&gt;&lt;br /&gt;&lt;strong&gt;NOTE:&lt;/strong&gt; The file identifier is not generated in this response. To retrieve the file identifier, call &#x60;/v1/files&#x60; and pass the &#x60;PhysicalFileName&#x60; value received from the response of this endpoint into the &#x60;physicalfilenames&#x60; query parameter. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Accounting &gt; Checks&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60; &lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Accounting &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)
  • create_upload_file_request_request (CreateUploadFileRequestRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    FileUploadTicketMessage data, response status code and response headers



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

def create_check_upload_file_request_with_http_info(, check_id, create_upload_file_request_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BankAccountsApi.create_check_upload_file_request ...'
  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_check_upload_file_request"
  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.create_check_upload_file_request"
  end
  # verify the required parameter 'create_upload_file_request_request' is set
  if @api_client.config.client_side_validation && create_upload_file_request_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_upload_file_request_request' when calling BankAccountsApi.create_check_upload_file_request"
  end
  # resource path
  local_var_path = '/v1/bankaccounts/{bankAccountId}/checks/{checkId}/files/uploadrequests'.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(create_upload_file_request_request)

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

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

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

#create_pending_reconciliations(bank_account_id, create_pending_reconciliations_request, opts = {}) ⇒ BankAccountReconciliationMessage

Create a reconciliation Creates a reconciliation. Reconciliations can only be created for bank accounts that are not linked externally. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Accounting > BankAccount</span> - ‘View` `Edit`

Parameters:

Returns:



478
479
480
481
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 478

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

#create_pending_reconciliations_with_http_info(bank_account_id, create_pending_reconciliations_request, opts = {}) ⇒ Array<(BankAccountReconciliationMessage, Integer, Hash)>

Create a reconciliation Creates a reconciliation. Reconciliations can only be created for bank accounts that are not linked externally. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Accounting &gt; BankAccount&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;

Parameters:

Returns:



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

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

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

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

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

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

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

Parameters:

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

    the optional parameters

Returns:



552
553
554
555
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 552

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

#create_quick_deposit_with_http_info(bank_account_id, create_quick_deposit_request, 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 &gt; BankAccount&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;

Parameters:

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

    the optional parameters

Returns:



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

def create_quick_deposit_with_http_info(, create_quick_deposit_request, 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 'create_quick_deposit_request' is set
  if @api_client.config.client_side_validation && create_quick_deposit_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_quick_deposit_request' 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(create_quick_deposit_request)

  # 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, create_withdrawal_for_bank_account_request, opts = {}) ⇒ BankAccountWithdrawalMessage

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

Parameters:

Returns:



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

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

#create_withdrawal_for_bank_account_with_http_info(bank_account_id, create_withdrawal_for_bank_account_request, 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 &gt; Bank Accounts&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;

Parameters:

Returns:



637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
 
# 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.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 'create_withdrawal_for_bank_account_request' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'create_withdrawal_for_bank_account_request' 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

#delete_bank_account_check_file(bank_account_id, check_id, file_id, opts = {}) ⇒ nil

Delete a file for a check Deletes a file for a check <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Accounting > BankAccounts</span> - ‘View` `Edit` `Delete` <br /><span class="permissionBlock">Accounting > General Ledger Transactions</span> - `View` <span class="permissionBlock">(Required for checks associated with a Company) </span>

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


701
702
703
704
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 701

def (, check_id, file_id, opts = {})
  (, check_id, file_id, opts)
  nil
end

#delete_bank_account_check_file_with_http_info(bank_account_id, check_id, file_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a file for a check Deletes a file for 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 &gt; BankAccounts&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60; &#x60;Delete&#x60; &lt;br /&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Accounting &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)
  • file_id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

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

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

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

#download_check_file(bank_account_id, check_id, file_id, opts = {}) ⇒ FileDownloadMessage

Download a file for a check Downloads a specific file associated to the check. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bank Accounts</span> - ‘View` <br /><span class="permissionBlock">Accounting > General Ledger Transactions</span> - `View` <span class="permissionBlock">(Required for checks associated with a Company) </span>

Parameters:

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

    the optional parameters

Returns:



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

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

#download_check_file_with_http_info(bank_account_id, check_id, file_id, opts = {}) ⇒ Array<(FileDownloadMessage, Integer, Hash)>

Download a file for a check Downloads a specific file associated to the 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 &gt; Bank Accounts&lt;/span&gt; - &#x60;View&#x60; &lt;br /&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Accounting &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)
  • file_id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

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

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

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

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

#finalize_reconciliation(bank_account_id, reconciliation_id, opts = {}) ⇒ nil

Finalize a manual reconciliation Finalizes a manual reconciliation. Reconciliations can only be finalized for bank accounts that are not linked externally. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Accounting > BankAccount</span> - ‘View` `Edit`

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


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

def finalize_reconciliation(, reconciliation_id, opts = {})
  finalize_reconciliation_with_http_info(, reconciliation_id, opts)
  nil
end

#finalize_reconciliation_with_http_info(bank_account_id, reconciliation_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Finalize a manual reconciliation Finalizes a manual reconciliation. Reconciliations can only be finalized for bank accounts that are not linked externally. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Accounting &gt; BankAccount&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

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

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

  new_options = opts.merge(
    :operation => :"BankAccountsApi.finalize_reconciliation",
    :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#finalize_reconciliation\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 > 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.

  • :routingnumbers (Array<String>) —

    Filters results to any bank accounts whose routing number 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:



923
924
925
926
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 923

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 &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.

  • :routingnumbers (Array<String>) —

    Filters results to any bank accounts whose routing number 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



938
939
940
941
942
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
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 938

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[:'routingnumbers'] = @api_client.build_collection_param(opts[:'routingnumbers'], :multi) if !opts[:'routingnumbers'].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 > 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:



1002
1003
1004
1005
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 1002

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 &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



1017
1018
1019
1020
1021
1022
1023
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
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 1017

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 > Bank Accounts</span> - ‘View`

Parameters:

  • bank_account_id (Integer) —

    The bank account identifier.

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

    the optional parameters

Returns:



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

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

#get_bank_account_check_file_by_id(bank_account_id, check_id, file_id, opts = {}) ⇒ BankAccountCheckFileMessage

Retrieve a file for a check Retrieves the metadata for a specific file associated with the specified check. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bank Accounts</span> - ‘View` <br /><span class="permissionBlock">Accounting > General Ledger Transactions</span> - `View` <span class="permissionBlock">(Required for checks associated with a Company) </span>

Parameters:

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

    the optional parameters

Returns:



1148
1149
1150
1151
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 1148

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

#get_bank_account_check_file_by_id_with_http_info(bank_account_id, check_id, file_id, opts = {}) ⇒ Array<(BankAccountCheckFileMessage, Integer, Hash)>

Retrieve a file for a check Retrieves the metadata for a specific file associated with the specified 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 &gt; Bank Accounts&lt;/span&gt; - &#x60;View&#x60; &lt;br /&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Accounting &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)
  • file_id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    BankAccountCheckFileMessage data, response status code and response headers



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

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

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

  new_options = opts.merge(
    :operation => :"BankAccountsApi.get_bank_account_check_file_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_check_file_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
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 > Bank Accounts</span> - ‘View` <br /><span class="permissionBlock">Accounting > 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:



1226
1227
1228
1229
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 1226

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 &gt; Bank Accounts&lt;/span&gt; - &#x60;View&#x60; &lt;br /&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Accounting &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



1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 1241

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 > BankAccount</span> - ‘View` <br /><span class="permissionBlock">Accounting > 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:



1308
1309
1310
1311
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 1308

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 &gt; BankAccount&lt;/span&gt; - &#x60;View&#x60; &lt;br /&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Accounting &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



1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 1319

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 > BankAccount</span> - ‘View` <br /><span class="permissionBlock">Accounting > 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:



1381
1382
1383
1384
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 1381

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 &gt; BankAccount&lt;/span&gt; - &#x60;View&#x60; &lt;br /&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Accounting &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



1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 1396

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_reconciliation_transactions(bank_account_id, reconciliation_id, opts = {}) ⇒ Array<BankAccountReconciliationTransactionMessage>

Retrieve all transactions for a reconciliation Retrieves all transactions, both cleared and uncleared, up to the Statement Ending Date of the related reconciliation. This is true for pending and completed reconciliations. Transactions can only be retrieved for bank accounts that are not linked externally. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Accounting > BankAccount</span> - ‘View`

Parameters:

  • bank_account_id (Integer)
  • reconciliation_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:



1466
1467
1468
1469
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 1466

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

#get_bank_account_reconciliation_transactions_with_http_info(bank_account_id, reconciliation_id, opts = {}) ⇒ Array<(Array<BankAccountReconciliationTransactionMessage>, Integer, Hash)>

Retrieve all transactions for a reconciliation Retrieves all transactions, both cleared and uncleared, up to the Statement Ending Date of the related reconciliation. This is true for pending and completed reconciliations. Transactions can only be retrieved for bank accounts that are not linked externally. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Accounting &gt; BankAccount&lt;/span&gt; - &#x60;View&#x60;

Parameters:

  • bank_account_id (Integer)
  • reconciliation_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:



1480
1481
1482
1483
1484
1485
1486
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
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 1480

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

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

  new_options = opts.merge(
    :operation => :"BankAccountsApi.get_bank_account_reconciliation_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_reconciliation_transactions\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 > Bank Account</span> - ‘View`

Parameters:

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

    the optional parameters

Returns:



1541
1542
1543
1544
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 1541

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



1552
1553
1554
1555
1556
1557
1558
1559
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
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 1552

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



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

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 &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



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
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 1633

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



1706
1707
1708
1709
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 1706

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 &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



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
1764
1765
1766
1767
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 1717

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



1779
1780
1781
1782
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 1779

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 &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



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
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 1794

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 &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



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

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 > BankAccounts</span> - ‘View`

Parameters:

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

    the optional parameters

Returns:



1861
1862
1863
1864
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 1861

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 &gt; BankAccounts&lt;/span&gt; - &#x60;View&#x60;

Parameters:

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

    the optional parameters

Returns:



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

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



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

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 &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



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
2004
2005
2006
2007
2008
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 1949

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 > Bank Accounts</span> - ‘View` <br /><span class="permissionBlock">Accounting > 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:



2016
2017
2018
2019
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 2016

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 &gt; Bank Accounts&lt;/span&gt; - &#x60;View&#x60; &lt;br /&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Accounting &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



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

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_files_for_bank_account_check(bank_account_id, check_id, opts = {}) ⇒ Array<BankAccountCheckFileMessage>

Retrieve all files for a check Retrieves the metadata for all files associated to the specified check. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bank Accounts</span> - ‘View` <br /><span class="permissionBlock">Accounting > 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

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:



2088
2089
2090
2091
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 2088

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

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

Retrieve all files for a check Retrieves the metadata for all files associated to the specified 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 &gt; Bank Accounts&lt;/span&gt; - &#x60;View&#x60; &lt;br /&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Accounting &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

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

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



2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 2102

def (, check_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BankAccountsApi.get_files_for_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.get_files_for_bank_account_check"
  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_files_for_bank_account_check"
  end
  # resource path
  local_var_path = '/v1/bankaccounts/{bankAccountId}/checks/{checkId}/files'.sub('{' + 'bankAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'checkId' + '}', CGI.escape(check_id.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<BankAccountCheckFileMessage>'

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

  new_options = opts.merge(
    :operation => :"BankAccountsApi.get_files_for_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(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BankAccountsApi#get_files_for_bank_account_check\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 > BankAccount</span> - ‘View`

Parameters:

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

    the optional parameters

Returns:



2163
2164
2165
2166
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 2163

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



2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 2174

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_reconciliation_balance_by_id(bank_account_id, reconciliation_id, opts = {}) ⇒ BankAccountReconciliationBalanceMessage

Retrieve a reconciliation’s balance Retrieves a bank account reconciliation’s balance. Reconciliation balances can only be retrieved for bank accounts that are not linked externally. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Accounting > BankAccount</span> - ‘View`

Parameters:

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

    the optional parameters

Returns:



2232
2233
2234
2235
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 2232

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

#get_reconciliation_balance_by_id_with_http_info(bank_account_id, reconciliation_id, opts = {}) ⇒ Array<(BankAccountReconciliationBalanceMessage, Integer, Hash)>

Retrieve a reconciliation&#39;s balance Retrieves a bank account reconciliation&#39;s balance. Reconciliation balances can only be retrieved for bank accounts that are not linked externally. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Accounting &gt; BankAccount&lt;/span&gt; - &#x60;View&#x60;

Parameters:

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

    the optional parameters

Returns:



2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 2243

def get_reconciliation_balance_by_id_with_http_info(, reconciliation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BankAccountsApi.get_reconciliation_balance_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_reconciliation_balance_by_id"
  end
  # verify the required parameter 'reconciliation_id' is set
  if @api_client.config.client_side_validation && reconciliation_id.nil?
    fail ArgumentError, "Missing the required parameter 'reconciliation_id' when calling BankAccountsApi.get_reconciliation_balance_by_id"
  end
  # resource path
  local_var_path = '/v1/bankaccounts/{bankAccountId}/reconciliations/{reconciliationId}/balances'.sub('{' + 'bankAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'reconciliationId' + '}', CGI.escape(reconciliation_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] || 'BankAccountReconciliationBalanceMessage'

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

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

#get_reconciliation_by_id(bank_account_id, reconciliation_id, opts = {}) ⇒ BankAccountReconciliationMessage

Retrieve a reconciliation Retrieves a bank account reconciliation. Reconciliations can only be retrieved for bank accounts that are not linked externally. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Accounting > BankAccount</span> - ‘View`

Parameters:

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

    the optional parameters

Returns:



2301
2302
2303
2304
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 2301

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

#get_reconciliation_by_id_with_http_info(bank_account_id, reconciliation_id, opts = {}) ⇒ Array<(BankAccountReconciliationMessage, Integer, Hash)>

Retrieve a reconciliation Retrieves a bank account reconciliation. Reconciliations can only be retrieved for bank accounts that are not linked externally. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Accounting &gt; BankAccount&lt;/span&gt; - &#x60;View&#x60;

Parameters:

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

    the optional parameters

Returns:



2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 2312

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

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

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

#get_reconciliations(bank_account_id, opts = {}) ⇒ Array<BankAccountReconciliationMessage>

Retrieve all reconciliations Retrieves all bank account reconciliations. Reconciliations can only be retrieved for bank accounts that are not linked externally. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Accounting > BankAccount</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:



2372
2373
2374
2375
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 2372

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

#get_reconciliations_with_http_info(bank_account_id, opts = {}) ⇒ Array<(Array<BankAccountReconciliationMessage>, Integer, Hash)>

Retrieve all reconciliations Retrieves all bank account reconciliations. Reconciliations can only be retrieved for bank accounts that are not linked externally. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Accounting &gt; BankAccount&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:



2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 2385

def get_reconciliations_with_http_info(, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BankAccountsApi.get_reconciliations ...'
  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_reconciliations"
  end
  # resource path
  local_var_path = '/v1/bankaccounts/{bankAccountId}/reconciliations'.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<BankAccountReconciliationMessage>'

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

  new_options = opts.merge(
    :operation => :"BankAccountsApi.get_reconciliations",
    :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_reconciliations\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 > 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:



2444
2445
2446
2447
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 2444

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 &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



2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 2457

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

#unclear_transactions(bank_account_id, reconciliation_id, unclear_transactions_request, opts = {}) ⇒ nil

Un-clear transactions for a reconciliation Un-clears transactions for a reconciliation. Reconciliation transactions can only be un-cleared for bank accounts that are not linked externally. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Accounting > BankAccount</span> - ‘View` `Edit`

Parameters:

  • bank_account_id (Integer)
  • reconciliation_id (Integer)
  • unclear_transactions_request (UnclearTransactionsRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


2515
2516
2517
2518
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 2515

def unclear_transactions(, reconciliation_id, unclear_transactions_request, opts = {})
  unclear_transactions_with_http_info(, reconciliation_id, unclear_transactions_request, opts)
  nil
end

#unclear_transactions_with_http_info(bank_account_id, reconciliation_id, unclear_transactions_request, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Un-clear transactions for a reconciliation Un-clears transactions for a reconciliation. Reconciliation transactions can only be un-cleared for bank accounts that are not linked externally. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Accounting &gt; BankAccount&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;

Parameters:

  • bank_account_id (Integer)
  • reconciliation_id (Integer)
  • unclear_transactions_request (UnclearTransactionsRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    nil, response status code and response headers



2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 2527

def unclear_transactions_with_http_info(, reconciliation_id, unclear_transactions_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BankAccountsApi.unclear_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.unclear_transactions"
  end
  # verify the required parameter 'reconciliation_id' is set
  if @api_client.config.client_side_validation && reconciliation_id.nil?
    fail ArgumentError, "Missing the required parameter 'reconciliation_id' when calling BankAccountsApi.unclear_transactions"
  end
  # verify the required parameter 'unclear_transactions_request' is set
  if @api_client.config.client_side_validation && unclear_transactions_request.nil?
    fail ArgumentError, "Missing the required parameter 'unclear_transactions_request' when calling BankAccountsApi.unclear_transactions"
  end
  # resource path
  local_var_path = '/v1/bankaccounts/{bankAccountId}/reconciliations/{reconciliationId}/uncleartransactionsrequest'.sub('{' + 'bankAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'reconciliationId' + '}', CGI.escape(reconciliation_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(unclear_transactions_request)

  # return_type
  return_type = opts[:debug_return_type]

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

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

#update_bank_account(bank_account_id, update_bank_account_request, 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 > Banking</span> - ‘View` `Edit`

Parameters:

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

    the optional parameters

Returns:



2594
2595
2596
2597
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 2594

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

#update_bank_account_deposit(bank_account_id, deposit_id, update_bank_account_deposit_request, 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 > Bank Accounts</span> - ‘View` `Edit`

Parameters:

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

    the optional parameters

Returns:



2669
2670
2671
2672
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 2669

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, update_bank_account_deposit_request, 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 &gt; Bank Accounts&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;

Parameters:

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

    the optional parameters

Returns:

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

    BankAccountDepositMessage data, response status code and response headers



2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 2681

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 'update_bank_account_deposit_request' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'update_bank_account_deposit_request' 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, create_bank_account_transfer_request, 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 > Bank Accounts</span> - ‘View` `Edit`

Parameters:

  • bank_account_id (Integer)
  • transfer_id (Integer)
  • create_bank_account_transfer_request (CreateBankAccountTransferRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2749
2750
2751
2752
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 2749

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, create_bank_account_transfer_request, 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 &gt; Bank Accounts&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;

Parameters:

  • bank_account_id (Integer)
  • transfer_id (Integer)
  • create_bank_account_transfer_request (CreateBankAccountTransferRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    BankAccountTransferMessage data, response status code and response headers



2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 2761

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 'create_bank_account_transfer_request' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'create_bank_account_transfer_request' 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, update_bank_account_request, 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 &gt; Banking&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;

Parameters:

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

    the optional parameters

Returns:

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

    BankAccountMessage data, response status code and response headers



2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 2605

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 'update_bank_account_request' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'update_bank_account_request' 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, create_withdrawal_for_bank_account_request, 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 > Bank Accounts</span> - ‘View` `Edit`

Parameters:

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

    the optional parameters

Returns:



2829
2830
2831
2832
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 2829

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, create_withdrawal_for_bank_account_request, 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 &gt; Bank Accounts&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;

Parameters:

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

    the optional parameters

Returns:



2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 2841

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 'create_withdrawal_for_bank_account_request' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'create_withdrawal_for_bank_account_request' 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, update_check_for_bank_account_request, 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 > Bank Accounts</span> - ‘View` `Edit`

Parameters:

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

    the optional parameters

Returns:



2909
2910
2911
2912
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 2909

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, update_check_for_bank_account_request, 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 &gt; Bank Accounts&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;

Parameters:

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

    the optional parameters

Returns:

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

    BankAccountCheckMessage data, response status code and response headers



2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 2921

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 'update_check_for_bank_account_request' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'update_check_for_bank_account_request' 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, create_quick_deposit_request, 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 > Bank Accounts</span> - ‘View` `Edit`

Parameters:

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

    the optional parameters

Returns:



2989
2990
2991
2992
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 2989

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

#update_quick_deposit_with_http_info(bank_account_id, quick_deposit_id, create_quick_deposit_request, 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 &gt; Bank Accounts&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;

Parameters:

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

    the optional parameters

Returns:



3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 3001

def update_quick_deposit_with_http_info(, quick_deposit_id, create_quick_deposit_request, 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 'create_quick_deposit_request' is set
  if @api_client.config.client_side_validation && create_quick_deposit_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_quick_deposit_request' 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(create_quick_deposit_request)

  # 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

#update_reconciliation(bank_account_id, reconciliation_id, update_reconciliation_request, opts = {}) ⇒ BankAccountReconciliationMessage

Update a reconciliation Updates a reconciliation. Reconciliations can only be updated for bank accounts that are not linked externally. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Accounting > BankAccount</span> - ‘View` `Edit`

Parameters:

  • bank_account_id (Integer)
  • reconciliation_id (Integer)
  • update_reconciliation_request (UpdateReconciliationRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



3069
3070
3071
3072
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 3069

def update_reconciliation(, reconciliation_id, update_reconciliation_request, opts = {})
  data, _status_code, _headers = update_reconciliation_with_http_info(, reconciliation_id, update_reconciliation_request, opts)
  data
end

#update_reconciliation_balances(bank_account_id, reconciliation_id, update_reconciliation_balances_request, opts = {}) ⇒ BankAccountReconciliationBalanceMessage

Update a reconciliation’s balance Updates a bank account reconciliation’s balance. Reconciliation balances can only be updated for bank accounts that are not linked externally. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Accounting > BankAccount</span> - ‘View` `Edit`

Parameters:

  • bank_account_id (Integer)
  • reconciliation_id (Integer)
  • update_reconciliation_balances_request (UpdateReconciliationBalancesRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



3149
3150
3151
3152
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 3149

def update_reconciliation_balances(, reconciliation_id, update_reconciliation_balances_request, opts = {})
  data, _status_code, _headers = update_reconciliation_balances_with_http_info(, reconciliation_id, update_reconciliation_balances_request, opts)
  data
end

#update_reconciliation_balances_with_http_info(bank_account_id, reconciliation_id, update_reconciliation_balances_request, opts = {}) ⇒ Array<(BankAccountReconciliationBalanceMessage, Integer, Hash)>

Update a reconciliation&#39;s balance Updates a bank account reconciliation&#39;s balance. Reconciliation balances can only be updated for bank accounts that are not linked externally. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Accounting &gt; BankAccount&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;

Parameters:

  • bank_account_id (Integer)
  • reconciliation_id (Integer)
  • update_reconciliation_balances_request (UpdateReconciliationBalancesRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 3161

def update_reconciliation_balances_with_http_info(, reconciliation_id, update_reconciliation_balances_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BankAccountsApi.update_reconciliation_balances ...'
  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_reconciliation_balances"
  end
  # verify the required parameter 'reconciliation_id' is set
  if @api_client.config.client_side_validation && reconciliation_id.nil?
    fail ArgumentError, "Missing the required parameter 'reconciliation_id' when calling BankAccountsApi.update_reconciliation_balances"
  end
  # verify the required parameter 'update_reconciliation_balances_request' is set
  if @api_client.config.client_side_validation && update_reconciliation_balances_request.nil?
    fail ArgumentError, "Missing the required parameter 'update_reconciliation_balances_request' when calling BankAccountsApi.update_reconciliation_balances"
  end
  # resource path
  local_var_path = '/v1/bankaccounts/{bankAccountId}/reconciliations/{reconciliationId}/balances'.sub('{' + 'bankAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'reconciliationId' + '}', CGI.escape(reconciliation_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(update_reconciliation_balances_request)

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

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

  new_options = opts.merge(
    :operation => :"BankAccountsApi.update_reconciliation_balances",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BankAccountsApi#update_reconciliation_balances\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_reconciliation_with_http_info(bank_account_id, reconciliation_id, update_reconciliation_request, opts = {}) ⇒ Array<(BankAccountReconciliationMessage, Integer, Hash)>

Update a reconciliation Updates a reconciliation. Reconciliations can only be updated for bank accounts that are not linked externally. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Accounting &gt; BankAccount&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;

Parameters:

  • bank_account_id (Integer)
  • reconciliation_id (Integer)
  • update_reconciliation_request (UpdateReconciliationRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
 
# File 'lib/buildium-ruby/api/bank_accounts_api.rb', line 3081

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

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

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

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