propertyware 1.0.5

data/docs/RESTAPIBulkErrorResponse.md

@@ -0,0 +1,22 @@
+# Propertyware::RESTAPIBulkErrorResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | [**Array<RESTAPIError>**](RESTAPIError.md) |  | [optional] |
+| **index** | **Integer** |  | [optional] |
+| **success** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'propertyware'
+
+instance = Propertyware::RESTAPIBulkErrorResponse.new(
+  error: null,
+  index: null,
+  success: null
+)
+```
+

data/docs/RESTAPIBulkSuccessResponse.md

@@ -0,0 +1,18 @@
+# Propertyware::RESTAPIBulkSuccessResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'propertyware'
+
+instance = Propertyware::RESTAPIBulkSuccessResponse.new(
+  id: null
+)
+```
+

data/docs/RESTAPIError.md

@@ -0,0 +1,20 @@
+# Propertyware::RESTAPIError
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **key** | **String** |  | [optional] |
+| **message** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'propertyware'
+
+instance = Propertyware::RESTAPIError.new(
+  key: null,
+  message: null
+)
+```
+

data/docs/Refund.md

@@ -0,0 +1,44 @@
+# Propertyware::Refund
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount** | **Float** | Amount. |  |
+| **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 to send the refund to. |  |
+| **gl_account_id** | **Integer** | Id of the general ledger associated with the refund. |  |
+| **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] |
+| **lease_id** | **Integer** | Id of the lease associated with the refund. |  |
+| **payee_payer** | **String** | Name of the payee. |  |
+| **portfolio_id** | **Integer** | Id of the portfolio associated with the refund. | [optional] |
+| **ref_no** | **String** | Reference number. | [optional] |
+| **to_be_printed** | **Boolean** | Indicates if the check is to be printed. |  |
+
+## Example
+
+```ruby
+require 'propertyware'
+
+instance = Propertyware::Refund.new(
+  amount: 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,
+  lease_id: null,
+  payee_payer: null,
+  portfolio_id: null,
+  ref_no: null,
+  to_be_printed: false
+)
+```
+

data/docs/ResponseEntity.md

@@ -0,0 +1,20 @@
+# Propertyware::ResponseEntity
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **body** | **Object** |  | [optional] |
+| **status_code** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'propertyware'
+
+instance = Propertyware::ResponseEntity.new(
+  body: null,
+  status_code: null
+)
+```
+

data/docs/SaveAccount.md

@@ -0,0 +1,52 @@
+# Propertyware::SaveAccount
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_number** | **String** | Account number. |  |
+| **account_type** | **Integer** | Valid account types - 1:Bank, 2:Credit Card, 5:Current Asset, 12:Non-Current Asset, 6:Current Liability, 13:Non-Current Liability, 7:Equity, 8:Income, 9:Expense, 10:Non-Operating Income, 11:Non-Operating Expense. |  |
+| **auto_apply_prepayment** | **Boolean** | Indicates if prepayments should be auto applied. | [optional] |
+| **bank** | [**Bank**](Bank.md) |  | [optional] |
+| **code** | **String** | Account code. |  |
+| **credit_card** | [**CreditCardAccount**](CreditCardAccount.md) |  | [optional] |
+| **current_asset** | [**CurrentAsset**](CurrentAsset.md) |  | [optional] |
+| **current_liability** | [**CurrentLiability**](CurrentLiability.md) |  | [optional] |
+| **description** | **String** | Description. |  |
+| **equity** | [**Equity**](Equity.md) |  | [optional] |
+| **expense** | [**Expense**](Expense.md) |  | [optional] |
+| **income** | [**Income**](Income.md) |  | [optional] |
+| **non_current_asset** | [**NonCurrentAsset**](NonCurrentAsset.md) |  | [optional] |
+| **non_current_liability** | [**NonCurrentLiability**](NonCurrentLiability.md) |  | [optional] |
+| **non_operating_expense** | [**NonOperatingExpense**](NonOperatingExpense.md) |  | [optional] |
+| **non_operating_inome** | [**NonOperatingInome**](NonOperatingInome.md) |  | [optional] |
+| **parent_gl_account_id** | **Integer** | Parent account ID. | [optional] |
+| **taxable** | **Boolean** | Indicates if the account is taxable. | [optional] |
+
+## Example
+
+```ruby
+require 'propertyware'
+
+instance = Propertyware::SaveAccount.new(
+  account_number: null,
+  account_type: null,
+  auto_apply_prepayment: false,
+  bank: null,
+  code: null,
+  credit_card: null,
+  current_asset: null,
+  current_liability: null,
+  description: null,
+  equity: null,
+  expense: null,
+  income: null,
+  non_current_asset: null,
+  non_current_liability: null,
+  non_operating_expense: null,
+  non_operating_inome: null,
+  parent_gl_account_id: null,
+  taxable: false
+)
+```
+

