propertyware 1.0.5

data/docs/ManagementFee.md

@@ -0,0 +1,30 @@
+# Propertyware::ManagementFee
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_code** | **String** | Management fee account code. | [optional] |
+| **account_number** | **String** | Management fee account number. | [optional] |
+| **id** | **Integer** | Unique identifier. | [optional] |
+| **manager** | **String** | Property manager name. | [optional] |
+| **managers_commission_percentage** | **Float** | Property manager commission percentage. | [optional] |
+| **pass_through** | **Boolean** | Indicates if the commission account is of the passthrough type. | [optional] |
+| **percentage** | **Float** | Management fee percentage. | [optional] |
+
+## Example
+
+```ruby
+require 'propertyware'
+
+instance = Propertyware::ManagementFee.new(
+  account_code: null,
+  account_number: null,
+  id: null,
+  manager: null,
+  managers_commission_percentage: null,
+  pass_through: false,
+  percentage: null
+)
+```
+

data/docs/ManagementSettings.md

@@ -0,0 +1,26 @@
+# Propertyware::ManagementSettings
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **management_contract_end_date** | **Date** | End date of the property contract. | [optional] |
+| **management_contract_start_date** | **Date** | Start date of the property contract. | [optional] |
+| **management_fee_type** | **String** | Indicates the type of management fee. | [optional] |
+| **management_fees** | [**Array<ManagementFee>**](ManagementFee.md) | List of property management fee rules. | [optional] |
+| **management_flat_fee** | **Float** | Flat management fee amount. | [optional] |
+
+## Example
+
+```ruby
+require 'propertyware'
+
+instance = Propertyware::ManagementSettings.new(
+  management_contract_end_date: null,
+  management_contract_start_date: null,
+  management_fee_type: null,
+  management_fees: null,
+  management_flat_fee: null
+)
+```
+

data/docs/Marketing.md

@@ -0,0 +1,62 @@
+# Propertyware::Marketing
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **available_date** | **Date** | Available date to lease for a unit/building. | [optional] |
+| **comments** | **String** | Marketing description. | [optional] |
+| **featured** | **Boolean** | Indicates if property is featured for rent or sale. | [optional] |
+| **featured_for_rent** | **Boolean** | Indicates if the unit/building is featured for rent. | [optional] |
+| **featured_for_sale** | **Boolean** | Indicates if unit/building is featured for sale. | [optional] |
+| **for_sale** | **Boolean** | Indicates if this building/unit is for sale. | [optional] |
+| **latitude** | **Float** | Latitude for geolocation of this building/unit. | [optional] |
+| **lease_terms** | **Integer** | Lease terms of a unit/building. | [optional] |
+| **lease_terms_units** | **String** | Unit/building lease terms units. | [optional] |
+| **longitude** | **Float** | Longitude for geolocation of this building/unit. | [optional] |
+| **marketing_name** | **String** | Marketing name. | [optional] |
+| **mls_lease_number** | **String** | MLS lease number of this building/unit. | [optional] |
+| **mls_number** | **String** | MLS number of this building/unit. | [optional] |
+| **other_tenant_charges** | **String** | Other tenant charges. | [optional] |
+| **parcel_number** | **String** | Parcel number of this building/unit. | [optional] |
+| **pets_allowed** | **Boolean** | Indicates if pets are allowed in a unit/building. | [optional] |
+| **posting_title** | **String** | Posting title name for marketing this building/unit. | [optional] |
+| **published_for_sale** | **Boolean** | Indicates if the unit/building is published for sale. | [optional] |
+| **sale_price** | **Float** | Sale price of this building/unit. | [optional] |
+| **sale_terms** | **String** | Sale terms of this building/unit. | [optional] |
+| **short_description** | **String** | Marketing short description. | [optional] |
+| **smoking_allowed** | **Boolean** | Indicates if smoking is allowed in this unit/building. | [optional] |
+| **specials** | **String** | Specials of this building/unit. | [optional] |
+
+## Example
+
+```ruby
+require 'propertyware'
+
+instance = Propertyware::Marketing.new(
+  available_date: null,
+  comments: null,
+  featured: false,
+  featured_for_rent: false,
+  featured_for_sale: false,
+  for_sale: false,
+  latitude: null,
+  lease_terms: null,
+  lease_terms_units: null,
+  longitude: null,
+  marketing_name: null,
+  mls_lease_number: null,
+  mls_number: null,
+  other_tenant_charges: null,
+  parcel_number: null,
+  pets_allowed: false,
+  posting_title: null,
+  published_for_sale: false,
+  sale_price: null,
+  sale_terms: null,
+  short_description: null,
+  smoking_allowed: false,
+  specials: null
+)
+```
+

