propertyware 1.0.5

data/docs/SaveCredit.md

@@ -0,0 +1,26 @@
+# Propertyware::SaveCredit
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **bill_date** | **Date** | Credit Date. |  |
+| **bill_splits** | [**Array<SaveBillSplit>**](SaveBillSplit.md) | Splits list. | [optional] |
+| **comments** | **String** | Description. | [optional] |
+| **ref_no** | **String** | Reference number. | [optional] |
+| **vendor_id** | **Integer** | Related vendor ID. |  |
+
+## Example
+
+```ruby
+require 'propertyware'
+
+instance = Propertyware::SaveCredit.new(
+  bill_date: null,
+  bill_splits: null,
+  comments: null,
+  ref_no: null,
+  vendor_id: null
+)
+```
+

data/docs/SaveDiscount.md

@@ -0,0 +1,28 @@
+# Propertyware::SaveDiscount
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount** | **Float** | Amount, should be negative. |  |
+| **comments** | **String** | Comments. | [optional] |
+| **date** | **Date** | Date. |  |
+| **discount_account_id** | **Integer** | Discount GL Account ID. |  |
+| **lease_id** | **Integer** | Lease id. |  |
+| **ref_no** | **String** | Ref No. | [optional] |
+
+## Example
+
+```ruby
+require 'propertyware'
+
+instance = Propertyware::SaveDiscount.new(
+  amount: null,
+  comments: null,
+  date: null,
+  discount_account_id: null,
+  lease_id: null,
+  ref_no: null
+)
+```
+

data/docs/SaveJournalEntrySplit.md

@@ -0,0 +1,22 @@
+# Propertyware::SaveJournalEntrySplit
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **credit_amount** | **Float** | Credit Amount. |  |
+| **debit_amount** | **Float** | Debit Amount. |  |
+| **gl_account_id** | **Integer** | GL Account ID. |  |
+
+## Example
+
+```ruby
+require 'propertyware'
+
+instance = Propertyware::SaveJournalEntrySplit.new(
+  credit_amount: null,
+  debit_amount: null,
+  gl_account_id: null
+)
+```
+

data/docs/SaveLease.md

@@ -0,0 +1,50 @@
+# Propertyware::SaveLease
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **comments** | **String** | Comments. | [optional] |
+| **end_date** | **Date** | End Date. |  |
+| **leasing_fee_amount** | **Float** | Move in leasing fee amount. | [optional] |
+| **leasing_fee_date** | **Date** | Move in leasing fee post date. | [optional] |
+| **leasing_fee_ref_no** | **String** | Move in leasing fee reference number. | [optional] |
+| **move_in_date** | **Date** | Move In Date. |  |
+| **move_out_date** | **Date** | Move Out Date. | [optional] |
+| **post_first_charge** | **Boolean** | Indicates how to post first rent charge while move in. | [optional] |
+| **primary_contact_id** | **Integer** | Primary contact ID, Should be one of Tenant IDs. |  |
+| **prorate_month** | **String** | Indicates how to post first rent charge while move in. | [optional] |
+| **rent_auto_charge** | [**SaveAutoCharge**](SaveAutoCharge.md) |  | [optional] |
+| **sec_dep_amount** | **Float** | Move in security deposit amount. | [optional] |
+| **sec_dep_charge_date** | **Date** | Move in security deposit charge date. | [optional] |
+| **start_date** | **Date** | Start Date. |  |
+| **status** | **String** | Lease Status. | [optional] |
+| **tenant_ids** | **Array<Integer>** | Tenant IDs. |  |
+| **unit_id** | **Integer** | Unit/Building ID. |  |
+
+## Example
+
+```ruby
+require 'propertyware'
+
+instance = Propertyware::SaveLease.new(
+  comments: null,
+  end_date: null,
+  leasing_fee_amount: null,
+  leasing_fee_date: null,
+  leasing_fee_ref_no: null,
+  move_in_date: null,
+  move_out_date: null,
+  post_first_charge: false,
+  primary_contact_id: null,
+  prorate_month: null,
+  rent_auto_charge: null,
+  sec_dep_amount: null,
+  sec_dep_charge_date: null,
+  start_date: null,
+  status: null,
+  tenant_ids: null,
+  unit_id: null
+)
+```
+

