propertyware 1.2.0 → 1.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.openapi-generator/FILES +6 -3
- data/.tool-versions +2 -0
- data/DOCS.md +7 -5
- data/Gemfile.lock +4 -2
- data/bin/config.yml +1 -1
- data/bin/fix_json.rb +0 -1
- data/bin/propertyware.json +218 -178
- data/docs/Adjustment.md +40 -0
- data/docs/BankDeposit.md +1 -1
- data/docs/ChargeTx.md +1 -5
- data/docs/ContactCategory.md +20 -0
- data/docs/ContactsApi.md +79 -0
- data/docs/DocumentsApi.md +4 -4
- data/docs/Inspection.md +8 -0
- data/docs/LeasesApi.md +19 -19
- data/docs/OwnerContribution.md +5 -5
- data/docs/OwnerDraw.md +1 -1
- data/docs/Portfolio.md +2 -0
- data/docs/Refund.md +5 -5
- data/docs/SaveAdjustment.md +2 -2
- data/docs/SaveBankDeposit.md +1 -1
- data/docs/SaveContact.md +2 -0
- data/docs/SaveDiscount.md +1 -1
- data/docs/SaveOwnerContribution.md +5 -5
- data/docs/SaveOwnerDraw.md +5 -5
- data/docs/SavePayment.md +6 -6
- data/docs/SavePortfolio.md +6 -0
- data/docs/SaveRefund.md +6 -6
- data/lib/propertyware/api/contacts_api.rb +57 -0
- data/lib/propertyware/api/documents_api.rb +4 -4
- data/lib/propertyware/api/leases_api.rb +14 -14
- data/lib/propertyware/models/account.rb +1 -1
- data/lib/propertyware/models/{transaction.rb → adjustment.rb} +24 -118
- data/lib/propertyware/models/auto_journal_entry.rb +2 -2
- data/lib/propertyware/models/bank_deposit.rb +1 -1
- data/lib/propertyware/models/charge.rb +2 -2
- data/lib/propertyware/models/charge_tx.rb +4 -24
- data/lib/propertyware/models/contact_category.rb +229 -0
- data/lib/propertyware/models/inspection.rb +41 -1
- data/lib/propertyware/models/owner_contribution.rb +0 -25
- data/lib/propertyware/models/owner_draw.rb +0 -5
- data/lib/propertyware/models/portfolio.rb +11 -1
- data/lib/propertyware/models/refund.rb +2 -27
- data/lib/propertyware/models/save_adjustment.rb +2 -2
- data/lib/propertyware/models/save_bank_deposit.rb +1 -1
- data/lib/propertyware/models/save_contact.rb +11 -1
- data/lib/propertyware/models/save_discount.rb +1 -1
- data/lib/propertyware/models/save_owner_contribution.rb +5 -5
- data/lib/propertyware/models/save_owner_draw.rb +5 -5
- data/lib/propertyware/models/save_payment.rb +6 -6
- data/lib/propertyware/models/save_portfolio.rb +31 -1
- data/lib/propertyware/models/save_refund.rb +7 -17
- data/lib/propertyware/version.rb +1 -1
- data/lib/propertyware.rb +2 -1
- data/spec/api/contacts_api_spec.rb +11 -0
- data/spec/api/documents_api_spec.rb +2 -2
- data/spec/api/leases_api_spec.rb +5 -5
- data/spec/models/{transaction_spec.rb → adjustment_spec.rb} +6 -52
- data/spec/models/auto_journal_entry_spec.rb +1 -1
- data/spec/models/charge_spec.rb +1 -1
- data/spec/models/charge_tx_spec.rb +0 -12
- data/spec/models/contact_category_spec.rb +40 -0
- data/spec/models/inspection_spec.rb +24 -0
- data/spec/models/portfolio_spec.rb +6 -0
- data/spec/models/save_contact_spec.rb +6 -0
- data/spec/models/save_portfolio_spec.rb +18 -0
- metadata +11 -6
- data/docs/Transaction.md +0 -54
data/docs/Adjustment.md
ADDED
@@ -0,0 +1,40 @@
|
|
1
|
+
# Propertyware::Adjustment
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **amount** | **Float** | Amount. | |
|
8
|
+
| **comments** | **String** | Comments. | [optional] |
|
9
|
+
| **created_by** | **String** | User who created the record. | [optional] |
|
10
|
+
| **created_date_time** | **Time** | Date and time the record was created. (Timezone: UTC) | [optional] |
|
11
|
+
| **date** | **Date** | Post date. | |
|
12
|
+
| **gl_account_id** | **Integer** | Id of the general ledger account associated with this charge. | [optional] |
|
13
|
+
| **id** | **Integer** | Unique identifier. | [optional] |
|
14
|
+
| **last_modified_by** | **String** | User who last modified the record. | [optional] |
|
15
|
+
| **last_modified_date_time** | **Time** | Date and time the record was last modified. (Timezone: UTC) | [optional] |
|
16
|
+
| **lease_id** | **Integer** | Id of the lease associated with this charge. | [optional] |
|
17
|
+
| **portfolio_id** | **Integer** | Id of the portfolio associated with this charge. | [optional] |
|
18
|
+
| **ref_no** | **String** | Reference number. | [optional] |
|
19
|
+
|
20
|
+
## Example
|
21
|
+
|
22
|
+
```ruby
|
23
|
+
require 'propertyware'
|
24
|
+
|
25
|
+
instance = Propertyware::Adjustment.new(
|
26
|
+
amount: null,
|
27
|
+
comments: null,
|
28
|
+
created_by: null,
|
29
|
+
created_date_time: null,
|
30
|
+
date: null,
|
31
|
+
gl_account_id: null,
|
32
|
+
id: null,
|
33
|
+
last_modified_by: null,
|
34
|
+
last_modified_date_time: null,
|
35
|
+
lease_id: null,
|
36
|
+
portfolio_id: null,
|
37
|
+
ref_no: null
|
38
|
+
)
|
39
|
+
```
|
40
|
+
|
data/docs/BankDeposit.md
CHANGED
@@ -10,7 +10,7 @@
|
|
10
10
|
| **id** | **Integer** | Unique identifier. | [optional] |
|
11
11
|
| **last_modified_by** | **String** | User who last modified the record. | [optional] |
|
12
12
|
| **last_modified_date_time** | **Time** | Date and time the record was last modified. (Timezone: UTC) | [optional] |
|
13
|
-
| **name** | **String** |
|
13
|
+
| **name** | **String** | Bank deposit name. | [optional] |
|
14
14
|
| **status** | **String** | Status. | [optional] |
|
15
15
|
|
16
16
|
## Example
|
data/docs/ChargeTx.md
CHANGED
@@ -7,7 +7,6 @@
|
|
7
7
|
| **amount** | **Float** | Amount. | |
|
8
8
|
| **amount_due** | **Float** | The amount due for the charge. | [optional] |
|
9
9
|
| **amount_paid** | **Float** | The amount paid for the charge. | [optional] |
|
10
|
-
| **charge_status** | **String** | Status of the charge. | [optional] |
|
11
10
|
| **comments** | **String** | Comments. | [optional] |
|
12
11
|
| **created_by** | **String** | User who created the record. | [optional] |
|
13
12
|
| **created_date_time** | **Time** | Date and time the record was created. (Timezone: UTC) | [optional] |
|
@@ -21,7 +20,6 @@
|
|
21
20
|
| **payments** | [**Array<PaymentCharge>**](PaymentCharge.md) | List of payment charge history. | [optional] |
|
22
21
|
| **portfolio_id** | **Integer** | Id of the portfolio associated with this charge. | [optional] |
|
23
22
|
| **ref_no** | **String** | Reference number. | [optional] |
|
24
|
-
| **status** | **String** | The status of the lease. | [optional] |
|
25
23
|
|
26
24
|
## Example
|
27
25
|
|
@@ -32,7 +30,6 @@ instance = Propertyware::ChargeTx.new(
|
|
32
30
|
amount: null,
|
33
31
|
amount_due: null,
|
34
32
|
amount_paid: null,
|
35
|
-
charge_status: null,
|
36
33
|
comments: null,
|
37
34
|
created_by: null,
|
38
35
|
created_date_time: null,
|
@@ -45,8 +42,7 @@ instance = Propertyware::ChargeTx.new(
|
|
45
42
|
parent_tx_id: null,
|
46
43
|
payments: null,
|
47
44
|
portfolio_id: null,
|
48
|
-
ref_no: null
|
49
|
-
status: null
|
45
|
+
ref_no: null
|
50
46
|
)
|
51
47
|
```
|
52
48
|
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# Propertyware::ContactCategory
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **category_name** | **String** | Category name. | [optional] |
|
8
|
+
| **id** | **Integer** | Unique identifier. | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'propertyware'
|
14
|
+
|
15
|
+
instance = Propertyware::ContactCategory.new(
|
16
|
+
category_name: null,
|
17
|
+
id: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
data/docs/ContactsApi.md
CHANGED
@@ -9,6 +9,7 @@ All URIs are relative to *https://api.propertyware.com/pw/api/rest/v1*
|
|
9
9
|
| [**delete_contact**](ContactsApi.md#delete_contact) | **DELETE** /contacts/{contactID} | Delete a contact (BETA) |
|
10
10
|
| [**delete_contact_conversation**](ContactsApi.md#delete_contact_conversation) | **DELETE** /contacts/{contactID}/conversations/{conversationID} | Delete a contact conversation (BETA) |
|
11
11
|
| [**get_contact**](ContactsApi.md#get_contact) | **GET** /contacts/{contactID} | Retrieve a contact |
|
12
|
+
| [**get_contact_categories**](ContactsApi.md#get_contact_categories) | **GET** /contacts/categories | Retrieve all contact categories |
|
12
13
|
| [**get_contact_conversation**](ContactsApi.md#get_contact_conversation) | **GET** /contacts/{contactID}/conversations/{conversationID} | Retrieve a contact conversation |
|
13
14
|
| [**get_contact_conversations**](ContactsApi.md#get_contact_conversations) | **GET** /contacts/{contactID}/conversations | Retrieve all contact conversations |
|
14
15
|
| [**get_contacts**](ContactsApi.md#get_contacts) | **GET** /contacts | Retrieve all contacts |
|
@@ -426,6 +427,84 @@ end
|
|
426
427
|
- **Accept**: application/json
|
427
428
|
|
428
429
|
|
430
|
+
## get_contact_categories
|
431
|
+
|
432
|
+
> <Array<ContactCategory>> get_contact_categories
|
433
|
+
|
434
|
+
Retrieve all contact categories
|
435
|
+
|
436
|
+
Retrieves a list of contact categories.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">CONTACTS</span> - <code>Read</code>
|
437
|
+
|
438
|
+
### Examples
|
439
|
+
|
440
|
+
```ruby
|
441
|
+
require 'time'
|
442
|
+
require 'propertyware'
|
443
|
+
# setup authorization
|
444
|
+
Propertyware.configure do |config|
|
445
|
+
# Configure API key authorization: organizationId
|
446
|
+
config.api_key['organizationId'] = 'YOUR API KEY'
|
447
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
448
|
+
# config.api_key_prefix['organizationId'] = 'Bearer'
|
449
|
+
|
450
|
+
# Configure API key authorization: clientId
|
451
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
452
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
453
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
454
|
+
|
455
|
+
# Configure API key authorization: clientSecret
|
456
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
457
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
458
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
459
|
+
end
|
460
|
+
|
461
|
+
api_instance = Propertyware::ContactsApi.new
|
462
|
+
|
463
|
+
begin
|
464
|
+
# Retrieve all contact categories
|
465
|
+
result = api_instance.get_contact_categories
|
466
|
+
p result
|
467
|
+
rescue Propertyware::ApiError => e
|
468
|
+
puts "Error when calling ContactsApi->get_contact_categories: #{e}"
|
469
|
+
end
|
470
|
+
```
|
471
|
+
|
472
|
+
#### Using the get_contact_categories_with_http_info variant
|
473
|
+
|
474
|
+
This returns an Array which contains the response data, status code and headers.
|
475
|
+
|
476
|
+
> <Array(<Array<ContactCategory>>, Integer, Hash)> get_contact_categories_with_http_info
|
477
|
+
|
478
|
+
```ruby
|
479
|
+
begin
|
480
|
+
# Retrieve all contact categories
|
481
|
+
data, status_code, headers = api_instance.get_contact_categories_with_http_info
|
482
|
+
p status_code # => 2xx
|
483
|
+
p headers # => { ... }
|
484
|
+
p data # => <Array<ContactCategory>>
|
485
|
+
rescue Propertyware::ApiError => e
|
486
|
+
puts "Error when calling ContactsApi->get_contact_categories_with_http_info: #{e}"
|
487
|
+
end
|
488
|
+
```
|
489
|
+
|
490
|
+
### Parameters
|
491
|
+
|
492
|
+
This endpoint does not need any parameter.
|
493
|
+
|
494
|
+
### Return type
|
495
|
+
|
496
|
+
[**Array<ContactCategory>**](ContactCategory.md)
|
497
|
+
|
498
|
+
### Authorization
|
499
|
+
|
500
|
+
[organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
501
|
+
|
502
|
+
### HTTP request headers
|
503
|
+
|
504
|
+
- **Content-Type**: Not defined
|
505
|
+
- **Accept**: application/json
|
506
|
+
|
507
|
+
|
429
508
|
## get_contact_conversation
|
430
509
|
|
431
510
|
> <Conversation> get_contact_conversation(contact_id, conversation_id)
|
data/docs/DocumentsApi.md
CHANGED
@@ -213,7 +213,7 @@ opts = {
|
|
213
213
|
last_modified_date_time_start: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filters results to any item modified on or after the date time specified.
|
214
214
|
last_modified_date_time_end: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filters results to any item modified on or prior to the date time specified.
|
215
215
|
orderby: 'orderby_example', # String | Indicates the field(s) and direction to sort the results in the response.
|
216
|
-
entity_id: 789 # Integer | Filters results to documents associated with a specific entity id. entity ID is not required for
|
216
|
+
entity_id: 789 # Integer | Filters results to documents associated with a specific entity id. entity ID is not required for DESKTOP and OTHER. Remaining entities need entity ID.
|
217
217
|
}
|
218
218
|
|
219
219
|
begin
|
@@ -253,7 +253,7 @@ end
|
|
253
253
|
| **last_modified_date_time_start** | **Time** | Filters results to any item modified on or after the date time specified. | [optional] |
|
254
254
|
| **last_modified_date_time_end** | **Time** | Filters results to any item modified on or prior to the date time specified. | [optional] |
|
255
255
|
| **orderby** | **String** | Indicates the field(s) and direction to sort the results in the response. | [optional] |
|
256
|
-
| **entity_id** | **Integer** | Filters results to documents associated with a specific entity id. entity ID is not required for
|
256
|
+
| **entity_id** | **Integer** | Filters results to documents associated with a specific entity id. entity ID is not required for DESKTOP and OTHER. Remaining entities need entity ID. | [optional] |
|
257
257
|
|
258
258
|
### Return type
|
259
259
|
|
@@ -466,7 +466,7 @@ end
|
|
466
466
|
|
467
467
|
api_instance = Propertyware::DocumentsApi.new
|
468
468
|
entity_id = 789 # Integer | Unique identifier of an entity document is attached to.
|
469
|
-
entity_type = 'entity_type_example' # String | Entity type Document is attached to (Bill, Building, Desktop,
|
469
|
+
entity_type = 'entity_type_example' # String | Entity type Document is attached to (Asset, Bill, Bank Deposit, Building, Desktop, Lease, Owner, Portfolio, Prospect, Prospect Contact, Tenant, Unit, Vendor, Check, Credit, Service Agreement, Journal Entry, Work Order)
|
470
470
|
body = File.new('/path/to/some/file') # File |
|
471
471
|
opts = {
|
472
472
|
publish_to_tenant_portal: true, # Boolean | Indicates if the document is published to the tenant portal.
|
@@ -505,7 +505,7 @@ end
|
|
505
505
|
| Name | Type | Description | Notes |
|
506
506
|
| ---- | ---- | ----------- | ----- |
|
507
507
|
| **entity_id** | **Integer** | Unique identifier of an entity document is attached to. | |
|
508
|
-
| **entity_type** | **String** | Entity type Document is attached to (Bill, Building, Desktop,
|
508
|
+
| **entity_type** | **String** | Entity type Document is attached to (Asset, Bill, Bank Deposit, Building, Desktop, Lease, Owner, Portfolio, Prospect, Prospect Contact, Tenant, Unit, Vendor, Check, Credit, Service Agreement, Journal Entry, Work Order) | |
|
509
509
|
| **body** | **File** | | |
|
510
510
|
| **publish_to_tenant_portal** | **Boolean** | Indicates if the document is published to the tenant portal. | [optional] |
|
511
511
|
| **publish_to_owner_portal** | **Boolean** | Indicates if the document is published to the owner portal. | [optional] |
|
data/docs/Inspection.md
CHANGED
@@ -5,14 +5,18 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **building_id** | **Integer** | Id of the building associated with this inspection. | [optional] |
|
8
|
+
| **closed_date_and_time** | **Time** | Date and time the inspection closed (customer time zone). | [optional] |
|
8
9
|
| **comment** | **String** | Inspection comments. | [optional] |
|
9
10
|
| **created_by** | **String** | User who created the record. | [optional] |
|
10
11
|
| **created_date_time** | **Time** | Date and time the record was created. (Timezone: UTC) | [optional] |
|
11
12
|
| **id** | **Integer** | Unique identifier. | [optional] |
|
12
13
|
| **inspected_date_and_time** | **Time** | Date and time the inspection occurred (customer time zone). | [optional] |
|
13
14
|
| **inspection_areas** | [**Array<InspectionArea>**](InspectionArea.md) | List of inspection areas. | [optional] |
|
15
|
+
| **inspector_id** | **Integer** | Inspector ID | [optional] |
|
14
16
|
| **last_modified_by** | **String** | User who last modified the record. | [optional] |
|
15
17
|
| **last_modified_date_time** | **Time** | Date and time the record was last modified. (Timezone: UTC) | [optional] |
|
18
|
+
| **lease_id** | **Integer** | Id of the lease associated with this inspection. | [optional] |
|
19
|
+
| **notes_to_inspector** | **String** | Notes to Inspector | [optional] |
|
16
20
|
| **number** | **Integer** | Inspection number. | [optional] |
|
17
21
|
| **portfolio_id** | **Integer** | Id of the portfolio associated with this inspection. | [optional] |
|
18
22
|
| **scheduled_date_and_time** | **Time** | Date and time the inspection is/was scheduled to occur (customer time zone). | [optional] |
|
@@ -27,14 +31,18 @@ require 'propertyware'
|
|
27
31
|
|
28
32
|
instance = Propertyware::Inspection.new(
|
29
33
|
building_id: null,
|
34
|
+
closed_date_and_time: null,
|
30
35
|
comment: null,
|
31
36
|
created_by: null,
|
32
37
|
created_date_time: null,
|
33
38
|
id: null,
|
34
39
|
inspected_date_and_time: null,
|
35
40
|
inspection_areas: null,
|
41
|
+
inspector_id: null,
|
36
42
|
last_modified_by: null,
|
37
43
|
last_modified_date_time: null,
|
44
|
+
lease_id: null,
|
45
|
+
notes_to_inspector: null,
|
38
46
|
number: null,
|
39
47
|
portfolio_id: null,
|
40
48
|
scheduled_date_and_time: null,
|
data/docs/LeasesApi.md
CHANGED
@@ -295,7 +295,7 @@ end
|
|
295
295
|
|
296
296
|
## create_lease_adjustment
|
297
297
|
|
298
|
-
> <
|
298
|
+
> <Adjustment> create_lease_adjustment(save_adjustment)
|
299
299
|
|
300
300
|
Create a lease adjustment (BETA)
|
301
301
|
|
@@ -340,7 +340,7 @@ end
|
|
340
340
|
|
341
341
|
This returns an Array which contains the response data, status code and headers.
|
342
342
|
|
343
|
-
> <Array(<
|
343
|
+
> <Array(<Adjustment>, Integer, Hash)> create_lease_adjustment_with_http_info(save_adjustment)
|
344
344
|
|
345
345
|
```ruby
|
346
346
|
begin
|
@@ -348,7 +348,7 @@ begin
|
|
348
348
|
data, status_code, headers = api_instance.create_lease_adjustment_with_http_info(save_adjustment)
|
349
349
|
p status_code # => 2xx
|
350
350
|
p headers # => { ... }
|
351
|
-
p data # => <
|
351
|
+
p data # => <Adjustment>
|
352
352
|
rescue Propertyware::ApiError => e
|
353
353
|
puts "Error when calling LeasesApi->create_lease_adjustment_with_http_info: #{e}"
|
354
354
|
end
|
@@ -362,7 +362,7 @@ end
|
|
362
362
|
|
363
363
|
### Return type
|
364
364
|
|
365
|
-
[**
|
365
|
+
[**Adjustment**](Adjustment.md)
|
366
366
|
|
367
367
|
### Authorization
|
368
368
|
|
@@ -813,7 +813,7 @@ Propertyware.configure do |config|
|
|
813
813
|
end
|
814
814
|
|
815
815
|
api_instance = Propertyware::LeasesApi.new
|
816
|
-
save_refund = Propertyware::SaveRefund.new({amount: 3.56, date: Date.today, destination_account_id: 3.56, gl_account_id: 3.56, lease_id: 3.56
|
816
|
+
save_refund = Propertyware::SaveRefund.new({amount: 3.56, date: Date.today, destination_account_id: 3.56, gl_account_id: 3.56, lease_id: 3.56}) # SaveRefund | saveRefund
|
817
817
|
|
818
818
|
begin
|
819
819
|
# Create a lease refund (BETA)
|
@@ -1191,11 +1191,11 @@ end
|
|
1191
1191
|
|
1192
1192
|
## get_lease_adjustments
|
1193
1193
|
|
1194
|
-
> <Array<
|
1194
|
+
> <Array<Adjustment>> get_lease_adjustments(opts)
|
1195
1195
|
|
1196
1196
|
Retrieve all the adjustments
|
1197
1197
|
|
1198
|
-
Retrieves a list of adjustments.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">
|
1198
|
+
Retrieves a list of adjustments.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">LEASES</span> - <code>Read</code> <br/><br/><b>Sortable by:</b> <code>leaseid</code>, <code>postdate</code>, <code>id</code>
|
1199
1199
|
|
1200
1200
|
### Examples
|
1201
1201
|
|
@@ -1247,7 +1247,7 @@ end
|
|
1247
1247
|
|
1248
1248
|
This returns an Array which contains the response data, status code and headers.
|
1249
1249
|
|
1250
|
-
> <Array(<Array<
|
1250
|
+
> <Array(<Array<Adjustment>>, Integer, Hash)> get_lease_adjustments_with_http_info(opts)
|
1251
1251
|
|
1252
1252
|
```ruby
|
1253
1253
|
begin
|
@@ -1255,7 +1255,7 @@ begin
|
|
1255
1255
|
data, status_code, headers = api_instance.get_lease_adjustments_with_http_info(opts)
|
1256
1256
|
p status_code # => 2xx
|
1257
1257
|
p headers # => { ... }
|
1258
|
-
p data # => <Array<
|
1258
|
+
p data # => <Array<Adjustment>>
|
1259
1259
|
rescue Propertyware::ApiError => e
|
1260
1260
|
puts "Error when calling LeasesApi->get_lease_adjustments_with_http_info: #{e}"
|
1261
1261
|
end
|
@@ -1278,7 +1278,7 @@ end
|
|
1278
1278
|
|
1279
1279
|
### Return type
|
1280
1280
|
|
1281
|
-
[**Array<
|
1281
|
+
[**Array<Adjustment>**](Adjustment.md)
|
1282
1282
|
|
1283
1283
|
### Authorization
|
1284
1284
|
|
@@ -2081,7 +2081,7 @@ end
|
|
2081
2081
|
|
2082
2082
|
## get_lease_discounts
|
2083
2083
|
|
2084
|
-
> <Array<
|
2084
|
+
> <Array<Discount>> get_lease_discounts(opts)
|
2085
2085
|
|
2086
2086
|
Retrieve all the lease discounts
|
2087
2087
|
|
@@ -2135,7 +2135,7 @@ end
|
|
2135
2135
|
|
2136
2136
|
This returns an Array which contains the response data, status code and headers.
|
2137
2137
|
|
2138
|
-
> <Array(<Array<
|
2138
|
+
> <Array(<Array<Discount>>, Integer, Hash)> get_lease_discounts_with_http_info(opts)
|
2139
2139
|
|
2140
2140
|
```ruby
|
2141
2141
|
begin
|
@@ -2143,7 +2143,7 @@ begin
|
|
2143
2143
|
data, status_code, headers = api_instance.get_lease_discounts_with_http_info(opts)
|
2144
2144
|
p status_code # => 2xx
|
2145
2145
|
p headers # => { ... }
|
2146
|
-
p data # => <Array<
|
2146
|
+
p data # => <Array<Discount>>
|
2147
2147
|
rescue Propertyware::ApiError => e
|
2148
2148
|
puts "Error when calling LeasesApi->get_lease_discounts_with_http_info: #{e}"
|
2149
2149
|
end
|
@@ -2164,7 +2164,7 @@ end
|
|
2164
2164
|
|
2165
2165
|
### Return type
|
2166
2166
|
|
2167
|
-
[**Array<
|
2167
|
+
[**Array<Discount>**](Discount.md)
|
2168
2168
|
|
2169
2169
|
### Authorization
|
2170
2170
|
|
@@ -3003,7 +3003,7 @@ end
|
|
3003
3003
|
|
3004
3004
|
## update_lease_adjustment
|
3005
3005
|
|
3006
|
-
> <
|
3006
|
+
> <Adjustment> update_lease_adjustment(adjustment_id, save_adjustment)
|
3007
3007
|
|
3008
3008
|
Update a lease adjustment (BETA)
|
3009
3009
|
|
@@ -3049,7 +3049,7 @@ end
|
|
3049
3049
|
|
3050
3050
|
This returns an Array which contains the response data, status code and headers.
|
3051
3051
|
|
3052
|
-
> <Array(<
|
3052
|
+
> <Array(<Adjustment>, Integer, Hash)> update_lease_adjustment_with_http_info(adjustment_id, save_adjustment)
|
3053
3053
|
|
3054
3054
|
```ruby
|
3055
3055
|
begin
|
@@ -3057,7 +3057,7 @@ begin
|
|
3057
3057
|
data, status_code, headers = api_instance.update_lease_adjustment_with_http_info(adjustment_id, save_adjustment)
|
3058
3058
|
p status_code # => 2xx
|
3059
3059
|
p headers # => { ... }
|
3060
|
-
p data # => <
|
3060
|
+
p data # => <Adjustment>
|
3061
3061
|
rescue Propertyware::ApiError => e
|
3062
3062
|
puts "Error when calling LeasesApi->update_lease_adjustment_with_http_info: #{e}"
|
3063
3063
|
end
|
@@ -3072,7 +3072,7 @@ end
|
|
3072
3072
|
|
3073
3073
|
### Return type
|
3074
3074
|
|
3075
|
-
[**
|
3075
|
+
[**Adjustment**](Adjustment.md)
|
3076
3076
|
|
3077
3077
|
### Authorization
|
3078
3078
|
|
@@ -3449,7 +3449,7 @@ end
|
|
3449
3449
|
|
3450
3450
|
api_instance = Propertyware::LeasesApi.new
|
3451
3451
|
refund_id = 789 # Integer | Refund ID
|
3452
|
-
save_refund = Propertyware::SaveRefund.new({amount: 3.56, date: Date.today, destination_account_id: 3.56, gl_account_id: 3.56, lease_id: 3.56
|
3452
|
+
save_refund = Propertyware::SaveRefund.new({amount: 3.56, date: Date.today, destination_account_id: 3.56, gl_account_id: 3.56, lease_id: 3.56}) # SaveRefund | saveRefund
|
3453
3453
|
|
3454
3454
|
begin
|
3455
3455
|
# Update a lease refund (BETA)
|
data/docs/OwnerContribution.md
CHANGED
@@ -6,17 +6,17 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **amount** | **Float** | Amount. | |
|
8
8
|
| **comments** | **String** | Comments. | [optional] |
|
9
|
-
| **contact_id** | **Integer** | Id of the contact associated with this owner contribution. |
|
9
|
+
| **contact_id** | **Integer** | Id of the contact associated with this owner contribution. | [optional] |
|
10
10
|
| **created_by** | **String** | User who created the record. | [optional] |
|
11
11
|
| **created_date_time** | **Time** | Date and time the record was created. (Timezone: UTC) | [optional] |
|
12
12
|
| **date** | **Date** | Post date. | |
|
13
|
-
| **destination_account_id** | **Integer** | Id of the bank account where the payment will be deposited. |
|
14
|
-
| **gl_account_id** | **Integer** | Id of the general ledger account associated with this owner contribution. |
|
13
|
+
| **destination_account_id** | **Integer** | Id of the bank account where the payment will be deposited. | [optional] |
|
14
|
+
| **gl_account_id** | **Integer** | Id of the general ledger account associated with this owner contribution. | [optional] |
|
15
15
|
| **id** | **Integer** | Unique identifier. | [optional] |
|
16
16
|
| **last_modified_by** | **String** | User who last modified the record. | [optional] |
|
17
17
|
| **last_modified_date_time** | **Time** | Date and time the record was last modified. (Timezone: UTC) | [optional] |
|
18
|
-
| **payment_type** | **String** | Payment type. |
|
19
|
-
| **portfolio_id** | **Integer** | Id of the portfolio to apply the payment to. |
|
18
|
+
| **payment_type** | **String** | Payment type. | [optional] |
|
19
|
+
| **portfolio_id** | **Integer** | Id of the portfolio to apply the payment to. | [optional] |
|
20
20
|
| **ref_no** | **String** | Reference number. | [optional] |
|
21
21
|
|
22
22
|
## Example
|
data/docs/OwnerDraw.md
CHANGED
@@ -11,7 +11,7 @@
|
|
11
11
|
| **created_date_time** | **Time** | Date and time the record was created. (Timezone: UTC) | [optional] |
|
12
12
|
| **date** | **Date** | Post date. | |
|
13
13
|
| **destination_account_id** | **Integer** | Id of the bank account where the payment will be made from. | [optional] |
|
14
|
-
| **gl_account_id** | **Integer** | Id of the general ledger account associated with this owner draw. |
|
14
|
+
| **gl_account_id** | **Integer** | Id of the general ledger account associated with this owner draw. | [optional] |
|
15
15
|
| **id** | **Integer** | Unique identifier. | [optional] |
|
16
16
|
| **last_modified_by** | **String** | User who last modified the record. | [optional] |
|
17
17
|
| **last_modified_date_time** | **Time** | Date and time the record was last modified. (Timezone: UTC) | [optional] |
|
data/docs/Portfolio.md
CHANGED
@@ -23,6 +23,7 @@
|
|
23
23
|
| **maintenance_spending_limit_time** | **String** | Monthly or yearly maintenance spending limit time set for the portfolio for maintenance bills created by work orders. | [optional] |
|
24
24
|
| **modified_by** | **String** | Id of the user who last modified the portfolio information. | [optional] |
|
25
25
|
| **name** | **String** | Portfolio name. | [optional] |
|
26
|
+
| **owner_statement_report_id** | **Integer** | Portfolio Owner Statement Report ID | [optional] |
|
26
27
|
| **owners** | [**Array<Owner>**](Owner.md) | List of portfolio owners. | [optional] |
|
27
28
|
| **sticky_note** | **String** | Sticky notes. | [optional] |
|
28
29
|
| **target_operating_reserve** | **Float** | Minimum balance to be maintained within the portfolio at all times. | [optional] |
|
@@ -52,6 +53,7 @@ instance = Propertyware::Portfolio.new(
|
|
52
53
|
maintenance_spending_limit_time: null,
|
53
54
|
modified_by: null,
|
54
55
|
name: null,
|
56
|
+
owner_statement_report_id: null,
|
55
57
|
owners: null,
|
56
58
|
sticky_note: null,
|
57
59
|
target_operating_reserve: null
|
data/docs/Refund.md
CHANGED
@@ -8,16 +8,16 @@
|
|
8
8
|
| **created_by** | **String** | User who created the record. | [optional] |
|
9
9
|
| **created_date_time** | **Time** | Date and time the record was created. (Timezone: UTC) | [optional] |
|
10
10
|
| **date** | **Date** | Post date. | |
|
11
|
-
| **destination_account_id** | **Integer** | Id of the bank account to send the refund
|
12
|
-
| **gl_account_id** | **Integer** | Id of the general ledger associated with the refund. |
|
11
|
+
| **destination_account_id** | **Integer** | Id of the bank account to send the refund from. | [optional] |
|
12
|
+
| **gl_account_id** | **Integer** | Id of the general ledger account associated with the refund. | [optional] |
|
13
13
|
| **id** | **Integer** | Unique identifier. | [optional] |
|
14
14
|
| **last_modified_by** | **String** | User who last modified the record. | [optional] |
|
15
15
|
| **last_modified_date_time** | **Time** | Date and time the record was last modified. (Timezone: UTC) | [optional] |
|
16
|
-
| **lease_id** | **Integer** | Id of the lease associated with the refund. |
|
17
|
-
| **payee_payer** | **String** | Name of the payee. |
|
16
|
+
| **lease_id** | **Integer** | Id of the lease associated with the refund. | [optional] |
|
17
|
+
| **payee_payer** | **String** | Name of the payee. | [optional] |
|
18
18
|
| **portfolio_id** | **Integer** | Id of the portfolio associated with the refund. | [optional] |
|
19
19
|
| **ref_no** | **String** | Reference number. | [optional] |
|
20
|
-
| **to_be_printed** | **Boolean** | Indicates if the check is to be printed. |
|
20
|
+
| **to_be_printed** | **Boolean** | Indicates if the check is to be printed. | [optional] |
|
21
21
|
|
22
22
|
## Example
|
23
23
|
|
data/docs/SaveAdjustment.md
CHANGED
@@ -7,8 +7,8 @@
|
|
7
7
|
| **amount** | **Float** | Amount, should be negative. | |
|
8
8
|
| **comments** | **String** | Comments. | [optional] |
|
9
9
|
| **date** | **Date** | Lease Adjustment date. | [optional] |
|
10
|
-
| **lease_id** | **Integer** |
|
11
|
-
| **ref_no** | **String** |
|
10
|
+
| **lease_id** | **Integer** | Id of the lease associated with the Adjustment. | |
|
11
|
+
| **ref_no** | **String** | Reference number. | [optional] |
|
12
12
|
|
13
13
|
## Example
|
14
14
|
|
data/docs/SaveBankDeposit.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **bank_gl_account_id** | **Integer** | Bank
|
7
|
+
| **bank_gl_account_id** | **Integer** | Bank general ledger account ID. | |
|
8
8
|
| **list_of_tx_ids** | **String** | Comma separated list of Transaction IDs. | |
|
9
9
|
|
10
10
|
## Example
|
data/docs/SaveContact.md
CHANGED
@@ -8,6 +8,7 @@
|
|
8
8
|
| **allow_e_signature** | **Boolean** | Indicate if the contact can receive eSignature request e-mail messages sent through Propertyware. | [optional] |
|
9
9
|
| **alt_email** | **String** | Alternate Email Address. | [optional] |
|
10
10
|
| **birth_date** | **Date** | Date of Birth. | [optional] |
|
11
|
+
| **category** | **String** | Indicate contact category. Send empty \"\" value if contact is Uncategorized | [optional] |
|
11
12
|
| **comments** | **String** | Description. | [optional] |
|
12
13
|
| **company** | **String** | Company where the contact is employed. | [optional] |
|
13
14
|
| **email** | **String** | E-mail Address. | [optional] |
|
@@ -37,6 +38,7 @@ instance = Propertyware::SaveContact.new(
|
|
37
38
|
allow_e_signature: false,
|
38
39
|
alt_email: null,
|
39
40
|
birth_date: null,
|
41
|
+
category: null,
|
40
42
|
comments: null,
|
41
43
|
company: null,
|
42
44
|
email: null,
|
data/docs/SaveDiscount.md
CHANGED
@@ -8,7 +8,7 @@
|
|
8
8
|
| **comments** | **String** | Comments. | [optional] |
|
9
9
|
| **date** | **Date** | Date. | |
|
10
10
|
| **discount_account_id** | **Integer** | Discount GL Account ID. | |
|
11
|
-
| **lease_id** | **Integer** |
|
11
|
+
| **lease_id** | **Integer** | Id of the lease associated with this discount. | |
|
12
12
|
| **ref_no** | **String** | Ref No. | [optional] |
|
13
13
|
|
14
14
|
## Example
|
@@ -6,13 +6,13 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **amount** | **Float** | Amount. | |
|
8
8
|
| **comments** | **String** | Comments. | [optional] |
|
9
|
-
| **contact_id** | **Integer** |
|
9
|
+
| **contact_id** | **Integer** | Id of the contact associated with this owner contribution. | |
|
10
10
|
| **date** | **Date** | Post Date. | |
|
11
|
-
| **destination_account_id** | **Integer** |
|
12
|
-
| **gl_account_id** | **Integer** |
|
11
|
+
| **destination_account_id** | **Integer** | Id of the bank account where the payment will be deposited. | |
|
12
|
+
| **gl_account_id** | **Integer** | Id of the general ledger account associated with this owner contribution. | |
|
13
13
|
| **payment_type** | **String** | Payment Type. | |
|
14
|
-
| **portfolio_id** | **Integer** |
|
15
|
-
| **ref_no** | **String** |
|
14
|
+
| **portfolio_id** | **Integer** | Id of the portfolio to apply the payment to. | |
|
15
|
+
| **ref_no** | **String** | Reference No. | |
|
16
16
|
|
17
17
|
## Example
|
18
18
|
|
data/docs/SaveOwnerDraw.md
CHANGED
@@ -6,12 +6,12 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **amount** | **Float** | Amount. | |
|
8
8
|
| **comments** | **String** | Comments. | [optional] |
|
9
|
-
| **contact_id** | **Integer** |
|
9
|
+
| **contact_id** | **Integer** | Id of the contact associated with this owner draw. | |
|
10
10
|
| **date** | **Date** | Post Date. | |
|
11
|
-
| **destination_account_id** | **Integer** |
|
12
|
-
| **gl_account_id** | **Integer** |
|
13
|
-
| **portfolio_id** | **Integer** |
|
14
|
-
| **ref_no** | **String** | Check no required when payment method is Hand written check . | [optional] |
|
11
|
+
| **destination_account_id** | **Integer** | Id of the bank account where the payment will be made from. | |
|
12
|
+
| **gl_account_id** | **Integer** | Id of the general ledger account associated with this owner draw. | |
|
13
|
+
| **portfolio_id** | **Integer** | Id of the portfolio associated with this owner draw. | |
|
14
|
+
| **ref_no** | **String** | Check no required when payment method is Hand written check (i.e toBePrinted = false). | [optional] |
|
15
15
|
| **to_be_printed** | **Boolean** | Indicates if Check is to be printed. | |
|
16
16
|
|
17
17
|
## Example
|
data/docs/SavePayment.md
CHANGED
@@ -6,13 +6,13 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **amount** | **Float** | Amount. | |
|
8
8
|
| **comments** | **String** | Comments. | [optional] |
|
9
|
-
| **contact_id** | **Integer** |
|
9
|
+
| **contact_id** | **Integer** | Id of the contact associated with lease payment | |
|
10
10
|
| **date** | **Date** | Post Date. | |
|
11
|
-
| **deposit_date** | **Date** | Payment
|
12
|
-
| **destination_account_id** | **Integer** | Bank
|
13
|
-
| **lease_id** | **Integer** |
|
14
|
-
| **payment_type** | **String** | Payment
|
15
|
-
| **ref_no** | **String** | Payment
|
11
|
+
| **deposit_date** | **Date** | Payment deposit date. | |
|
12
|
+
| **destination_account_id** | **Integer** | Bank GL account ID to deposit. | |
|
13
|
+
| **lease_id** | **Integer** | Id of the lease associated with this payment. | |
|
14
|
+
| **payment_type** | **String** | Payment type. | |
|
15
|
+
| **ref_no** | **String** | Payment reference number | |
|
16
16
|
|
17
17
|
## Example
|
18
18
|
|
data/docs/SavePortfolio.md
CHANGED
@@ -7,11 +7,14 @@
|
|
7
7
|
| **abbreviation** | **String** | Abbreviated name assigned to the portfolio. | |
|
8
8
|
| **cash_accrual** | **String** | Cash or accrual accounting basis. | [optional] |
|
9
9
|
| **closing_date** | **Date** | Date when the accounting period for the portfolio will close. | [optional] |
|
10
|
+
| **default_bank_account_id** | **Integer** | Portfolio Default Bank Account ID | [optional] |
|
11
|
+
| **default_secdep_account_id** | **Integer** | Portfolio Default Security Deposit Bank Account ID | [optional] |
|
10
12
|
| **do_not_pay_owner_draw** | **Boolean** | Indicates that the owner should not be paid owner draws. | [optional] |
|
11
13
|
| **maintenance_spending_limit** | **Float** | Monthly or yearly Maintenance Spending Limit set for the portfolio for maintenance bills created by work orders. | [optional] |
|
12
14
|
| **maintenance_spending_limit_time** | **String** | Monthly or Yearly Maintenance Spending Limit Time set for the portfolio for maintenance bills created by work orders. | [optional] |
|
13
15
|
| **name** | **String** | Name of the portfolio. | |
|
14
16
|
| **owner_ids** | **Array<Integer>** | Portfolio owner Ids | [optional] |
|
17
|
+
| **owner_statement_report_id** | **Integer** | Portfolio Owner Statement Report ID | [optional] |
|
15
18
|
| **owners** | [**Array<SaveOwner>**](SaveOwner.md) | Portfolio owners. | [optional] |
|
16
19
|
| **sticky_note** | **String** | Sticky notes. Maximum 500 characters. | [optional] |
|
17
20
|
| **target_operating_reserve** | **Float** | Minimum balance to be maintained within the portfolio at all times. | [optional] |
|
@@ -25,11 +28,14 @@ instance = Propertyware::SavePortfolio.new(
|
|
25
28
|
abbreviation: null,
|
26
29
|
cash_accrual: null,
|
27
30
|
closing_date: null,
|
31
|
+
default_bank_account_id: null,
|
32
|
+
default_secdep_account_id: null,
|
28
33
|
do_not_pay_owner_draw: false,
|
29
34
|
maintenance_spending_limit: null,
|
30
35
|
maintenance_spending_limit_time: null,
|
31
36
|
name: null,
|
32
37
|
owner_ids: null,
|
38
|
+
owner_statement_report_id: null,
|
33
39
|
owners: null,
|
34
40
|
sticky_note: null,
|
35
41
|
target_operating_reserve: null
|