data/docs/NonCurrentAsset.md

@@ -0,0 +1,26 @@
+# Propertyware::NonCurrentAsset
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **discount_account** | **Boolean** | Indicates if account is a discount account. | [optional] |
+| **escrow_account** | **Boolean** | Indicates if account is a escrow account. | [optional] |
+| **exclude_from1099** | **Boolean** | Indicates if account is excluded from Form1099. | [optional] |
+| **exclude_from_pay_in_full** | **Boolean** | Indicates if account is excluded from paying in full. | [optional] |
+| **exclude_late_fee** | **Boolean** | Indicates if excluding from late fees. | [optional] |
+
+## Example
+
+```ruby
+require 'propertyware'
+
+instance = Propertyware::NonCurrentAsset.new(
+  discount_account: false,
+  escrow_account: false,
+  exclude_from1099: false,
+  exclude_from_pay_in_full: false,
+  exclude_late_fee: false
+)
+```
+

data/docs/NonCurrentLiability.md

@@ -0,0 +1,30 @@
+# Propertyware::NonCurrentLiability
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **discount_account** | **Boolean** | Indicates if account is a discount account. | [optional] |
+| **escrow_account** | **Boolean** | Indicates if account is a escrow account. | [optional] |
+| **exclude_from1099** | **Boolean** | Indicates if account is excluded from Form1099. | [optional] |
+| **exclude_from_pay_in_full** | **Boolean** | Indicates if account is excluded from paying in full. | [optional] |
+| **exclude_late_fee** | **Boolean** | Indicates if excluding from late fees. | [optional] |
+| **rent_account** | **Boolean** | Indicates if account is a rent account. | [optional] |
+| **tax_account** | **Boolean** | Indicates if account is a tax account. | [optional] |
+
+## Example
+
+```ruby
+require 'propertyware'
+
+instance = Propertyware::NonCurrentLiability.new(
+  discount_account: false,
+  escrow_account: false,
+  exclude_from1099: false,
+  exclude_from_pay_in_full: false,
+  exclude_late_fee: false,
+  rent_account: false,
+  tax_account: false
+)
+```
+

data/docs/NonOperatingExpense.md

@@ -0,0 +1,32 @@
+# Propertyware::NonOperatingExpense
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cam_recovery_account** | **Boolean** | Indicates if account is a CAM recovery account. | [optional] |
+| **discount_account** | **Boolean** | Indicates if account is a discount account. | [optional] |
+| **escrow_account** | **Boolean** | Indicates if account is a escrow account. | [optional] |
+| **exclude_from1099** | **Boolean** | Indicates if account is excluded from Form1099. | [optional] |
+| **exclude_from_pay_in_full** | **Boolean** | Indicates if account is excluded from paying in full. | [optional] |
+| **exclude_late_fee** | **Boolean** | Indicates if excluding from late fees. | [optional] |
+| **rent_account** | **Boolean** | Indicates if account is a rent account. | [optional] |
+| **tax_account** | **Boolean** | Indicates if account is a tax account. | [optional] |
+
+## Example
+
+```ruby
+require 'propertyware'
+
+instance = Propertyware::NonOperatingExpense.new(
+  cam_recovery_account: false,
+  discount_account: false,
+  escrow_account: false,
+  exclude_from1099: false,
+  exclude_from_pay_in_full: false,
+  exclude_late_fee: false,
+  rent_account: false,
+  tax_account: false
+)
+```
+

data/docs/NonOperatingInome.md