data/docs/SaveAddress.md

@@ -0,0 +1,28 @@
+# Propertyware::SaveAddress
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **address** | **String** | Primary street and/or unit address. Required only if country is USA or Canada. | [optional] |
+| **address_cont** | **String** | Address continuation. | [optional] |
+| **city** | **String** | City. Required only if Country is United States / Canada. | [optional] |
+| **country** | **String** | Country. For US addresses, this value should be \"United States\". For other countries, this should be the full country name (Canada, United Kingdom, ...) |  |
+| **postal_code** | **String** | Zip. Required only if Country is United States / Canada. | [optional] |
+| **state_region** | **String** | State. Required only if Country is United States / Canada. | [optional] |
+
+## Example
+
+```ruby
+require 'propertyware'
+
+instance = Propertyware::SaveAddress.new(
+  address: null,
+  address_cont: null,
+  city: null,
+  country: null,
+  postal_code: null,
+  state_region: null
+)
+```
+

data/docs/SaveAdjustment.md

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

data/docs/SaveAutoCharge.md

@@ -0,0 +1,28 @@
+# Propertyware::SaveAutoCharge
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount** | **Float** | Auto charge amount. |  |
+| **due_day** | **Integer** | Charge due day. |  |
+| **end_date** | **Date** | Auto charge end date. | [optional] |
+| **frequency** | **String** | Charge frequency. |  |
+| **gl_account_id** | **Integer** | GL Account ID. |  |
+| **start_date** | **Date** | Auto charge start date. |  |
+
+## Example
+
+```ruby
+require 'propertyware'
+
+instance = Propertyware::SaveAutoCharge.new(
+  amount: null,
+  due_day: null,
+  end_date: null,
+  frequency: null,
+  gl_account_id: null,
+  start_date: null
+)
+```
+

data/docs/SaveBankDeposit.md

@@ -0,0 +1,20 @@
+# Propertyware::SaveBankDeposit
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **bank_gl_account_id** | **Integer** | Bank Account Number. |  |
+| **list_of_tx_ids** | **String** | Comma separated list of Transaction IDs. |  |
+
+## Example
+
+```ruby
+require 'propertyware'
+
+instance = Propertyware::SaveBankDeposit.new(
+  bank_gl_account_id: null,
+  list_of_tx_ids: null
+)
+```
+

data/docs/SaveBill.md

@@ -0,0 +1,42 @@
+# Propertyware::SaveBill
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **bill_date** | **Date** | Bill date. |  |
+| **bill_number** | **Integer** | Bill number. | [optional] |
+| **bill_splits** | [**Array<SaveBillSplit>**](SaveBillSplit.md) | Splits list. | [optional] |
+| **comments** | **String** | Description. | [optional] |
+| **due_date** | **Date** | Bill Due date. |  |
+| **markup_account_id** | **Integer** | Markup account ID. | [optional] |
+| **markup_percentage** | **Float** | Markup percentage. | [optional] |
+| **owner_draw** | **Boolean** | Indicates if it is a owner draw. | [optional] |
+| **payment_date** | **Date** | Payment Date. | [optional] |
+| **ref_no** | **String** | Reference number. | [optional] |
+| **terms** | **String** | Bill terms. | [optional] |
+| **vendor_id** | **Integer** | Related vendor ID. |  |
+| **work_order_id** | **Integer** | WorkOrder ID. | [optional] |
+
+## Example
+
+```ruby
+require 'propertyware'
+
+instance = Propertyware::SaveBill.new(
+  bill_date: null,
+  bill_number: null,
+  bill_splits: null,
+  comments: null,
+  due_date: null,
+  markup_account_id: null,
+  markup_percentage: null,
+  owner_draw: false,
+  payment_date: null,
+  ref_no: null,
+  terms: null,
+  vendor_id: null,
+  work_order_id: null
+)
+```
+

