Class: Propertyware::BillsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ BillsApi

Returns a new instance of BillsApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_bill(save_bill, opts = {}) ⇒ Bill

Create a bill (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 bill.<br/><br/>Required permission:<br/><span class="permissionBlock">BILLS</span> - Write

Parameters:

  • save_bill (SaveBill) —

    saveBill

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

    the optional parameters

Returns:



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

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

#create_bill_payment(save_bill_payment, opts = {}) ⇒ BillPayment

Creates Bill Payment (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 Bill Payment<br/><br/>Required permission:<br/><span class="permissionBlock">VENDORS</span> - Write

Parameters:

  • save_bill_payment (SaveBillPayment) —

    saveBillPayment

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

    the optional parameters

Returns:



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

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

#create_bill_payment_with_http_info(save_bill_payment, opts = {}) ⇒ Array<(BillPayment, Integer, Hash)>

Creates Bill Payment (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 Bill Payment&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;VENDORS&lt;/span&gt; - &lt;code&gt;Write&lt;/code&gt;

Parameters:

  • save_bill_payment (SaveBillPayment) —

    saveBillPayment

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

    the optional parameters

Returns:

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

    BillPayment 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/bills_api.rb', line 105

def create_bill_payment_with_http_info(save_bill_payment, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BillsApi.create_bill_payment ...'
  end
  # verify the required parameter 'save_bill_payment' is set
  if @api_client.config.client_side_validation && save_bill_payment.nil?
    fail ArgumentError, "Missing the required parameter 'save_bill_payment' when calling BillsApi.create_bill_payment"
  end
  # resource path
  local_var_path = '/bills/payment'

  # 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_bill_payment)

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

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

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

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

#create_bill_payments_using_post1(save_bill_payment, opts = {}) ⇒ Array<RESTAPIBulkSuccessResponse>

Create bill payments 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 bill payments in bulk.<br/><br/>Required permission:<br/><span class="permissionBlock">VENDORS</span> - Write

Parameters:

  • save_bill_payment (Array<SaveBillPayment>) —

    saveBillPayment

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

    the optional parameters

Returns:



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

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

#create_bill_payments_using_post1_with_http_info(save_bill_payment, opts = {}) ⇒ Array<(Array<RESTAPIBulkSuccessResponse>, Integer, Hash)>

Create bill payments 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 bill payments 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;VENDORS&lt;/span&gt; - &lt;code&gt;Write&lt;/code&gt;

Parameters:

  • save_bill_payment (Array<SaveBillPayment>) —

    saveBillPayment

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

    the optional parameters

Returns:

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

    Array<RESTAPIBulkSuccessResponse> 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/bills_api.rb', line 173

def create_bill_payments_using_post1_with_http_info(save_bill_payment, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BillsApi.create_bill_payments_using_post1 ...'
  end
  # verify the required parameter 'save_bill_payment' is set
  if @api_client.config.client_side_validation && save_bill_payment.nil?
    fail ArgumentError, "Missing the required parameter 'save_bill_payment' when calling BillsApi.create_bill_payments_using_post1"
  end
  # resource path
  local_var_path = '/bills/payments/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(save_bill_payment)

  # 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 => :"BillsApi.create_bill_payments_using_post1",
    :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: BillsApi#create_bill_payments_using_post1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_bill_with_http_info(save_bill, opts = {}) ⇒ Array<(Bill, Integer, Hash)>

Create a bill (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 bill.&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;BILLS&lt;/span&gt; - &lt;code&gt;Write&lt;/code&gt;

Parameters:

  • save_bill (SaveBill) —

    saveBill

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

    the optional parameters

Returns:

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

    Bill 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/bills_api.rb', line 37

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

  # 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_bill)

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

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

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

#create_bills(save_bill, opts = {}) ⇒ Array<RESTAPIBulkSuccessResponse>

Create bills 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 bills in bulk.<br/><br/>Required permission:<br/><span class="permissionBlock">BILLS</span> - Write

Parameters:

  • save_bill (Array<SaveBill>) —

    saveBill

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

    the optional parameters

Returns:



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

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

#create_bills_with_http_info(save_bill, opts = {}) ⇒ Array<(Array<RESTAPIBulkSuccessResponse>, Integer, Hash)>

Create bills 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 bills 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;BILLS&lt;/span&gt; - &lt;code&gt;Write&lt;/code&gt;

Parameters:

  • save_bill (Array<SaveBill>) —

    saveBill

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

    the optional parameters

Returns:

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

    Array<RESTAPIBulkSuccessResponse> 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/bills_api.rb', line 241

def create_bills_with_http_info(save_bill, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BillsApi.create_bills ...'
  end
  # verify the required parameter 'save_bill' is set
  if @api_client.config.client_side_validation && save_bill.nil?
    fail ArgumentError, "Missing the required parameter 'save_bill' when calling BillsApi.create_bills"
  end
  # resource path
  local_var_path = '/bills/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(save_bill)

  # 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 => :"BillsApi.create_bills",
    :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: BillsApi#create_bills\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_credit(save_credit, opts = {}) ⇒ Bill

Create a credit (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 credit.<br/><br/>Required permission:<br/><span class="permissionBlock">BILLS</span> - Write

Parameters:

  • save_credit (SaveCredit) —

    saveCredit

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

    the optional parameters

Returns:



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

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

#create_credit_with_http_info(save_credit, opts = {}) ⇒ Array<(Bill, Integer, Hash)>

Create a credit (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 credit.&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;BILLS&lt;/span&gt; - &lt;code&gt;Write&lt;/code&gt;

Parameters:

  • save_credit (SaveCredit) —

    saveCredit

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

    the optional parameters

Returns:

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

    Bill 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/bills_api.rb', line 309

def create_credit_with_http_info(save_credit, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BillsApi.create_credit ...'
  end
  # verify the required parameter 'save_credit' is set
  if @api_client.config.client_side_validation && save_credit.nil?
    fail ArgumentError, "Missing the required parameter 'save_credit' when calling BillsApi.create_credit"
  end
  # resource path
  local_var_path = '/bills/credit'

  # 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_credit)

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

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

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

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

#create_vendor_check(save_check, opts = {}) ⇒ Check

Create a Vendor check (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 Vendor check.<br/><br/>Required permission:<br/><span class="permissionBlock">VENDORS</span> - Write

Parameters:

  • save_check (SaveCheck) —

    saveCheck

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

    the optional parameters

Returns:



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

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

#create_vendor_check_with_http_info(save_check, opts = {}) ⇒ Array<(Check, Integer, Hash)>

Create a Vendor check (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 Vendor check.&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;VENDORS&lt;/span&gt; - &lt;code&gt;Write&lt;/code&gt;

Parameters:

  • save_check (SaveCheck) —

    saveCheck

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

    the optional parameters

Returns:

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

    Check 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
424
425
426
427
428
 
# File 'lib/propertyware/api/bills_api.rb', line 377

def create_vendor_check_with_http_info(save_check, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BillsApi.create_vendor_check ...'
  end
  # verify the required parameter 'save_check' is set
  if @api_client.config.client_side_validation && save_check.nil?
    fail ArgumentError, "Missing the required parameter 'save_check' when calling BillsApi.create_vendor_check"
  end
  # resource path
  local_var_path = '/bills/vendorChecks'

  # 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_check)

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

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

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

#delete_bill(bill_id, opts = {}) ⇒ ResponseEntity

Delete a Bill (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 Bill.<br/><br/>Required permission:<br/><span class="permissionBlock">BILLS</span> - Delete

Parameters:

  • bill_id (Integer) —

    Bill ID

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

    the optional parameters

Returns:



435
436
437
438
 
# File 'lib/propertyware/api/bills_api.rb', line 435

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

#delete_bill_with_http_info(bill_id, opts = {}) ⇒ Array<(ResponseEntity, Integer, Hash)>

Delete a Bill (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 Bill.&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;BILLS&lt;/span&gt; - &lt;code&gt;Delete&lt;/code&gt;

Parameters:

  • bill_id (Integer) —

    Bill ID

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

    the optional parameters

Returns:

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

    ResponseEntity data, response status code and response headers



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
487
488
489
490
491
 
# File 'lib/propertyware/api/bills_api.rb', line 445

def delete_bill_with_http_info(bill_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BillsApi.delete_bill ...'
  end
  # verify the required parameter 'bill_id' is set
  if @api_client.config.client_side_validation && bill_id.nil?
    fail ArgumentError, "Missing the required parameter 'bill_id' when calling BillsApi.delete_bill"
  end
  # resource path
  local_var_path = '/bills/{billID}'.sub('{' + 'billID' + '}', CGI.escape(bill_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 => :"BillsApi.delete_bill",
    :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: BillsApi#delete_bill\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_bill(bill_id, opts = {}) ⇒ Bill

Retrieve a bill (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 specific bill.<br/><br/>Required permission:<br/><span class="permissionBlock">BILLS</span> - Read

Parameters:

  • bill_id (Integer) —

    Bill ID

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

    the optional parameters

Returns:



498
499
500
501
 
# File 'lib/propertyware/api/bills_api.rb', line 498

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

#get_bill_payment(bill_payment_id, opts = {}) ⇒ BillPayment

Retrieve a bill payment (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 specific bill payment.<br/><br/>Required permission:<br/><span class="permissionBlock">BILLS</span> - Read

Parameters:

  • bill_payment_id (Integer) —

    Bill Payment ID

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

    the optional parameters

Returns:



561
562
563
564
 
# File 'lib/propertyware/api/bills_api.rb', line 561

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

#get_bill_payment_with_http_info(bill_payment_id, opts = {}) ⇒ Array<(BillPayment, Integer, Hash)>

Retrieve a bill payment (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 specific bill payment.&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;BILLS&lt;/span&gt; - &lt;code&gt;Read&lt;/code&gt;

Parameters:

  • bill_payment_id (Integer) —

    Bill Payment ID

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

    the optional parameters

Returns:

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

    BillPayment data, response status code and response headers



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
 
# File 'lib/propertyware/api/bills_api.rb', line 571

def get_bill_payment_with_http_info(bill_payment_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BillsApi.get_bill_payment ...'
  end
  # verify the required parameter 'bill_payment_id' is set
  if @api_client.config.client_side_validation && bill_payment_id.nil?
    fail ArgumentError, "Missing the required parameter 'bill_payment_id' when calling BillsApi.get_bill_payment"
  end
  # resource path
  local_var_path = '/bills/payments/{billPaymentID}'.sub('{' + 'billPaymentID' + '}', CGI.escape(bill_payment_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

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

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

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

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

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

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

#get_bill_payments(opts = {}) ⇒ Array<BillPayment>

Retrieve all bill payments (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 bill payments.<br/><br/>Required permission:<br/><span class="permissionBlock">BILLS</span> - Read <br/><br/>Sortable by: createddate, vendorid, lastmodifieddatetime, paymentdate, checknumber, 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.

  • :vendor_id (Integer) —

    Filters results to bills associated with a specific vendor.

  • :payment_gl_account_id (Integer) —

    Filters results to bills associated with a specific payment general ledger account.

  • :payment_date_start (Date) —

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

  • :payment_date_end (Date) —

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

Returns:



632
633
634
635
 
# File 'lib/propertyware/api/bills_api.rb', line 632

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

#get_bill_payments_with_http_info(opts = {}) ⇒ Array<(Array<BillPayment>, Integer, Hash)>

Retrieve all bill payments (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 bill payments.&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;BILLS&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;createddate&lt;/code&gt;, &lt;code&gt;vendorid&lt;/code&gt;, &lt;code&gt;lastmodifieddatetime&lt;/code&gt;, &lt;code&gt;paymentdate&lt;/code&gt;, &lt;code&gt;checknumber&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.

  • :vendor_id (Integer) —

    Filters results to bills associated with a specific vendor.

  • :payment_gl_account_id (Integer) —

    Filters results to bills associated with a specific payment general ledger account.

  • :payment_date_start (Date) —

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

  • :payment_date_end (Date) —

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

Returns:

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

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



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
693
694
695
696
697
698
699
700
701
 
# File 'lib/propertyware/api/bills_api.rb', line 650

def get_bill_payments_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BillsApi.get_bill_payments ...'
  end
  # resource path
  local_var_path = '/bills/payments'

  # 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[:'vendorID'] = opts[:'vendor_id'] if !opts[:'vendor_id'].nil?
  query_params[:'paymentGLAccountID'] = opts[:'payment_gl_account_id'] if !opts[:'payment_gl_account_id'].nil?
  query_params[:'paymentDateStart'] = opts[:'payment_date_start'] if !opts[:'payment_date_start'].nil?
  query_params[:'paymentDateEnd'] = opts[:'payment_date_end'] if !opts[:'payment_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<BillPayment>'

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

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

#get_bill_with_http_info(bill_id, opts = {}) ⇒ Array<(Bill, Integer, Hash)>

Retrieve a bill (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 specific bill.&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;BILLS&lt;/span&gt; - &lt;code&gt;Read&lt;/code&gt;

Parameters:

  • bill_id (Integer) —

    Bill ID

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

    the optional parameters

Returns:

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

    Bill data, response status code and response headers



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
550
551
552
553
554
 
# File 'lib/propertyware/api/bills_api.rb', line 508

def get_bill_with_http_info(bill_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BillsApi.get_bill ...'
  end
  # verify the required parameter 'bill_id' is set
  if @api_client.config.client_side_validation && bill_id.nil?
    fail ArgumentError, "Missing the required parameter 'bill_id' when calling BillsApi.get_bill"
  end
  # resource path
  local_var_path = '/bills/{billID}'.sub('{' + 'billID' + '}', CGI.escape(bill_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] || 'Bill'

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

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

#get_bills(opts = {}) ⇒ Array<Bill>

Retrieve all bills (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 bills.<br/><br/>Required permission:<br/><span class="permissionBlock">BILLS</span> - Read <br/><br/>Sortable by: createddate, billdate, billnumber, lastmodifieddatetime, duedate, 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.

  • :portfolio_id (Integer) —

    Filters results to bills associated with a specific portfolio.

  • :vendor_id (Integer) —

    Filters results to bills associated with a specific vendor.

  • :work_order_id (Integer) —

    Filters results to bills associated with a specific work order.

  • :markup_gl_account_id (Integer) —

    Filters results to bills associated with a specific markup general ledger account.

  • :paid (Boolean) —

    Filters results by the bill&#39;s paid status. If no status is specified, bills with any status will be returned.

  • :bill_date_start (Date) —

    Filters results to any bill with a billing date on or after to the date specified.

  • :bill_date_end (Date) —

    Filters results to any bill with a billing date on or prior to the date specified.

  • :due_date_start (Date) —

    Filters results to any bill with a due date on or after to the date specified.

  • :due_date_end (Date) —

    Filters results to any bill with a due date on or prior to the date specified.

Returns:



721
722
723
724
 
# File 'lib/propertyware/api/bills_api.rb', line 721

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

#get_bills_with_http_info(opts = {}) ⇒ Array<(Array<Bill>, Integer, Hash)>

Retrieve all bills (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 bills.&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;BILLS&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;createddate&lt;/code&gt;, &lt;code&gt;billdate&lt;/code&gt;, &lt;code&gt;billnumber&lt;/code&gt;, &lt;code&gt;lastmodifieddatetime&lt;/code&gt;, &lt;code&gt;duedate&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.

  • :portfolio_id (Integer) —

    Filters results to bills associated with a specific portfolio.

  • :vendor_id (Integer) —

    Filters results to bills associated with a specific vendor.

  • :work_order_id (Integer) —

    Filters results to bills associated with a specific work order.

  • :markup_gl_account_id (Integer) —

    Filters results to bills associated with a specific markup general ledger account.

  • :paid (Boolean) —

    Filters results by the bill&#39;s paid status. If no status is specified, bills with any status will be returned.

  • :bill_date_start (Date) —

    Filters results to any bill with a billing date on or after to the date specified.

  • :bill_date_end (Date) —

    Filters results to any bill with a billing date on or prior to the date specified.

  • :due_date_start (Date) —

    Filters results to any bill with a due date on or after to the date specified.

  • :due_date_end (Date) —

    Filters results to any bill with a due date on or prior to the date specified.

Returns:

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

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



744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
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
 
# File 'lib/propertyware/api/bills_api.rb', line 744

def get_bills_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BillsApi.get_bills ...'
  end
  # resource path
  local_var_path = '/bills'

  # 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[:'portfolioID'] = opts[:'portfolio_id'] if !opts[:'portfolio_id'].nil?
  query_params[:'vendorID'] = opts[:'vendor_id'] if !opts[:'vendor_id'].nil?
  query_params[:'workOrderID'] = opts[:'work_order_id'] if !opts[:'work_order_id'].nil?
  query_params[:'markupGLAccountID'] = opts[:'markup_gl_account_id'] if !opts[:'markup_gl_account_id'].nil?
  query_params[:'paid'] = opts[:'paid'] if !opts[:'paid'].nil?
  query_params[:'billDateStart'] = opts[:'bill_date_start'] if !opts[:'bill_date_start'].nil?
  query_params[:'billDateEnd'] = opts[:'bill_date_end'] if !opts[:'bill_date_end'].nil?
  query_params[:'dueDateStart'] = opts[:'due_date_start'] if !opts[:'due_date_start'].nil?
  query_params[:'dueDateEnd'] = opts[:'due_date_end'] if !opts[:'due_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<Bill>'

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

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

#get_vendor_checks(opts = {}) ⇒ Array<Check>

Retrieve all Vendor checks (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 Vendor checks.<br/><br/>Required permission:<br/><span class="permissionBlock">VENDORS</span> - Read <br/><br/>Sortable by: postdate, createddate, vendorid, 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.

  • :vendor_id (Integer) —

    Filters results to transactions associated with a specific vendor.

Returns:



815
816
817
818
 
# File 'lib/propertyware/api/bills_api.rb', line 815

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

#get_vendor_checks_with_http_info(opts = {}) ⇒ Array<(Array<Check>, Integer, Hash)>

Retrieve all Vendor checks (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 Vendor checks.&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;VENDORS&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;vendorid&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.

  • :vendor_id (Integer) —

    Filters results to transactions associated with a specific vendor.

Returns:

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

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



833
834
835
836
837
838
839
840
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
 
# File 'lib/propertyware/api/bills_api.rb', line 833

def get_vendor_checks_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BillsApi.get_vendor_checks ...'
  end
  # resource path
  local_var_path = '/bills/vendorChecks'

  # 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[:'vendorID'] = opts[:'vendor_id'] if !opts[:'vendor_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<Check>'

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

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

#update_bill(bill_id, save_bill, opts = {}) ⇒ Bill

Update a Bill (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> Update an existing bill.<br/><br/>Required permission:<br/><span class="permissionBlock">BILLS</span> - Write

Parameters:

  • bill_id (Integer) —

    Bill ID

  • save_bill (SaveBill) —

    saveBill

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

    the optional parameters

Returns:



892
893
894
895
 
# File 'lib/propertyware/api/bills_api.rb', line 892

def update_bill(bill_id, save_bill, opts = {})
  data, _status_code, _headers = update_bill_with_http_info(bill_id, save_bill, opts)
  data
end

#update_bill_payment(bill_payment_id, save_bill_payment, opts = {}) ⇒ BillPayment

Update a Bill Payment (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> Update a Bill Payment<br/><br/>Required permission:<br/><span class="permissionBlock">VENDORS</span> - Write

Parameters:

  • bill_payment_id (Integer) —

    Bill Payment ID

  • save_bill_payment (SaveBillPayment) —

    saveBillPayment

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

    the optional parameters

Returns:



966
967
968
969
 
# File 'lib/propertyware/api/bills_api.rb', line 966

def update_bill_payment(bill_payment_id, save_bill_payment, opts = {})
  data, _status_code, _headers = update_bill_payment_with_http_info(bill_payment_id, save_bill_payment, opts)
  data
end

#update_bill_payment_with_http_info(bill_payment_id, save_bill_payment, opts = {}) ⇒ Array<(BillPayment, Integer, Hash)>

Update a Bill Payment (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; Update a Bill Payment&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;VENDORS&lt;/span&gt; - &lt;code&gt;Write&lt;/code&gt;

Parameters:

  • bill_payment_id (Integer) —

    Bill Payment ID

  • save_bill_payment (SaveBillPayment) —

    saveBillPayment

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

    the optional parameters

Returns:

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

    BillPayment data, response status code and response headers



977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
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
 
# File 'lib/propertyware/api/bills_api.rb', line 977

def update_bill_payment_with_http_info(bill_payment_id, save_bill_payment, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BillsApi.update_bill_payment ...'
  end
  # verify the required parameter 'bill_payment_id' is set
  if @api_client.config.client_side_validation && bill_payment_id.nil?
    fail ArgumentError, "Missing the required parameter 'bill_payment_id' when calling BillsApi.update_bill_payment"
  end
  # verify the required parameter 'save_bill_payment' is set
  if @api_client.config.client_side_validation && save_bill_payment.nil?
    fail ArgumentError, "Missing the required parameter 'save_bill_payment' when calling BillsApi.update_bill_payment"
  end
  # resource path
  local_var_path = '/bills/payment/{billPaymentID}'.sub('{' + 'billPaymentID' + '}', CGI.escape(bill_payment_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(save_bill_payment)

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

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

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

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

#update_bill_with_http_info(bill_id, save_bill, opts = {}) ⇒ Array<(Bill, Integer, Hash)>

Update a Bill (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; Update an existing bill.&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;BILLS&lt;/span&gt; - &lt;code&gt;Write&lt;/code&gt;

Parameters:

  • bill_id (Integer) —

    Bill ID

  • save_bill (SaveBill) —

    saveBill

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

    the optional parameters

Returns:

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

    Bill data, response status code and response headers



903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
 
# File 'lib/propertyware/api/bills_api.rb', line 903

def update_bill_with_http_info(bill_id, save_bill, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BillsApi.update_bill ...'
  end
  # verify the required parameter 'bill_id' is set
  if @api_client.config.client_side_validation && bill_id.nil?
    fail ArgumentError, "Missing the required parameter 'bill_id' when calling BillsApi.update_bill"
  end
  # verify the required parameter 'save_bill' is set
  if @api_client.config.client_side_validation && save_bill.nil?
    fail ArgumentError, "Missing the required parameter 'save_bill' when calling BillsApi.update_bill"
  end
  # resource path
  local_var_path = '/bills/{billId}'.sub('{' + 'billId' + '}', CGI.escape(bill_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_bill)

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

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

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

#update_credit(credit_id, save_credit, opts = {}) ⇒ Bill

Update a Credit (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> Update an existing Credit.<br/><br/>Required permission:<br/><span class="permissionBlock">BILLS</span> - Write

Parameters:

  • credit_id (Integer) —

    Credit ID

  • save_credit (SaveCredit) —

    saveCredit

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

    the optional parameters

Returns:



1040
1041
1042
1043
 
# File 'lib/propertyware/api/bills_api.rb', line 1040

def update_credit(credit_id, save_credit, opts = {})
  data, _status_code, _headers = update_credit_with_http_info(credit_id, save_credit, opts)
  data
end

#update_credit_with_http_info(credit_id, save_credit, opts = {}) ⇒ Array<(Bill, Integer, Hash)>

Update a Credit (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; Update an existing Credit.&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;BILLS&lt;/span&gt; - &lt;code&gt;Write&lt;/code&gt;

Parameters:

  • credit_id (Integer) —

    Credit ID

  • save_credit (SaveCredit) —

    saveCredit

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

    the optional parameters

Returns:

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

    Bill data, response status code and response headers



1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
 
# File 'lib/propertyware/api/bills_api.rb', line 1051

def update_credit_with_http_info(credit_id, save_credit, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BillsApi.update_credit ...'
  end
  # verify the required parameter 'credit_id' is set
  if @api_client.config.client_side_validation && credit_id.nil?
    fail ArgumentError, "Missing the required parameter 'credit_id' when calling BillsApi.update_credit"
  end
  # verify the required parameter 'save_credit' is set
  if @api_client.config.client_side_validation && save_credit.nil?
    fail ArgumentError, "Missing the required parameter 'save_credit' when calling BillsApi.update_credit"
  end
  # resource path
  local_var_path = '/bills/credit/{creditID}'.sub('{' + 'creditID' + '}', CGI.escape(credit_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_credit)

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

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

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

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

#update_vendor_check(vendor_check_id, save_check, opts = {}) ⇒ Check

Update a Vendor check (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> Update an existing Vendor check.<br/><br/>Required permission:<br/><span class="permissionBlock">VENDORS</span> - Write

Parameters:

  • vendor_check_id (Integer) —

    Vendor Check ID

  • save_check (SaveCheck) —

    saveCheck

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

    the optional parameters

Returns:



1114
1115
1116
1117
 
# File 'lib/propertyware/api/bills_api.rb', line 1114

def update_vendor_check(vendor_check_id, save_check, opts = {})
  data, _status_code, _headers = update_vendor_check_with_http_info(vendor_check_id, save_check, opts)
  data
end

#update_vendor_check_with_http_info(vendor_check_id, save_check, opts = {}) ⇒ Array<(Check, Integer, Hash)>

Update a Vendor check (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; Update an existing Vendor check.&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;VENDORS&lt;/span&gt; - &lt;code&gt;Write&lt;/code&gt;

Parameters:

  • vendor_check_id (Integer) —

    Vendor Check ID

  • save_check (SaveCheck) —

    saveCheck

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

    the optional parameters

Returns:

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

    Check data, response status code and response headers



1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
 
# File 'lib/propertyware/api/bills_api.rb', line 1125

def update_vendor_check_with_http_info(vendor_check_id, save_check, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BillsApi.update_vendor_check ...'
  end
  # verify the required parameter 'vendor_check_id' is set
  if @api_client.config.client_side_validation && vendor_check_id.nil?
    fail ArgumentError, "Missing the required parameter 'vendor_check_id' when calling BillsApi.update_vendor_check"
  end
  # verify the required parameter 'save_check' is set
  if @api_client.config.client_side_validation && save_check.nil?
    fail ArgumentError, "Missing the required parameter 'save_check' when calling BillsApi.update_vendor_check"
  end
  # resource path
  local_var_path = '/bills/vendorChecks/{vendorCheckID}'.sub('{' + 'vendorCheckID' + '}', CGI.escape(vendor_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(save_check)

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

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

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