Class: Propertyware::AccountingApi

Inherits:
Object
  • Object
show all
Defined in:
lib/propertyware/api/accounting_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AccountingApi

Returns a new instance of AccountingApi.



19
20
21
 
# File 'lib/propertyware/api/accounting_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/propertyware/api/accounting_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_bank_deposit(save_bank_deposit, opts = {}) ⇒ BankDeposit

Create a bank deposit (BETA) <p class="betaError">Note: Write access is only available to customers who have opted in to our beta program. Please reach out to support if you’d like to be included.</p> Creates a bank deposit.<br/><br/>Required permission:<br/><span class="permissionBlock">GENERAL LEDGER</span> - Write

Parameters:

  • save_bank_deposit (SaveBankDeposit) —

    saveBankDeposit

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/propertyware/api/accounting_api.rb', line 27

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

#create_bank_deposit_with_http_info(save_bank_deposit, opts = {}) ⇒ Array<(BankDeposit, Integer, Hash)>

Create a bank deposit (BETA) &lt;p class&#x3D;&quot;betaError&quot;&gt;&lt;b&gt;Note: &lt;/b&gt;Write access is only available to customers who have opted in to our beta program. Please reach out to support if you&#39;d like to be included.&lt;/p&gt; Creates a bank deposit.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;GENERAL LEDGER&lt;/span&gt; - &lt;code&gt;Write&lt;/code&gt;

Parameters:

  • save_bank_deposit (SaveBankDeposit) —

    saveBankDeposit

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

    the optional parameters

Returns:

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

    BankDeposit data, response status code and response headers



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