data/docs/SaveLeaseJournalEntry.md

@@ -0,0 +1,26 @@
+# Propertyware::SaveLeaseJournalEntry
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **comments** | **String** | Comments. |  |
+| **date** | **Date** | Journal entry date. |  |
+| **journal_entry_split** | [**Array<SaveJournalEntrySplit>**](SaveJournalEntrySplit.md) | Journal Entry Splits. | [optional] |
+| **lease_id** | **Integer** | Lease id to apply journal entry. |  |
+| **ref_no** | **String** | Journal entry reference number. | [optional] |
+
+## Example
+
+```ruby
+require 'propertyware'
+
+instance = Propertyware::SaveLeaseJournalEntry.new(
+  comments: null,
+  date: null,
+  journal_entry_split: null,
+  lease_id: null,
+  ref_no: null
+)
+```
+

data/docs/SaveOwner.md

@@ -0,0 +1,36 @@
+# Propertyware::SaveOwner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **address** | [**SaveAddress**](SaveAddress.md) |  | [optional] |
+| **email** | **String** | Owner EMail. | [optional] |
+| **first_name** | **String** | Owner First Name. |  |
+| **home_phone** | **String** | Owner Home Phone. | [optional] |
+| **id** | **Integer** | Unique identifier. | [optional] |
+| **last_name** | **String** | Owner Last Name. |  |
+| **mobile_phone** | **String** | Owner Mobile Phone. | [optional] |
+| **other_phone** | **String** | Owner Other Phone. | [optional] |
+| **percentage_ownership** | **Float** | Ownership percentage. | [optional] |
+| **work_phone** | **String** | Owner Work Phone. | [optional] |
+
+## Example
+
+```ruby
+require 'propertyware'
+
+instance = Propertyware::SaveOwner.new(
+  address: null,
+  email: null,
+  first_name: null,
+  home_phone: null,
+  id: null,
+  last_name: null,
+  mobile_phone: null,
+  other_phone: null,
+  percentage_ownership: null,
+  work_phone: null
+)
+```
+

data/docs/SaveOwnerContribution.md

@@ -0,0 +1,34 @@
+# Propertyware::SaveOwnerContribution
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount** | **Float** | Amount. |  |
+| **comments** | **String** | Comments. | [optional] |
+| **contact_id** | **Integer** | Owner Contact ID. |  |
+| **date** | **Date** | Post Date. |  |
+| **destination_account_id** | **Integer** | Bank Account ID to Deposit. |  |
+| **gl_account_id** | **Integer** | GL Account ID. |  |
+| **payment_type** | **String** | Payment Type. |  |
+| **portfolio_id** | **Integer** | Portfolio id to apply payment. |  |
+| **ref_no** | **String** | Charge Ref No. |  |
+
+## Example
+
+```ruby
+require 'propertyware'
+
+instance = Propertyware::SaveOwnerContribution.new(
+  amount: null,
+  comments: null,
+  contact_id: null,
+  date: null,
+  destination_account_id: null,
+  gl_account_id: null,
+  payment_type: null,
+  portfolio_id: null,
+  ref_no: null
+)
+```
+

data/docs/SaveOwnerDraw.md