data/docs/SaveBillPayment.md

@@ -0,0 +1,30 @@
+# Propertyware::SaveBillPayment
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **bills** | [**Array<BillPay>**](BillPay.md) | Bills to pay. | [optional] |
+| **check_number** | **String** | Payment check number. | [optional] |
+| **memo** | **String** | Memo. | [optional] |
+| **payment_account_id** | **Integer** | Bank Account to pay from. | [optional] |
+| **payment_date** | **Date** | Payment Date. | [optional] |
+| **payment_method** | **String** | Payment method. | [optional] |
+| **vendor_id** | **Integer** | Vendor ID to Pay. | [optional] |
+
+## Example
+
+```ruby
+require 'propertyware'
+
+instance = Propertyware::SaveBillPayment.new(
+  bills: null,
+  check_number: null,
+  memo: null,
+  payment_account_id: null,
+  payment_date: null,
+  payment_method: null,
+  vendor_id: null
+)
+```
+

data/docs/SaveBillSplit.md

@@ -0,0 +1,36 @@
+# Propertyware::SaveBillSplit
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount** | **Float** | Split amount. |  |
+| **amount_paid** | **Float** | Split amount paid. | [optional] |
+| **building_id** | **Integer** | Location Building ID. | [optional] |
+| **comments** | **String** | Split comments. | [optional] |
+| **gl_account_id** | **Integer** | Split GL Account ID. | [optional] |
+| **id** | **Integer** | Unique identifier. | [optional] |
+| **markup_discount_split** | **Boolean** | Indicates if markup discount split. | [optional] |
+| **paid** | **Boolean** | Indicates if Bill Split is paid. | [optional] |
+| **portfolio_id** | **Integer** | Location Portfolio ID. |  |
+| **unit_id** | **Integer** | Location Unit ID. | [optional] |
+
+## Example
+
+```ruby
+require 'propertyware'
+
+instance = Propertyware::SaveBillSplit.new(
+  amount: null,
+  amount_paid: null,
+  building_id: null,
+  comments: null,
+  gl_account_id: null,
+  id: null,
+  markup_discount_split: false,
+  paid: false,
+  portfolio_id: null,
+  unit_id: null
+)
+```
+

data/docs/SaveBuilding.md