@@ -0,0 +1,32 @@
+# Propertyware::NonOperatingInome
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cam_recovery_account** | **Boolean** | Indicates if account is a CAM recovery account. | [optional] |
+| **discount_account** | **Boolean** | Indicates if account is a discount account. | [optional] |
+| **escrow_account** | **Boolean** | Indicates if account is a escrow account. | [optional] |
+| **exclude_from1099** | **Boolean** | Indicates if account is excluded from Form1099. | [optional] |
+| **exclude_from_pay_in_full** | **Boolean** | Indicates if account is excluded from paying in full. | [optional] |
+| **exclude_late_fee** | **Boolean** | Indicates if excluding from late fees. | [optional] |
+| **rent_account** | **Boolean** | Indicates if account is a rent account. | [optional] |
+| **tax_account** | **Boolean** | Indicates if account is a tax account. | [optional] |
+
+## Example
+
+```ruby
+require 'propertyware'
+
+instance = Propertyware::NonOperatingInome.new(
+  cam_recovery_account: false,
+  discount_account: false,
+  escrow_account: false,
+  exclude_from1099: false,
+  exclude_from_pay_in_full: false,
+  exclude_late_fee: false,
+  rent_account: false,
+  tax_account: false
+)
+```
+

data/docs/Note.md

@@ -0,0 +1,28 @@
+# Propertyware::Note
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **body** | **String** | Content of the note. | [optional] |
+| **date** | **Date** | Date the note was created. | [optional] |
+| **id** | **Integer** | Unique identifier. | [optional] |
+| **private** | **Boolean** |  | [optional] |
+| **subject** | **String** | Subject. | [optional] |
+| **type** | **String** | Note type. | [optional] |
+
+## Example
+
+```ruby
+require 'propertyware'
+
+instance = Propertyware::Note.new(
+  body: null,
+  date: null,
+  id: null,
+  private: null,
+  subject: null,
+  type: null
+)
+```
+

data/docs/Owner.md

@@ -0,0 +1,38 @@
+# Propertyware::Owner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **address** | [**Address**](Address.md) |  | [optional] |
+| **email** | **String** | Email address. | [optional] |
+| **first_name** | **String** | First name. | [optional] |
+| **home_phone** | **String** | Home phone. | [optional] |
+| **id** | **Integer** | Unique identifier. | [optional] |
+| **last_name** | **String** | Last name. | [optional] |
+| **mobile_phone** | **String** | Mobile phone. | [optional] |
+| **name** | **String** | Full name. | [optional] |
+| **other_phone** | **String** | Other phone. | [optional] |
+| **percentage_ownership** | **Float** | Percentage ownership. | [optional] |
+| **work_phone** | **String** | Work phone. | [optional] |
+
+## Example
+
+```ruby
+require 'propertyware'
+
+instance = Propertyware::Owner.new(
+  address: null,
+  email: null,
+  first_name: null,
+  home_phone: null,
+  id: null,
+  last_name: null,
+  mobile_phone: null,
+  name: null,
+  other_phone: null,
+  percentage_ownership: null,
+  work_phone: null
+)
+```
+

data/docs/OwnerContribution.md

@@ -0,0 +1,44 @@
+# Propertyware::OwnerContribution
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount** | **Float** | Amount. |  |
+| **comments** | **String** | Comments. | [optional] |
+| **contact_id** | **Integer** | Id of the contact associated with this owner contribution. |  |
+| **created_by** | **String** | User who created the record. | [optional] |
+| **created_date_time** | **Time** | Date and time the record was created. (Timezone: UTC) | [optional] |
+| **date** | **Date** | Post date. |  |
+| **destination_account_id** | **Integer** | Id of the bank account where the payment will be deposited. |  |
+| **gl_account_id** | **Integer** | Id of the general ledger account associated with this owner contribution. |  |
+| **id** | **Integer** | Unique identifier. | [optional] |
+| **last_modified_by** | **String** | User who last modified the record. | [optional] |
+| **last_modified_date_time** | **Time** | Date and time the record was last modified. (Timezone: UTC) | [optional] |
+| **payment_type** | **String** | Payment type. |  |
+| **portfolio_id** | **Integer** | Id of the portfolio to apply the payment to. |  |
+| **ref_no** | **String** | Reference number. | [optional] |
+
+## Example
+
+```ruby
+require 'propertyware'
+
+instance = Propertyware::OwnerContribution.new(
+  amount: null,
+  comments: null,
+  contact_id: null,
+  created_by: null,
+  created_date_time: null,
+  date: null,
+  destination_account_id: null,
+  gl_account_id: null,
+  id: null,
+  last_modified_by: null,
+  last_modified_date_time: null,
+  payment_type: null,
+  portfolio_id: null,
+  ref_no: null
+)
+```
+