@@ -0,0 +1,34 @@
+# Propertyware::SaveOwnerDraw
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount** | **Float** | Amount. |  |
+| **comments** | **String** | Comments. | [optional] |
+| **contact_id** | **Integer** | Owner Contact ID. |  |
+| **date** | **Date** | Post Date. |  |
+| **destination_account_id** | **Integer** | Bank Account ID to Pay From. |  |
+| **gl_account_id** | **Integer** | GL Account id. |  |
+| **portfolio_id** | **Integer** | Portfolio ID. |  |
+| **ref_no** | **String** | Check no required when payment method is Hand written check . | [optional] |
+| **to_be_printed** | **Boolean** | Indicates if Check is to be printed. |  |
+
+## Example
+
+```ruby
+require 'propertyware'
+
+instance = Propertyware::SaveOwnerDraw.new(
+  amount: null,
+  comments: null,
+  contact_id: null,
+  date: null,
+  destination_account_id: null,
+  gl_account_id: null,
+  portfolio_id: null,
+  ref_no: null,
+  to_be_printed: false
+)
+```
+

data/docs/SavePayment.md

@@ -0,0 +1,34 @@
+# Propertyware::SavePayment
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount** | **Float** | Amount. |  |
+| **comments** | **String** | Comments. | [optional] |
+| **contact_id** | **Integer** | Payer contact ID. |  |
+| **date** | **Date** | Post Date. |  |
+| **deposit_date** | **Date** | Payment Deposit Date. |  |
+| **destination_account_id** | **Integer** | Bank Account ID to Deposit. |  |
+| **lease_id** | **Integer** | Lease ID to apply payment. |  |
+| **payment_type** | **String** | Payment Type. |  |
+| **ref_no** | **String** | Payment Ref No. |  |
+
+## Example
+
+```ruby
+require 'propertyware'
+
+instance = Propertyware::SavePayment.new(
+  amount: null,
+  comments: null,
+  contact_id: null,
+  date: null,
+  deposit_date: null,
+  destination_account_id: null,
+  lease_id: null,
+  payment_type: null,
+  ref_no: null
+)
+```
+

data/docs/SavePortfolio.md

@@ -0,0 +1,38 @@
+# Propertyware::SavePortfolio
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **abbreviation** | **String** | Abbreviated name assigned to the portfolio. |  |
+| **cash_accrual** | **String** | Cash or accrual accounting basis. | [optional] |
+| **closing_date** | **Date** | Date when the accounting period for the portfolio will close. | [optional] |
+| **do_not_pay_owner_draw** | **Boolean** | Indicates that the owner should not be paid owner draws. | [optional] |
+| **maintenance_spending_limit** | **Float** | Monthly or yearly Maintenance Spending Limit set for the portfolio for maintenance bills created by work orders. | [optional] |
+| **maintenance_spending_limit_time** | **String** | Monthly or Yearly Maintenance Spending Limit Time set for the portfolio for maintenance bills created by work orders. | [optional] |
+| **name** | **String** | Name of the portfolio. |  |
+| **owner_ids** | **Array<Integer>** | Portfolio owner Ids | [optional] |
+| **owners** | [**Array<SaveOwner>**](SaveOwner.md) | Portfolio owners. | [optional] |
+| **sticky_note** | **String** | Sticky notes. Maximum 500 characters. | [optional] |
+| **target_operating_reserve** | **Float** | Minimum balance to be maintained within the portfolio at all times. | [optional] |
+
+## Example
+
+```ruby
+require 'propertyware'
+
+instance = Propertyware::SavePortfolio.new(
+  abbreviation: null,
+  cash_accrual: null,
+  closing_date: null,
+  do_not_pay_owner_draw: false,
+  maintenance_spending_limit: null,
+  maintenance_spending_limit_time: null,
+  name: null,
+  owner_ids: null,
+  owners: null,
+  sticky_note: null,
+  target_operating_reserve: null
+)
+```
+

data/docs/SaveProspect.md