@@ -0,0 +1,84 @@
+# Propertyware::SaveBuilding
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **abbreviation** | **String** | Building abbreviation. |  |
+| **address** | [**SaveAddress**](SaveAddress.md) |  | [optional] |
+| **allocation_method** | **String** | Allocation method. | [optional] |
+| **available_date** | **Date** | Date the building is available for leasing. | [optional] |
+| **category** | **String** | Building category. |  |
+| **count_unit** | **Integer** | Indicates number of units in the building. |  |
+| **description** | **String** | Marketing description. | [optional] |
+| **floor_number** | **Integer** | Floor number. | [optional] |
+| **management_fee_type** | **String** | Indicates management fee type of a building. | [optional] |
+| **management_flat_fee** | **Float** | Indicates management flat fee. | [optional] |
+| **marketing_name** | **String** | Marketing name. | [optional] |
+| **multi_unit** | **Boolean** | Indicates if the building is multi family or single family. | [optional] |
+| **name** | **String** | Name of the building. |  |
+| **naming** | **String** | Unit naming (Unit, Suite, Space, Custom). | [optional] |
+| **neighborhood** | **String** | Neighborhood. | [optional] |
+| **number_bathrooms** | **Float** | Number of bathrooms in the building. | [optional] |
+| **number_bedrooms** | **Integer** | Number of bedrooms in the building. | [optional] |
+| **number_floors** | **Integer** | Number of floors. | [optional] |
+| **numbered** | **String** | Numbered alpha, numeric. | [optional] |
+| **other_tenant_charges** | **String** | Other tenant charges. | [optional] |
+| **parcel_number** | **String** | Parcel number. | [optional] |
+| **pets_allowed** | **Boolean** | Pets allowed. | [optional] |
+| **portfolio_id** | **Integer** | ID of the portfolio associated with this building. |  |
+| **posting_title** | **String** | Marketing posting title. | [optional] |
+| **property_type** | **String** | Property type. |  |
+| **published_for_rent** | **String** | Published for rent. | [optional] |
+| **rentable** | **Boolean** | Indicates if the building is rentable. | [optional] |
+| **search_tag** | **String** | Search tag name. | [optional] |
+| **short_description** | **String** | Marketing short description. | [optional] |
+| **target_deposit** | **String** | Target deposit. | [optional] |
+| **target_rent** | **Float** | Market rent for the building. | [optional] |
+| **total_area** | **Float** | Building area. | [optional] |
+| **type** | **String** | Indicates Building type like Office, Industrial, Retail, Healthcare, Government, Airport, Garage/Parking, Apartment Building, Duplex / Triplex, Mobile Home / RV Community etc. |  |
+| **year_built_as_string** | **String** | Building built year. | [optional] |
+
+## Example
+
+```ruby
+require 'propertyware'
+
+instance = Propertyware::SaveBuilding.new(
+  abbreviation: null,
+  address: null,
+  allocation_method: null,
+  available_date: null,
+  category: null,
+  count_unit: null,
+  description: null,
+  floor_number: null,
+  management_fee_type: null,
+  management_flat_fee: null,
+  marketing_name: null,
+  multi_unit: false,
+  name: null,
+  naming: null,
+  neighborhood: null,
+  number_bathrooms: null,
+  number_bedrooms: null,
+  number_floors: null,
+  numbered: null,
+  other_tenant_charges: null,
+  parcel_number: null,
+  pets_allowed: false,
+  portfolio_id: null,
+  posting_title: null,
+  property_type: null,
+  published_for_rent: null,
+  rentable: false,
+  search_tag: null,
+  short_description: null,
+  target_deposit: null,
+  target_rent: null,
+  total_area: null,
+  type: null,
+  year_built_as_string: null
+)
+```
+

data/docs/SaveCharge.md

@@ -0,0 +1,28 @@
+# Propertyware::SaveCharge
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount** | **Float** | Amount. |  |
+| **comments** | **String** | Comments. | [optional] |
+| **date** | **Date** | Post Date. |  |
+| **gl_account_id** | **Integer** | GL Account ID. |  |
+| **lease_id** | **Integer** | Lease ID. |  |
+| **ref_no** | **String** | Charge reference No. | [optional] |
+
+## Example
+
+```ruby
+require 'propertyware'
+
+instance = Propertyware::SaveCharge.new(
+  amount: null,
+  comments: null,
+  date: null,
+  gl_account_id: null,
+  lease_id: null,
+  ref_no: null
+)
+```
+

data/docs/SaveCheck.md

@@ -0,0 +1,30 @@
+# Propertyware::SaveCheck
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **check_date** | **Date** | Check Date. |  |
+| **check_splits** | [**Array<SaveCheckSplit>**](SaveCheckSplit.md) | Check Split list. | [optional] |
+| **comments** | **String** | Comments. | [optional] |
+| **destination_account_id** | **Integer** | Destination AccountID. |  |
+| **ref_no** | **String** | Check Ref No. | [optional] |
+| **to_be_printed** | **Boolean** | Indicates if Check is to be printed. | [optional] |
+| **vendor_id** | **Integer** | Check related vendorID. | [optional] |
+
+## Example
+
+```ruby
+require 'propertyware'
+
+instance = Propertyware::SaveCheck.new(
+  check_date: null,
+  check_splits: null,
+  comments: null,
+  destination_account_id: null,
+  ref_no: null,
+  to_be_printed: false,
+  vendor_id: null
+)
+```
+