def create_bank_deposit_with_http_info(save_bank_deposit, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.create_bank_deposit ...'
  end
  # verify the required parameter 'save_bank_deposit' is set
  if @api_client.config.client_side_validation && save_bank_deposit.nil?
    fail ArgumentError, "Missing the required parameter 'save_bank_deposit' when calling AccountingApi.create_bank_deposit"
  end
  # resource path
  local_var_path = '/accounting/bankdeposits'

  # 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(save_bank_deposit)

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

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

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

#create_bill_payments(save_account, opts = {}) ⇒ Array<RESTAPIBulkSuccessResponse>

Create general ledger accounts in bulk (BETA) <p class="betaError">Note: Write access is only available to customers who have opted in to our beta program. Please reach out to support if you’d like to be included.</p> Creates general ledger accounts in bulk.<br/><br/>Required permission:<br/><span class="permissionBlock">GL ACCOUNTS</span> - Write

Parameters:

  • save_account (Array<SaveAccount>) —

    saveAccount

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

    the optional parameters

Returns:



95
96
97
98
 
# File 'lib/propertyware/api/accounting_api.rb', line 95

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

#create_bill_payments_with_http_info(save_account, opts = {}) ⇒ Array<(Array<RESTAPIBulkSuccessResponse>, Integer, Hash)>

Create general ledger accounts in bulk (BETA) &lt;p class&#x3D;&quot;betaError&quot;&gt;&lt;b&gt;Note: &lt;/b&gt;Write access is only available to customers who have opted in to our beta program. Please reach out to support if you&#39;d like to be included.&lt;/p&gt; Creates general ledger accounts in bulk.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;GL ACCOUNTS&lt;/span&gt; - &lt;code&gt;Write&lt;/code&gt;

Parameters:

  • save_account (Array<SaveAccount>) —

    saveAccount

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

    the optional parameters

Returns:

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

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



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/propertyware/api/accounting_api.rb', line 105

def create_bill_payments_with_http_info(, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.create_bill_payments ...'
  end
  # verify the required parameter 'save_account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'save_account' when calling AccountingApi.create_bill_payments"
  end
  # resource path
  local_var_path = '/accounting/glaccounts/bulk'

  # 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] || 'Array<RESTAPIBulkSuccessResponse>'

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

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

#create_gl_account(save_account, opts = {}) ⇒ Account

Create a general ledger account (BETA) <p class="betaError">Note: Write access is only available to customers who have opted in to our beta program. Please reach out to support if you’d like to be included.</p> Create a general ledger account.<br/><br/>Required permission:<br/><span class="permissionBlock">GL ACCOUNTS</span> - Write

Parameters:

  • save_account (SaveAccount) —

    saveAccount

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

    the optional parameters

Returns:



163
164
165
166
 
# File 'lib/propertyware/api/accounting_api.rb', line 163

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

#create_gl_account_with_http_info(save_account, opts = {}) ⇒ Array<(Account, Integer, Hash)>

Create a general ledger account (BETA) &lt;p class&#x3D;&quot;betaError&quot;&gt;&lt;b&gt;Note: &lt;/b&gt;Write access is only available to customers who have opted in to our beta program. Please reach out to support if you&#39;d like to be included.&lt;/p&gt; Create a general ledger account.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;GL ACCOUNTS&lt;/span&gt; - &lt;code&gt;Write&lt;/code&gt;

Parameters:

  • save_account (SaveAccount) —

    saveAccount

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

    the optional parameters

Returns:

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

    Account data, response status code and response headers



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/propertyware/api/accounting_api.rb', line 173

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

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

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

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

#create_owner_contribution(save_owner_contribution, opts = {}) ⇒ OwnerContribution

Create an owner contribution (BETA) <p class="betaError">Note: Write access is only available to customers who have opted in to our beta program. Please reach out to support if you’d like to be included.</p> Creates an owner contribution for a specified owner contact.<br/><br/>Required permission:<br/><span class="permissionBlock">PORTFOLIOS</span> - Write

Parameters:

  • save_owner_contribution (SaveOwnerContribution) —

    saveOwnerContribution

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

    the optional parameters

Returns:



231
232
233
234
 
# File 'lib/propertyware/api/accounting_api.rb', line 231

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

#create_owner_contribution_with_http_info(save_owner_contribution, opts = {}) ⇒ Array<(OwnerContribution, Integer, Hash)>

Create an owner contribution (BETA) &lt;p class&#x3D;&quot;betaError&quot;&gt;&lt;b&gt;Note: &lt;/b&gt;Write access is only available to customers who have opted in to our beta program. Please reach out to support if you&#39;d like to be included.&lt;/p&gt; Creates an owner contribution for a specified owner contact.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;PORTFOLIOS&lt;/span&gt; - &lt;code&gt;Write&lt;/code&gt;

Parameters:

  • save_owner_contribution (SaveOwnerContribution) —

    saveOwnerContribution

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

    the optional parameters

Returns:

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

    OwnerContribution data, response status code and response headers



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/propertyware/api/accounting_api.rb', line 241

def create_owner_contribution_with_http_info(save_owner_contribution, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.create_owner_contribution ...'
  end
  # verify the required parameter 'save_owner_contribution' is set
  if @api_client.config.client_side_validation && save_owner_contribution.nil?
    fail ArgumentError, "Missing the required parameter 'save_owner_contribution' when calling AccountingApi.create_owner_contribution"
  end
  # resource path
  local_var_path = '/accounting/ownercontributions'

  # 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(save_owner_contribution)

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

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

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

#create_owner_draw(save_owner_draw, opts = {}) ⇒ OwnerDraw

Create an owner draw (BETA) <p class="betaError">Note: Write access is only available to customers who have opted in to our beta program. Please reach out to support if you’d like to be included.</p> Creates an owner draw for a specified owner contact.<br/><br/>Required permission:<br/><span class="permissionBlock">PORTFOLIOS</span> - Write

Parameters:

  • save_owner_draw (SaveOwnerDraw) —

    saveOwnerDraw

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

    the optional parameters

Returns:



299
300
301
302
 
# File 'lib/propertyware/api/accounting_api.rb', line 299

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

#create_owner_draw_with_http_info(save_owner_draw, opts = {}) ⇒ Array<(OwnerDraw, Integer, Hash)>

Create an owner draw (BETA) &lt;p class&#x3D;&quot;betaError&quot;&gt;&lt;b&gt;Note: &lt;/b&gt;Write access is only available to customers who have opted in to our beta program. Please reach out to support if you&#39;d like to be included.&lt;/p&gt; Creates an owner draw for a specified owner contact.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;PORTFOLIOS&lt;/span&gt; - &lt;code&gt;Write&lt;/code&gt;

Parameters:

  • save_owner_draw (SaveOwnerDraw) —

    saveOwnerDraw

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

    the optional parameters

Returns:

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

    OwnerDraw data, response status code and response headers



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/propertyware/api/accounting_api.rb', line 309

def create_owner_draw_with_http_info(save_owner_draw, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.create_owner_draw ...'
  end
  # verify the required parameter 'save_owner_draw' is set
  if @api_client.config.client_side_validation && save_owner_draw.nil?
    fail ArgumentError, "Missing the required parameter 'save_owner_draw' when calling AccountingApi.create_owner_draw"
  end
  # resource path
  local_var_path = '/accounting/ownerdraws'

  # 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(save_owner_draw)

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

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

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

#delete_bank_deposit(bank_deposit_id, opts = {}) ⇒ ResponseEntity

Delete a Bank Deposit (BETA) <p class="betaError">Note: Write access is only available to customers who have opted in to our beta program. Please reach out to support if you’d like to be included.</p> Delete a Bank Deposit.<br/><br/>Required permission:<br/><span class="permissionBlock">GENERAL LEDGER</span> - Delete

Parameters:

  • bank_deposit_id (Integer) —

    Bank Deposit ID

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

    the optional parameters

Returns:



367
368
369
370
 
# File 'lib/propertyware/api/accounting_api.rb', line 367

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

#delete_bank_deposit_with_http_info(bank_deposit_id, opts = {}) ⇒ Array<(ResponseEntity, Integer, Hash)>

Delete a Bank Deposit (BETA) &lt;p class&#x3D;&quot;betaError&quot;&gt;&lt;b&gt;Note: &lt;/b&gt;Write access is only available to customers who have opted in to our beta program. Please reach out to support if you&#39;d like to be included.&lt;/p&gt; Delete a Bank Deposit.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;GENERAL LEDGER&lt;/span&gt; - &lt;code&gt;Delete&lt;/code&gt;

Parameters:

  • bank_deposit_id (Integer) —

    Bank Deposit ID

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

    the optional parameters

Returns:

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

    ResponseEntity data, response status code and response headers



377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
 
# File 'lib/propertyware/api/accounting_api.rb', line 377

def delete_bank_deposit_with_http_info(bank_deposit_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.delete_bank_deposit ...'
  end
  # verify the required parameter 'bank_deposit_id' is set
  if @api_client.config.client_side_validation && bank_deposit_id.nil?
    fail ArgumentError, "Missing the required parameter 'bank_deposit_id' when calling AccountingApi.delete_bank_deposit"
  end
  # resource path
  local_var_path = '/accounting/bankdeposits/{bankDepositID}'.sub('{' + 'bankDepositID' + '}', CGI.escape(bank_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] || 'ResponseEntity'

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

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

#delete_gl_account(gl_account, opts = {}) ⇒ ResponseEntity

Delete a general ledger account (BETA) <p class="betaError">Note: Write access is only available to customers who have opted in to our beta program. Please reach out to support if you’d like to be included.</p> Delete a general ledger account.<br/><br/>Required permission:<br/><span class="permissionBlock">GL ACCOUNTS</span> - Delete

Parameters:

  • gl_account (Integer) —

    GL Account ID

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

    the optional parameters

Returns:



430
431
432
433
 
# File 'lib/propertyware/api/accounting_api.rb', line 430

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

#delete_gl_account_with_http_info(gl_account, opts = {}) ⇒ Array<(ResponseEntity, Integer, Hash)>

Delete a general ledger account (BETA) &lt;p class&#x3D;&quot;betaError&quot;&gt;&lt;b&gt;Note: &lt;/b&gt;Write access is only available to customers who have opted in to our beta program. Please reach out to support if you&#39;d like to be included.&lt;/p&gt; Delete a general ledger account.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;GL ACCOUNTS&lt;/span&gt; - &lt;code&gt;Delete&lt;/code&gt;

Parameters:

  • gl_account (Integer) —

    GL Account ID

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

    the optional parameters

Returns:

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

    ResponseEntity data, response status code and response headers



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
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
 
# File 'lib/propertyware/api/accounting_api.rb', line 440

def (, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.delete_gl_account ...'
  end
  # verify the required parameter 'gl_account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'gl_account' when calling AccountingApi.delete_gl_account"
  end
  # resource path
  local_var_path = '/accounting/glaccounts/{glAccount}'.sub('{' + 'glAccount' + '}', 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(['*/*'])

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

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

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

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

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

#delete_owner_contribution(owner_contribution_id, opts = {}) ⇒ ResponseEntity

Delete Owner Contribution (BETA) <p class="betaError">Note: Write access is only available to customers who have opted in to our beta program. Please reach out to support if you’d like to be included.</p> Delete Owner Contribution.<br/><br/>Required permission:<br/><span class="permissionBlock">PORTFOLIOS</span> - Delete

Parameters:

  • owner_contribution_id (Integer) —

    Owner Contribution ID

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

    the optional parameters

Returns:



493
494
495
496
 
# File 'lib/propertyware/api/accounting_api.rb', line 493

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

#delete_owner_contribution_with_http_info(owner_contribution_id, opts = {}) ⇒ Array<(ResponseEntity, Integer, Hash)>

Delete Owner Contribution (BETA) &lt;p class&#x3D;&quot;betaError&quot;&gt;&lt;b&gt;Note: &lt;/b&gt;Write access is only available to customers who have opted in to our beta program. Please reach out to support if you&#39;d like to be included.&lt;/p&gt; Delete Owner Contribution.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;PORTFOLIOS&lt;/span&gt; - &lt;code&gt;Delete&lt;/code&gt;

Parameters:

  • owner_contribution_id (Integer) —

    Owner Contribution ID

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

    the optional parameters

Returns:

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

    ResponseEntity data, response status code and response headers



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
545
546
547
548
549
 
# File 'lib/propertyware/api/accounting_api.rb', line 503

def delete_owner_contribution_with_http_info(owner_contribution_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.delete_owner_contribution ...'
  end
  # verify the required parameter 'owner_contribution_id' is set
  if @api_client.config.client_side_validation && owner_contribution_id.nil?
    fail ArgumentError, "Missing the required parameter 'owner_contribution_id' when calling AccountingApi.delete_owner_contribution"
  end
  # resource path
  local_var_path = '/accounting/ownercontributions/{ownerContributionID}'.sub('{' + 'ownerContributionID' + '}', CGI.escape(owner_contribution_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] || 'ResponseEntity'

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

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

#get_accounts(opts = {}) ⇒ Array<Account>

Retrieve all the general ledger accounts (BETA) <p class="betaWarning">Note: This operation is still in beta and might be subject to breaking changes. Production integrations should be avoided at this stage.</p> Retrieves a list of general ledger accounts.<br/><br/>Required permission:<br/><span class="permissionBlock">GL ACCOUNTS</span> - Read <br/><br/>Sortable by: accountcode, id, accountnumber

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    &#x60;offset&#x60; indicates the position of the first record to return. The offset 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 500 and the default is 100. (default to 100)

  • :last_modified_date_time_start (Time) —

    Filters results to any item modified on or after the date time specified.

  • :last_modified_date_time_end (Time) —

    Filters results to any item modified on or prior to the date time specified.

  • :orderby (String) —

    Indicates the field(s) and direction to sort the results in the response.

  • :account_number (String) —

    Filters results to accounts with a specific number.

  • :include_deactivated (Boolean) —

    Include deactivated results if a &#x60;true&#x60; value is passed. If no value is specified, only active accounts will be returned.

  • :account_code (String) —

    Filters results to accounts with a specific code.

  • :parent_gl_account_id (Integer) —

    Filters results to accounts that are a children of a specific parent account.

Returns:



564
565
566
567
 
# File 'lib/propertyware/api/accounting_api.rb', line 564

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

#get_accounts_with_http_info(opts = {}) ⇒ Array<(Array<Account>, Integer, Hash)>

Retrieve all the general ledger accounts (BETA) &lt;p class&#x3D;&quot;betaWarning&quot;&gt;&lt;b&gt;Note: &lt;/b&gt;This operation is still in beta and might be subject to breaking changes. Production integrations should be avoided at this stage.&lt;/p&gt; Retrieves a list of general ledger accounts.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;GL ACCOUNTS&lt;/span&gt; - &lt;code&gt;Read&lt;/code&gt; &lt;br/&gt;&lt;br/&gt;&lt;b&gt;Sortable by:&lt;/b&gt; &lt;code&gt;accountcode&lt;/code&gt;, &lt;code&gt;id&lt;/code&gt;, &lt;code&gt;accountnumber&lt;/code&gt;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    &#x60;offset&#x60; indicates the position of the first record to return. The offset 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 500 and the default is 100. (default to 100)

  • :last_modified_date_time_start (Time) —

    Filters results to any item modified on or after the date time specified.

  • :last_modified_date_time_end (Time) —

    Filters results to any item modified on or prior to the date time specified.

  • :orderby (String) —

    Indicates the field(s) and direction to sort the results in the response.

  • :account_number (String) —

    Filters results to accounts with a specific number.

  • :include_deactivated (Boolean) —

    Include deactivated results if a &#x60;true&#x60; value is passed. If no value is specified, only active accounts will be returned.

  • :account_code (String) —

    Filters results to accounts with a specific code.

  • :parent_gl_account_id (Integer) —

    Filters results to accounts that are a children of a specific parent account.

Returns:

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

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



582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
 
# File 'lib/propertyware/api/accounting_api.rb', line 582

def get_accounts_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_accounts ...'
  end
  # resource path
  local_var_path = '/accounting/glaccounts'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'lastModifiedDateTimeStart'] = opts[:'last_modified_date_time_start'] if !opts[:'last_modified_date_time_start'].nil?
  query_params[:'lastModifiedDateTimeEnd'] = opts[:'last_modified_date_time_end'] if !opts[:'last_modified_date_time_end'].nil?
  query_params[:'orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
  query_params[:'accountNumber'] = opts[:'account_number'] if !opts[:'account_number'].nil?
  query_params[:'includeDeactivated'] = opts[:'include_deactivated'] if !opts[:'include_deactivated'].nil?
  query_params[:'accountCode'] = opts[:'account_code'] if !opts[:'account_code'].nil?
  query_params[:'parentGLAccountId'] = opts[:'parent_gl_account_id'] if !opts[:'parent_gl_account_id'].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<Account>'

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

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

#get_general_ledger_transactions(opts = {}) ⇒ Array<GLItem>

Retrieve all general ledger transactions (BETA) <p class="betaWarning">Note: This operation is still in beta and might be subject to breaking changes. Production integrations should be avoided at this stage.</p> Retrieves a list of general ledger transactions.<br /><br />At least of the following date ranges must be passed as a filter: * ‘lastModifiedDateStart`-`lastModifiedDateEnd` * `createdDateStart`-`createdDateEnd`<br/><br/>Required permission:<br/><span class="permissionBlock">GENERAL LEDGER</span> - Read

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    &#x60;offset&#x60; indicates the position of the first record to return. The offset 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 500 and the default is 100. (default to 100)

  • :last_modified_date_time_start (Time) —

    Filters results to any item modified on or after the date time specified.

  • :last_modified_date_time_end (Time) —

    Filters results to any item modified on or prior to the date time specified.

  • :orderby (String) —

    Indicates the field(s) and direction to sort the results in the response.

  • :lease_id (Integer) —

    Filters results to transactions associated with a specific lease.

  • :owner_id (Integer) —

    Filters results to transactions associated with a specific owner.

  • :vendor_id (Integer) —

    Filters results to transactions associated with a specific vendor.

  • :portfolio_id (Integer) —

    Filters results to transactions associated with a specific Portfolio.

  • :post_date_start (Date) —

    Filters results to any transaction with post date on or after to the date specified.

  • :post_date_end (Date) —

    Filters results to any transaction with post date on or prior to the date specified.

Returns:



650
651
652
653
 
# File 'lib/propertyware/api/accounting_api.rb', line 650

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

#get_general_ledger_transactions_with_http_info(opts = {}) ⇒ Array<(Array<GLItem>, Integer, Hash)>

Retrieve all general ledger transactions (BETA) &lt;p class&#x3D;&quot;betaWarning&quot;&gt;&lt;b&gt;Note: &lt;/b&gt;This operation is still in beta and might be subject to breaking changes. Production integrations should be avoided at this stage.&lt;/p&gt; Retrieves a list of general ledger transactions.&lt;br /&gt;&lt;br /&gt;At least of the following date ranges must be passed as a filter: * &#x60;lastModifiedDateStart&#x60;-&#x60;lastModifiedDateEnd&#x60; * &#x60;createdDateStart&#x60;-&#x60;createdDateEnd&#x60;&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;GENERAL LEDGER&lt;/span&gt; - &lt;code&gt;Read&lt;/code&gt;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    &#x60;offset&#x60; indicates the position of the first record to return. The offset 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 500 and the default is 100. (default to 100)

  • :last_modified_date_time_start (Time) —

    Filters results to any item modified on or after the date time specified.

  • :last_modified_date_time_end (Time) —

    Filters results to any item modified on or prior to the date time specified.

  • :orderby (String) —

    Indicates the field(s) and direction to sort the results in the response.

  • :lease_id (Integer) —

    Filters results to transactions associated with a specific lease.

  • :owner_id (Integer) —

    Filters results to transactions associated with a specific owner.

  • :vendor_id (Integer) —

    Filters results to transactions associated with a specific vendor.

  • :portfolio_id (Integer) —

    Filters results to transactions associated with a specific Portfolio.

  • :post_date_start (Date) —

    Filters results to any transaction with post date on or after to the date specified.

  • :post_date_end (Date) —

    Filters results to any transaction with post date on or prior to the date specified.

Returns:

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

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



670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
 
# File 'lib/propertyware/api/accounting_api.rb', line 670

def get_general_ledger_transactions_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_general_ledger_transactions ...'
  end
  # resource path
  local_var_path = '/accounting/generalledger'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'lastModifiedDateTimeStart'] = opts[:'last_modified_date_time_start'] if !opts[:'last_modified_date_time_start'].nil?
  query_params[:'lastModifiedDateTimeEnd'] = opts[:'last_modified_date_time_end'] if !opts[:'last_modified_date_time_end'].nil?
  query_params[:'orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
  query_params[:'leaseID'] = opts[:'lease_id'] if !opts[:'lease_id'].nil?
  query_params[:'ownerID'] = opts[:'owner_id'] if !opts[:'owner_id'].nil?
  query_params[:'vendorID'] = opts[:'vendor_id'] if !opts[:'vendor_id'].nil?
  query_params[:'portfolioID'] = opts[:'portfolio_id'] if !opts[:'portfolio_id'].nil?
  query_params[:'postDateStart'] = opts[:'post_date_start'] if !opts[:'post_date_start'].nil?
  query_params[:'postDateEnd'] = opts[:'post_date_end'] if !opts[:'post_date_end'].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<GLItem>'

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

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

#get_owner_contributions(opts = {}) ⇒ Array<OwnerContribution>

Retrieve all the owner contributions (BETA) <p class="betaWarning">Note: This operation is still in beta and might be subject to breaking changes. Production integrations should be avoided at this stage.</p> Retrieves a list of owner contributions.<br/><br/>Required permission:<br/><span class="permissionBlock">PORTFOLIOS</span> - Read <br/><br/>Sortable by: postdate, createddate, lastmodifieddatetime, id

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    &#x60;offset&#x60; indicates the position of the first record to return. The offset 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 500 and the default is 100. (default to 100)

  • :last_modified_date_time_start (Time) —

    Filters results to any item modified on or after the date time specified.

  • :last_modified_date_time_end (Time) —

    Filters results to any item modified on or prior to the date time specified.

  • :orderby (String) —

    Indicates the field(s) and direction to sort the results in the response.

  • :post_date_start (Date) —

    Filters results to any transaction with a start date on or after the date specified.

  • :post_date_end (Date) —

    Filters results to any transaction with a start date on or prior to the date specified.

  • :portfolio_id (Integer) —

    Filters results associated with a specific portfolio.

  • :lease_id (Integer) —

    Filters results with Lease ID.

  • :status (String) —

    Filters results to with Lease Status.

Returns:



739
740
741
742
 
# File 'lib/propertyware/api/accounting_api.rb', line 739

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

#get_owner_contributions_with_http_info(opts = {}) ⇒ Array<(Array<OwnerContribution>, Integer, Hash)>

Retrieve all the owner contributions (BETA) &lt;p class&#x3D;&quot;betaWarning&quot;&gt;&lt;b&gt;Note: &lt;/b&gt;This operation is still in beta and might be subject to breaking changes. Production integrations should be avoided at this stage.&lt;/p&gt; Retrieves a list of owner contributions.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;PORTFOLIOS&lt;/span&gt; - &lt;code&gt;Read&lt;/code&gt; &lt;br/&gt;&lt;br/&gt;&lt;b&gt;Sortable by:&lt;/b&gt; &lt;code&gt;postdate&lt;/code&gt;, &lt;code&gt;createddate&lt;/code&gt;, &lt;code&gt;lastmodifieddatetime&lt;/code&gt;, &lt;code&gt;id&lt;/code&gt;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    &#x60;offset&#x60; indicates the position of the first record to return. The offset 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 500 and the default is 100. (default to 100)

  • :last_modified_date_time_start (Time) —

    Filters results to any item modified on or after the date time specified.

  • :last_modified_date_time_end (Time) —

    Filters results to any item modified on or prior to the date time specified.

  • :orderby (String) —

    Indicates the field(s) and direction to sort the results in the response.

  • :post_date_start (Date) —

    Filters results to any transaction with a start date on or after the date specified.

  • :post_date_end (Date) —

    Filters results to any transaction with a start date on or prior to the date specified.

  • :portfolio_id (Integer) —

    Filters results associated with a specific portfolio.

  • :lease_id (Integer) —

    Filters results with Lease ID.

  • :status (String) —

    Filters results to with Lease Status.

Returns:

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

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



758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
 
# File 'lib/propertyware/api/accounting_api.rb', line 758

def get_owner_contributions_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_owner_contributions ...'
  end
  # resource path
  local_var_path = '/accounting/ownercontributions'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'lastModifiedDateTimeStart'] = opts[:'last_modified_date_time_start'] if !opts[:'last_modified_date_time_start'].nil?
  query_params[:'lastModifiedDateTimeEnd'] = opts[:'last_modified_date_time_end'] if !opts[:'last_modified_date_time_end'].nil?
  query_params[:'orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
  query_params[:'postDateStart'] = opts[:'post_date_start'] if !opts[:'post_date_start'].nil?
  query_params[:'postDateEnd'] = opts[:'post_date_end'] if !opts[:'post_date_end'].nil?
  query_params[:'portfolioID'] = opts[:'portfolio_id'] if !opts[:'portfolio_id'].nil?
  query_params[:'leaseID'] = opts[:'lease_id'] if !opts[:'lease_id'].nil?
  query_params[:'status'] = opts[:'status'] if !opts[:'status'].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<OwnerContribution>'

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

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

#get_owner_draws(opts = {}) ⇒ Array<OwnerDraw>

Retrieve all the owner draws (BETA) <p class="betaWarning">Note: This operation is still in beta and might be subject to breaking changes. Production integrations should be avoided at this stage.</p> Retrieves a list of owner draws.<br/><br/>Required permission:<br/><span class="permissionBlock">PORTFOLIOS</span> - Read <br/><br/>Sortable by: postdate, createddate, lastmodifieddatetime, portfolioid, id

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    &#x60;offset&#x60; indicates the position of the first record to return. The offset 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 500 and the default is 100. (default to 100)

  • :last_modified_date_time_start (Time) —

    Filters results to any item modified on or after the date time specified.

  • :last_modified_date_time_end (Time) —

    Filters results to any item modified on or prior to the date time specified.

  • :orderby (String) —

    Indicates the field(s) and direction to sort the results in the response.

  • :post_date_start (Date) —

    Filters results to any transaction with a start date on or after the date specified.

  • :post_date_end (Date) —

    Filters results to any transaction with a start date on or prior to the date specified.

  • :portfolio_id (Integer) —

    Filters results to with portfolioID.

Returns:



824
825
826
827
 
# File 'lib/propertyware/api/accounting_api.rb', line 824

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

#get_owner_draws_with_http_info(opts = {}) ⇒ Array<(Array<OwnerDraw>, Integer, Hash)>

Retrieve all the owner draws (BETA) &lt;p class&#x3D;&quot;betaWarning&quot;&gt;&lt;b&gt;Note: &lt;/b&gt;This operation is still in beta and might be subject to breaking changes. Production integrations should be avoided at this stage.&lt;/p&gt; Retrieves a list of owner draws.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;PORTFOLIOS&lt;/span&gt; - &lt;code&gt;Read&lt;/code&gt; &lt;br/&gt;&lt;br/&gt;&lt;b&gt;Sortable by:&lt;/b&gt; &lt;code&gt;postdate&lt;/code&gt;, &lt;code&gt;createddate&lt;/code&gt;, &lt;code&gt;lastmodifieddatetime&lt;/code&gt;, &lt;code&gt;portfolioid&lt;/code&gt;, &lt;code&gt;id&lt;/code&gt;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    &#x60;offset&#x60; indicates the position of the first record to return. The offset 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 500 and the default is 100. (default to 100)

  • :last_modified_date_time_start (Time) —

    Filters results to any item modified on or after the date time specified.

  • :last_modified_date_time_end (Time) —

    Filters results to any item modified on or prior to the date time specified.

  • :orderby (String) —

    Indicates the field(s) and direction to sort the results in the response.

  • :post_date_start (Date) —

    Filters results to any transaction with a start date on or after the date specified.

  • :post_date_end (Date) —

    Filters results to any transaction with a start date on or prior to the date specified.

  • :portfolio_id (Integer) —

    Filters results to with portfolioID.

Returns:

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

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



841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
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
 
# File 'lib/propertyware/api/accounting_api.rb', line 841

def get_owner_draws_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_owner_draws ...'
  end
  # resource path
  local_var_path = '/accounting/ownerdraws'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'lastModifiedDateTimeStart'] = opts[:'last_modified_date_time_start'] if !opts[:'last_modified_date_time_start'].nil?
  query_params[:'lastModifiedDateTimeEnd'] = opts[:'last_modified_date_time_end'] if !opts[:'last_modified_date_time_end'].nil?
  query_params[:'orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
  query_params[:'postDateStart'] = opts[:'post_date_start'] if !opts[:'post_date_start'].nil?
  query_params[:'postDateEnd'] = opts[:'post_date_end'] if !opts[:'post_date_end'].nil?
  query_params[:'portfolioID'] = opts[:'portfolio_id'] if !opts[:'portfolio_id'].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<OwnerDraw>'

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

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

#update_gl_account(gl_account_id, save_account, opts = {}) ⇒ Account

Update a general ledger account (BETA) <p class="betaError">Note: Write access is only available to customers who have opted in to our beta program. Please reach out to support if you’d like to be included.</p> Updates a general ledger account.<br/><br/>Required permission:<br/><span class="permissionBlock">GL ACCOUNTS</span> - Write

Parameters:

  • gl_account_id (Integer) —

    GL Account ID

  • save_account (SaveAccount) —

    saveAccount

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

    the optional parameters

Returns:



899
900
901
902
 
# File 'lib/propertyware/api/accounting_api.rb', line 899

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

#update_gl_account_with_http_info(gl_account_id, save_account, opts = {}) ⇒ Array<(Account, Integer, Hash)>

Update a general ledger account (BETA) &lt;p class&#x3D;&quot;betaError&quot;&gt;&lt;b&gt;Note: &lt;/b&gt;Write access is only available to customers who have opted in to our beta program. Please reach out to support if you&#39;d like to be included.&lt;/p&gt; Updates a general ledger account.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;GL ACCOUNTS&lt;/span&gt; - &lt;code&gt;Write&lt;/code&gt;

Parameters:

  • gl_account_id (Integer) —

    GL Account ID

  • save_account (SaveAccount) —

    saveAccount

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

    the optional parameters

Returns:

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

    Account data, response status code and response headers



910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
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
 
# File 'lib/propertyware/api/accounting_api.rb', line 910

def (, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.update_gl_account ...'
  end
  # verify the required parameter 'gl_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'gl_account_id' when calling AccountingApi.update_gl_account"
  end
  # verify the required parameter 'save_account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'save_account' when calling AccountingApi.update_gl_account"
  end
  # resource path
  local_var_path = '/accounting/glaccounts/{glAccountID}'.sub('{' + 'glAccountID' + '}', 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] || 'Account'

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

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

#update_owner_draw(draw_id, save_owner_draw, opts = {}) ⇒ OwnerDraw

Update an owner draw (BETA) <p class="betaError">Note: Write access is only available to customers who have opted in to our beta program. Please reach out to support if you’d like to be included.</p> Updates an owner draw for a specified owner contact.<br/><br/>Required permission:<br/><span class="permissionBlock">PORTFOLIOS</span> - Write

Parameters:

  • draw_id (Integer) —

    Owner Draw ID

  • save_owner_draw (SaveOwnerDraw) —

    saveOwnerDraw

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

    the optional parameters

Returns:



973
974
975
976
 
# File 'lib/propertyware/api/accounting_api.rb', line 973

def update_owner_draw(draw_id, save_owner_draw, opts = {})
  data, _status_code, _headers = update_owner_draw_with_http_info(draw_id, save_owner_draw, opts)
  data
end

#update_owner_draw_with_http_info(draw_id, save_owner_draw, opts = {}) ⇒ Array<(OwnerDraw, Integer, Hash)>

Update an owner draw (BETA) &lt;p class&#x3D;&quot;betaError&quot;&gt;&lt;b&gt;Note: &lt;/b&gt;Write access is only available to customers who have opted in to our beta program. Please reach out to support if you&#39;d like to be included.&lt;/p&gt; Updates an owner draw for a specified owner contact.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;PORTFOLIOS&lt;/span&gt; - &lt;code&gt;Write&lt;/code&gt;

Parameters:

  • draw_id (Integer) —

    Owner Draw ID

  • save_owner_draw (SaveOwnerDraw) —

    saveOwnerDraw

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

    the optional parameters

Returns:

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

    OwnerDraw data, response status code and response headers



984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
 
# File 'lib/propertyware/api/accounting_api.rb', line 984

def update_owner_draw_with_http_info(draw_id, save_owner_draw, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.update_owner_draw ...'
  end
  # verify the required parameter 'draw_id' is set
  if @api_client.config.client_side_validation && draw_id.nil?
    fail ArgumentError, "Missing the required parameter 'draw_id' when calling AccountingApi.update_owner_draw"
  end
  # verify the required parameter 'save_owner_draw' is set
  if @api_client.config.client_side_validation && save_owner_draw.nil?
    fail ArgumentError, "Missing the required parameter 'save_owner_draw' when calling AccountingApi.update_owner_draw"
  end
  # resource path
  local_var_path = '/accounting/ownerdraws/{drawID}'.sub('{' + 'drawID' + '}', CGI.escape(draw_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(save_owner_draw)

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

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

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