@@ -0,0 +1,76 @@
+# Propertyware::SaveProspect
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **building_id** | **Integer** | Unique identifier of the building associated with the prospect. | [optional] |
+| **comments** | **String** | This is a description of the Prospect. | [optional] |
+| **contacts** | [**Array<SaveProspectContact>**](SaveProspectContact.md) | Prospect contacts. | [optional] |
+| **current_home_type** | **String** | Prospect Current Home Type. | [optional] |
+| **current_rent_mortgage** | **Float** | Prospect Current Home Mortgage. | [optional] |
+| **has_pets** | **Boolean** | Prospect Has Pets. | [optional] |
+| **move_in_date** | **Date** | Prospect Move In Date. | [optional] |
+| **neighborhood_desired** | **String** | Prospect Neighborhood Desired. | [optional] |
+| **number_bathrooms** | **Float** | Prospect Number Of Bathrooms. | [optional] |
+| **number_bedrooms** | **Integer** | Prospect Number Of Bedrooms. | [optional] |
+| **number_of_pets** | **Integer** | Prospect Number Of Pets. | [optional] |
+| **pet_type** | **String** | Prospect Pet Type. | [optional] |
+| **pet_weights** | **String** | Prospect Pet Weights. | [optional] |
+| **preferred_contact_method** | **String** | Prospect Preferred Contact Method. | [optional] |
+| **property_address** | **String** | Property Address. | [optional] |
+| **property_address2** | **String** | Property Address Continued. | [optional] |
+| **property_city** | **String** | Property City. | [optional] |
+| **property_country** | **String** | Property Country. | [optional] |
+| **property_number_bathrooms** | **Float** | Property Number Of Bath rooms. | [optional] |
+| **property_number_bedrooms** | **Integer** | Property Number Of Bedrooms. | [optional] |
+| **property_state** | **String** | Property State. | [optional] |
+| **property_zip** | **String** | Property Zip. | [optional] |
+| **reason_for_moving** | **String** | Prospect Reason For Moving. | [optional] |
+| **rent_max** | **Float** | Prospect Rent Maximum. | [optional] |
+| **rent_min** | **Float** | Prospect Rent Minimum. | [optional] |
+| **source** | **String** | Prospect Source. | [optional] |
+| **status** | **String** | Prospect Status. | [optional] |
+| **time_at_current_residence** | **String** | Prospect Time At Current Residence. | [optional] |
+| **type** | **String** | Prospect Type. | [optional] |
+| **type_of_inquiry** | **String** | Prospect Type Of Inquiry. | [optional] |
+
+## Example
+
+```ruby
+require 'propertyware'
+
+instance = Propertyware::SaveProspect.new(
+  building_id: null,
+  comments: null,
+  contacts: null,
+  current_home_type: null,
+  current_rent_mortgage: null,
+  has_pets: false,
+  move_in_date: null,
+  neighborhood_desired: null,
+  number_bathrooms: null,
+  number_bedrooms: null,
+  number_of_pets: null,
+  pet_type: null,
+  pet_weights: null,
+  preferred_contact_method: null,
+  property_address: null,
+  property_address2: null,
+  property_city: null,
+  property_country: null,
+  property_number_bathrooms: null,
+  property_number_bedrooms: null,
+  property_state: null,
+  property_zip: null,
+  reason_for_moving: null,
+  rent_max: null,
+  rent_min: null,
+  source: null,
+  status: null,
+  time_at_current_residence: null,
+  type: null,
+  type_of_inquiry: null
+)
+```
+

data/docs/SaveProspectContact.md

@@ -0,0 +1,36 @@
+# Propertyware::SaveProspectContact
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **address** | [**SaveAddress**](SaveAddress.md) |  | [optional] |
+| **email** | **String** |  EMail. | [optional] |
+| **first_name** | **String** | First Name. |  |
+| **home_phone** | **String** |  Home Phone. | [optional] |
+| **id** | **Integer** | Unique identifier. | [optional] |
+| **last_name** | **String** |  Last Name. |  |
+| **mobile_phone** | **String** |  Mobile Phone. | [optional] |
+| **other_phone** | **String** |  Other Phone. | [optional] |
+| **percentageship** | **Float** | ship percentage. | [optional] |
+| **work_phone** | **String** |  Work Phone. | [optional] |
+
+## Example
+
+```ruby
+require 'propertyware'
+
+instance = Propertyware::SaveProspectContact.new(
+  address: null,
+  email: null,
+  first_name: null,
+  home_phone: null,
+  id: null,
+  last_name: null,
+  mobile_phone: null,
+  other_phone: null,
+  percentageship: null,
+  work_phone: null
+)
+```
+