data/docs/SaveCheckSplit.md

@@ -0,0 +1,30 @@
+# Propertyware::SaveCheckSplit
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount** | **Float** | Check Split amount. | [optional] |
+| **building_id** | **Integer** | Check Location Building ID. | [optional] |
+| **comments** | **String** | CheckSplit Comments. | [optional] |
+| **gl_account_id** | **Integer** | Split GL Account ID. |  |
+| **id** | **Integer** | Unique identifier. | [optional] |
+| **portfolio_id** | **Integer** | Portfolio id to apply payment. |  |
+| **unit_id** | **Integer** | Check Location Unit ID. | [optional] |
+
+## Example
+
+```ruby
+require 'propertyware'
+
+instance = Propertyware::SaveCheckSplit.new(
+  amount: null,
+  building_id: null,
+  comments: null,
+  gl_account_id: null,
+  id: null,
+  portfolio_id: null,
+  unit_id: null
+)
+```
+

data/docs/SaveComment.md

@@ -0,0 +1,18 @@
+# Propertyware::SaveComment
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **text** | **String** | Comment text. |  |
+
+## Example
+
+```ruby
+require 'propertyware'
+
+instance = Propertyware::SaveComment.new(
+  text: null
+)
+```
+

data/docs/SaveContact.md

@@ -0,0 +1,60 @@
+# Propertyware::SaveContact
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **address** | [**SaveAddress**](SaveAddress.md) |  | [optional] |
+| **allow_e_signature** | **Boolean** | Indicate if the contact can receive eSignature request e-mail messages sent through Propertyware. | [optional] |
+| **alt_email** | **String** | Alternate Email Address. | [optional] |
+| **birth_date** | **Date** | Date of Birth. | [optional] |
+| **comments** | **String** | Description. | [optional] |
+| **company** | **String** | Company where the contact is employed. | [optional] |
+| **email** | **String** | E-mail Address. | [optional] |
+| **fax** | **String** | Fax. | [optional] |
+| **first_name** | **String** | First Name. |  |
+| **gender** | **String** | Gender. | [optional] |
+| **home_phone** | **String** | Home Phone. | [optional] |
+| **job_title** | **String** | Professional title or position for the contact. | [optional] |
+| **last_name** | **String** | Last Name. |  |
+| **middle_name** | **String** | First Name. | [optional] |
+| **mobile_phone** | **String** | Mobile Phone. | [optional] |
+| **name_on_check** | **String** | Name On Check. | [optional] |
+| **named_on_lease** | **Boolean** | Is Named On Lease. | [optional] |
+| **other_phone** | **String** | Other Phone. | [optional] |
+| **salutation** | **String** | Salutation. | [optional] |
+| **search_tag** | **String** | SearchTag. | [optional] |
+| **suffix** | **String** | Suffix. | [optional] |
+| **work_phone** | **String** | Work Phone. | [optional] |
+
+## Example
+
+```ruby
+require 'propertyware'
+
+instance = Propertyware::SaveContact.new(
+  address: null,
+  allow_e_signature: false,
+  alt_email: null,
+  birth_date: null,
+  comments: null,
+  company: null,
+  email: null,
+  fax: null,
+  first_name: null,
+  gender: null,
+  home_phone: null,
+  job_title: null,
+  last_name: null,
+  middle_name: null,
+  mobile_phone: null,
+  name_on_check: null,
+  named_on_lease: false,
+  other_phone: null,
+  salutation: null,
+  search_tag: null,
+  suffix: null,
+  work_phone: null
+)
+```
+

data/docs/SaveConversation.md

@@ -0,0 +1,20 @@
+# Propertyware::SaveConversation
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **text** | **String** | Comment text. |  |
+| **type** | **String** | Conversation type. |  |
+
+## Example
+
+```ruby
+require 'propertyware'
+
+instance = Propertyware::SaveConversation.new(
+  text: null,
+  type: null
+)
+```
+