data/docs/OwnerDraw.md

@@ -0,0 +1,44 @@
+# Propertyware::OwnerDraw
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount** | **Float** | Amount. |  |
+| **comments** | **String** | Comments. | [optional] |
+| **contact_id** | **Integer** | Id of the contact associated with this owner draw. | [optional] |
+| **created_by** | **String** | User who created the record. | [optional] |
+| **created_date_time** | **Time** | Date and time the record was created. (Timezone: UTC) | [optional] |
+| **date** | **Date** | Post date. |  |
+| **destination_account_id** | **Integer** | Id of the bank account where the payment will be made from. | [optional] |
+| **gl_account_id** | **Integer** | Id of the general ledger account associated with this owner draw. |  |
+| **id** | **Integer** | Unique identifier. | [optional] |
+| **last_modified_by** | **String** | User who last modified the record. | [optional] |
+| **last_modified_date_time** | **Time** | Date and time the record was last modified. (Timezone: UTC) | [optional] |
+| **payment_type** | **String** | Payment type. | [optional] |
+| **portfolio_id** | **Integer** | Id of the portfolio associated with this owner draw. | [optional] |
+| **ref_no** | **String** | Reference number. | [optional] |
+
+## Example
+
+```ruby
+require 'propertyware'
+
+instance = Propertyware::OwnerDraw.new(
+  amount: null,
+  comments: null,
+  contact_id: null,
+  created_by: null,
+  created_date_time: null,
+  date: null,
+  destination_account_id: null,
+  gl_account_id: null,
+  id: null,
+  last_modified_by: null,
+  last_modified_date_time: null,
+  payment_type: null,
+  portfolio_id: null,
+  ref_no: null
+)
+```
+

data/docs/Payment.md

@@ -0,0 +1,50 @@
+# Propertyware::Payment
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount** | **Float** | Amount. |  |
+| **comments** | **String** | Comments. | [optional] |
+| **contact_id** | **Integer** | Id of the contact associated with this payment. | [optional] |
+| **created_by** | **String** | User who created the record. | [optional] |
+| **created_date_time** | **Time** | Date and time the record was created. (Timezone: UTC) | [optional] |
+| **date** | **Date** | Post date. |  |
+| **deposit_date** | **Date** | Date the payment was deposited. | [optional] |
+| **destination_account_id** | **Integer** | Id of the bank account where the payment was deposited. | [optional] |
+| **id** | **Integer** | Unique identifier. | [optional] |
+| **is_deposited** | **Boolean** | Indicates if the payment has been deposited. | [optional] |
+| **last_modified_by** | **String** | User who last modified the record. | [optional] |
+| **last_modified_date_time** | **Time** | Date and time the record was last modified. (Timezone: UTC) | [optional] |
+| **lease_id** | **Integer** | Id of the lease associated with this payment. | [optional] |
+| **payment_type** | **String** | Payment type. | [optional] |
+| **portfolio_id** | **Integer** | Id of the portfolio associated with this transaction. | [optional] |
+| **ref_no** | **String** | Reference number. | [optional] |
+| **status** | **String** | Lease status. | [optional] |
+
+## Example
+
+```ruby
+require 'propertyware'
+
+instance = Propertyware::Payment.new(
+  amount: null,
+  comments: null,
+  contact_id: null,
+  created_by: null,
+  created_date_time: null,
+  date: null,
+  deposit_date: null,
+  destination_account_id: null,
+  id: null,
+  is_deposited: false,
+  last_modified_by: null,
+  last_modified_date_time: null,
+  lease_id: null,
+  payment_type: null,
+  portfolio_id: null,
+  ref_no: null,
+  status: null
+)
+```
+