data/docs/SaveRefund.md

@@ -0,0 +1,34 @@
+# Propertyware::SaveRefund
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount** | **Float** | Amount. |  |
+| **comments** | **String** | Comments. | [optional] |
+| **date** | **Date** | Post Date. |  |
+| **destination_account_id** | **Integer** | Bank GL Account to pay from. |  |
+| **gl_account_id** | **Integer** | Refund GL Account. |  |
+| **lease_id** | **Integer** | Lease id to apply payment. |  |
+| **ref_no** | **String** | Payment Ref No. | [optional] |
+| **to_be_printed** | **Boolean** | Bank GL Account to pay from. |  |
+| **to_primary_tenant** | **Boolean** | Bank GL Account to pay from. |  |
+
+## Example
+
+```ruby
+require 'propertyware'
+
+instance = Propertyware::SaveRefund.new(
+  amount: null,
+  comments: null,
+  date: null,
+  destination_account_id: null,
+  gl_account_id: null,
+  lease_id: null,
+  ref_no: null,
+  to_be_printed: false,
+  to_primary_tenant: false
+)
+```
+

data/docs/SaveUnit.md

@@ -0,0 +1,60 @@
+# Propertyware::SaveUnit
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **abbreviation** | **String** | Unit abbreviation. |  |
+| **address** | [**SaveAddress**](SaveAddress.md) |  | [optional] |
+| **available_date** | **Date** | Unit Available date to lease. | [optional] |
+| **building_id** | **Integer** | Id of the building associated with this unit. |  |
+| **category** | **String** | Unit Category. |  |
+| **county** | **String** | Unit region of a state. | [optional] |
+| **description** | **String** | Marketing Description. | [optional] |
+| **floor_number** | **Integer** | Floor number. | [optional] |
+| **name** | **String** | Name of the unit. |  |
+| **neighborhood** | **String** | Neighborhood. | [optional] |
+| **number_bathrooms** | **Float** | Number of bathrooms in the unit. | [optional] |
+| **number_bedrooms** | **Integer** | Number of bedrooms in the unit. | [optional] |
+| **other_unit_country** | **String** | Other Unit country is required only if unit outside of USA or Canada. | [optional] |
+| **portfolio_id** | **Integer** | Id of the portfolio associated with this unit. |  |
+| **ready** | **Boolean** | Indicates if property is ready to be leased. | [optional] |
+| **reason_for_property_lost** | **String** | Reason for property lost. | [optional] |
+| **residential** | **Boolean** | Is Unit is Residential or Commercial. | [optional] |
+| **search_tag** | **String** | SearchTag. | [optional] |
+| **target_deposit** | **String** | Target Deposit. | [optional] |
+| **target_rent** | **Float** | Market rent for the unit. | [optional] |
+| **total_area** | **Float** | Unit Area. | [optional] |
+| **type** | **String** | Unit Type. |  |
+
+## Example
+
+```ruby
+require 'propertyware'
+
+instance = Propertyware::SaveUnit.new(
+  abbreviation: null,
+  address: null,
+  available_date: null,
+  building_id: null,
+  category: null,
+  county: null,
+  description: null,
+  floor_number: null,
+  name: null,
+  neighborhood: null,
+  number_bathrooms: null,
+  number_bedrooms: null,
+  other_unit_country: null,
+  portfolio_id: null,
+  ready: false,
+  reason_for_property_lost: null,
+  residential: false,
+  search_tag: null,
+  target_deposit: null,
+  target_rent: null,
+  total_area: null,
+  type: null
+)
+```
+

data/docs/SaveVendor.md

@@ -0,0 +1,46 @@
+# Propertyware::SaveVendor
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_number** | **String** | Account Number | [optional] |
+| **address** | **String** | Address | [optional] |
+| **address2** | **String** | Address2 | [optional] |
+| **city** | **String** | City | [optional] |
+| **company_name** | **String** | Vendor Company Name |  |
+| **country** | **String** | Country | [optional] |
+| **email** | **String** | EMail | [optional] |
+| **fax** | **String** | Fax | [optional] |
+| **name** | **String** | Vendor Name |  |
+| **name_on_check** | **String** | Vendor Name On Check |  |
+| **phone** | **String** | Phone | [optional] |
+| **state** | **String** | State | [optional] |
+| **tax_id** | **String** | Tax ID | [optional] |
+| **vendor_type** | **String** | Vendor Type |  |
+| **zip** | **String** | Zip | [optional] |
+
+## Example
+
+```ruby
+require 'propertyware'
+
+instance = Propertyware::SaveVendor.new(
+  account_number: null,
+  address: null,
+  address2: null,
+  city: null,
+  company_name: null,
+  country: null,
+  email: null,
+  fax: null,
+  name: null,
+  name_on_check: null,
+  phone: null,
+  state: null,
+  tax_id: null,
+  vendor_type: null,
+  zip: null
+)
+```
+

data/docs/SaveWorkOrder.md

@@ -0,0 +1,36 @@
+# Propertyware::SaveWorkOrder
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **building_id** | **Integer** | Id of the building associated with this work order. | [optional] |
+| **category** | **String** | Category of the work order. | [optional] |
+| **description** | **String** | Description of the work order. | [optional] |
+| **hour_estimate** | **Float** | Estimated number of hours to complete the work order. | [optional] |
+| **priority** | **String** | Priority of the work order. | [optional] |
+| **requested_by** | **Integer** | Id of the person that reported the problem, typically the tenant or owner associated with the buildings or units. | [optional] |
+| **scheduled_end_date** | **Date** | Date on which the work is scheduled to be completed. | [optional] |
+| **start_date** | **Date** | Date on which the work was started. | [optional] |
+| **type** | **String** | This classifies the work order into one of the following types: General, Service Request, Turnover, Inspection, Estimate etc. | [optional] |
+| **unit_ids** | **Array<Integer>** | List of unit Ids that are attached to the building. | [optional] |
+
+## Example
+
+```ruby
+require 'propertyware'
+
+instance = Propertyware::SaveWorkOrder.new(
+  building_id: null,
+  category: null,
+  description: null,
+  hour_estimate: null,
+  priority: null,
+  requested_by: null,
+  scheduled_end_date: null,
+  start_date: null,
+  type: null,
+  unit_ids: null
+)
+```
+

data/docs/SaveWorkOrderTask.md

@@ -0,0 +1,30 @@
+# Propertyware::SaveWorkOrderTask
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **completed** | **Boolean** | Indicates if the task is completed. | [optional] |
+| **delegates** | **String** | Comma separated list of user ids to delegate the task to. | [optional] |
+| **description** | **String** | Task description. |  |
+| **due_date** | **Date** | Task due date. | [optional] |
+| **is_private** | **Boolean** | Indicates if the task is private. | [optional] |
+| **starred** | **Boolean** | Indicates if the task is starred. | [optional] |
+| **tags** | **String** | Comma separated task tags. | [optional] |
+
+## Example
+
+```ruby
+require 'propertyware'
+
+instance = Propertyware::SaveWorkOrderTask.new(
+  completed: false,
+  delegates: null,
+  description: null,
+  due_date: null,
+  is_private: false,
+  starred: false,
+  tags: null
+)
+```
+