data/docs/PaymentCharge.md

@@ -0,0 +1,36 @@
+# Propertyware::PaymentCharge
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_id** | **Integer** | Id of the bank account where the payment was deposited. | [optional] |
+| **amount** | **Float** | Amount. |  |
+| **comments** | **String** | Comments. | [optional] |
+| **date** | **Date** | Payment applied date. |  |
+| **payee_payer** | **String** | Payer name. | [optional] |
+| **payment_type** | **String** | Payment type. Electronic payments are only for book keeping. | [optional] |
+| **receipt_number** | **Integer** | Payment receipt number. | [optional] |
+| **ref_no** | **String** | Payment reference number. | [optional] |
+| **settled_date** | **Date** | Payment settlement date. |  |
+| **status** | **String** | Charge payment status. | [optional] |
+
+## Example
+
+```ruby
+require 'propertyware'
+
+instance = Propertyware::PaymentCharge.new(
+  account_id: null,
+  amount: null,
+  comments: null,
+  date: null,
+  payee_payer: null,
+  payment_type: null,
+  receipt_number: null,
+  ref_no: null,
+  settled_date: null,
+  status: null
+)
+```
+

data/docs/Portfolio.md

@@ -0,0 +1,60 @@
+# Propertyware::Portfolio
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **abbreviation** | **String** | Abbreviated name assigned to the portfolio. | [optional] |
+| **active** | **Boolean** | Indicates if portfolio is active or inactive. | [optional] |
+| **cash_accrual** | **String** | Cash or accrual accounting basis. | [optional] |
+| **closing_date** | **Date** | Date when the accounting period for the portfolio will close. | [optional] |
+| **created_by** | **String** | User who created the record. | [optional] |
+| **created_date_time** | **Time** | Date and time the record was created. (Timezone: UTC) | [optional] |
+| **custom_fields** | [**Array<CustomField>**](CustomField.md) | Custom fields. | [optional] |
+| **default_bank_account_id** | **Integer** | Id of the portfolio's default bank account. | [optional] |
+| **default_bank_account_number_and_description** | **String** | Portfolio default bank account number and description | [optional] |
+| **default_security_deposit_bank_account_id** | **Integer** | Portfolio default security deposit bank account ID | [optional] |
+| **default_security_deposit_bank_account_number_and_description** | **String** | Portfolio default security deposit bank account number and description | [optional] |
+| **do_not_pay_owner_draw** | **Boolean** | Indicates if the owner should not be paid owner draws. | [optional] |
+| **id** | **Integer** | Unique identifier. | [optional] |
+| **last_modified_by** | **String** | User who last modified the record. | [optional] |
+| **last_modified_date_time** | **Time** | Date and time the record was last modified. (Timezone: UTC) | [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] |
+| **modified_by** | **String** | Id of the user who last modified the portfolio information. | [optional] |
+| **name** | **String** | Portfolio name. | [optional] |
+| **owners** | [**Array<Owner>**](Owner.md) | List of portfolio owners. | [optional] |
+| **sticky_note** | **String** | Sticky notes. | [optional] |
+| **target_operating_reserve** | **Float** | Minimum balance to be maintained within the portfolio at all times. | [optional] |
+
+## Example
+
+```ruby
+require 'propertyware'
+
+instance = Propertyware::Portfolio.new(
+  abbreviation: null,
+  active: false,
+  cash_accrual: null,
+  closing_date: null,
+  created_by: null,
+  created_date_time: null,
+  custom_fields: null,
+  default_bank_account_id: null,
+  default_bank_account_number_and_description: null,
+  default_security_deposit_bank_account_id: null,
+  default_security_deposit_bank_account_number_and_description: null,
+  do_not_pay_owner_draw: false,
+  id: null,
+  last_modified_by: null,
+  last_modified_date_time: null,
+  maintenance_spending_limit: null,
+  maintenance_spending_limit_time: null,
+  modified_by: null,
+  name: null,
+  owners: null,
+  sticky_note: null,
+  target_operating_reserve: null
+)
+```
+