buildium-ruby 2.1.0 → 3.1.0

data/docs/CreateOwnershipAccountAutoAllocatedPaymentRequest.md

@@ -0,0 +1,30 @@
+# Buildium::CreateOwnershipAccountAutoAllocatedPaymentRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **date** | **Date** | The date of the transaction. The date must be formatted as YYYY-MM-DD. |  |
+| **payment_method** | **String** | The payment method used for the transaction. |  |
+| **payee_user_id** | **Integer** | The payee's user unique identifier. | [optional] |
+| **memo** | **String** | A brief note describing the reason for the payment. The value cannot exceed 65 characters. | [optional] |
+| **reference_number** | **String** | The reference Number of the transaction. The value cannot exceed 30 characters. | [optional] |
+| **send_email_receipt** | **Boolean** | An indicator for whether or not to send an email receipt to the payee. If the payee does not have an email address set, no email will be sent. |  |
+| **total_amount** | **Float** | The total amount of the payment being created. |  |
+
+## Example
+
+```ruby
+require 'buildium-ruby'
+
+instance = Buildium::CreateOwnershipAccountAutoAllocatedPaymentRequest.new(
+  date: null,
+  payment_method: null,
+  payee_user_id: null,
+  memo: null,
+  reference_number: null,
+  send_email_receipt: null,
+  total_amount: null
+)
+```
+

data/docs/CreateOwnershipAccountCreditRecurringTransactionRequest.md

@@ -0,0 +1,36 @@
+# Buildium::CreateOwnershipAccountCreditRecurringTransactionRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **credit_type** | **String** | Indicates how the credit will be applied.  <ul><li>WaiveUnpaid - This credit type allows for reversing one or more charges without losing record of what has changed.</li><li>Exchange - This credit type allows for one of the following: 1) Reimburse a resident for a out-of-pocket expense, 2) Compensate for a service, 3) Write-off a resident balance considered uncollectable.</li><li>PreviouslyDeposited - This credit type allows for issuing a credit against payments that have already been deposited.</li></ul> |  |
+| **offsetting_gl_account_id** | **Integer** | Sets the offsetting general ledger account identifier for the credit.  <br />This value must be provided when the `CreditType` field is set to `Exchange` or `PreviouslyDeposited`.  <br />When the `CreditType` is `Exchange` this must be an *expense* general ledger account type.  <br />When the `CreditType` is `PreviouslyDeposited` this must be an *equity* general ledger account type. | [optional] |
+| **posting_rule_gl_account_id** | **Integer** | Indicates whether to apply a posting rule when processing the transaction that would only record the credit if a prior payment has been made.  <br /><br />  Set the field value to the <b>Rent Income</b> general ledger account identifier if the credit should only be recorded when a payment was made and applied to the <b>Rent Income</b> general ledger account.  <br /><br />  Set the field value to the <b>Accounts Receivable</b> general ledger account identifier if the credit should only be recorded when a payment was made and applied to *any* general ledger account.  <br /><br />  Set the field value to <b>null</b> to always record the credit. | [optional] |
+| **lines** | [**Array<RecurringTransactionLinePostMessage>**](RecurringTransactionLinePostMessage.md) | Line items describing how the credit is to be allocated when the recurring credit is processed. | [optional] |
+| **post_days_in_advance** | **Integer** | Specifies the number of days ahead of the transaction date the credit will post on the lease ledger. This setting can be used to add the credit to the ledger ahead of the due date for visibility. For example, if the `FirstOccurrenceDate` is set to 8/10/2022 and this value is set to 5 then the charge will added to the ledger on 8/5/2022, but will have transaction date of 8/10/2022. Note, the value must be between 0 to 45 or set to 60, 75 or 90. |  |
+| **frequency** | **String** | Specifies the frequency at which the recurring credit will be processed. |  |
+| **duration** | **String** | Specifies the period of time/occurrences the recurring credit will be processed. Note, if the `Frequency` field is set to `OneTime` this field should be set to `NULL` as any submitted value will be ignored. | [optional] |
+| **number_of_occurrences** | **Integer** | Indicates the number of times the recurring credit should be processed. This value is required if the `Duration` field is set to `SpecificNumber`. This value can not exceed 100. | [optional] |
+| **first_occurrence_date** | **Date** | The date the credit will first be processed. This value along with the `Frequency` is also used as the basis for the date set on the transactions in future occurrences. |  |
+| **memo** | **String** | Memo associated with the recurring credit. This value cannot exceed 65 characters. | [optional] |
+
+## Example
+
+```ruby
+require 'buildium-ruby'
+
+instance = Buildium::CreateOwnershipAccountCreditRecurringTransactionRequest.new(
+  credit_type: null,
+  offsetting_gl_account_id: null,
+  posting_rule_gl_account_id: null,
+  lines: null,
+  post_days_in_advance: null,
+  frequency: null,
+  duration: null,
+  number_of_occurrences: null,
+  first_occurrence_date: null,
+  memo: null
+)
+```
+

data/docs/CreateOwnershipAccountCreditRequest.md

@@ -0,0 +1,26 @@
+# Buildium::CreateOwnershipAccountCreditRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **date** | **Date** | Date of the transaction. The date must be formatted as YYYY-MM-DD. |  |
+| **memo** | **String** | Description of the transaction. The value cannot exceed 65 characters. | [optional] |
+| **credit_type** | **String** | Indicates how the credit should be applied.  <ul><li>WaiveUnpaid - This credit type allows for reversing one or more charges without losing record of what has changed.</li><li>Exchange - This credit type allows for one of the following: 1) Reimburse a resident for a out-of-pocket expense, 2) Compensate for a service, 3) Write-off a resident balance considered uncollectable.</li><li>PreviouslyDeposited - This credit type allows for issuing a credit against payments that have already been deposited.</li></ul> |  |
+| **offsetting_gl_account_id** | **Integer** | Sets the offsetting general ledger account identifier for the credit.  <br />This value must be provided when the `CreditType` field is set to `Exchange` or `PreviouslyDeposited`.  <br />When the `CreditType` is `Exchange` this must be an *expense* general ledger account type.  <br />When the `CreditType` is `PreviouslyDeposited` this must be an *equity* general ledger account type. | [optional] |
+| **lines** | [**Array<OwnershipAccountCreditLinePostMessage>**](OwnershipAccountCreditLinePostMessage.md) | A collection of line items included in the credit. At least one line item is required. |  |
+
+## Example
+
+```ruby
+require 'buildium-ruby'
+
+instance = Buildium::CreateOwnershipAccountCreditRequest.new(
+  date: null,
+  memo: null,
+  credit_type: null,
+  offsetting_gl_account_id: null,
+  lines: null
+)
+```
+

data/docs/CreateOwnershipAccountDepositWithholdingRequest.md

@@ -0,0 +1,24 @@
+# Buildium::CreateOwnershipAccountDepositWithholdingRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **entry_date** | **Date** | Date of the deposit withholding. The date must be formatted as YYYY-MM-DD. |  |
+| **deposit_liability_gl_account_id** | **Integer** | The identifier of the liability general ledger account from which to withhold the funds. Note, the specified liability account must have a positive balance. |  |
+| **memo** | **String** | Memo associated with the withholding. Memo cannot exceed 65 characters. | [optional] |
+| **lines** | [**Array<OwnershipAccountDepositWithholdingLinePostMessage>**](OwnershipAccountDepositWithholdingLinePostMessage.md) | Line items specifying the income accounts the deposit will be applied to. The total amount of the line items can not exceed the balance of the liability account. | [optional] |
+
+## Example
+
+```ruby
+require 'buildium-ruby'
+
+instance = Buildium::CreateOwnershipAccountDepositWithholdingRequest.new(
+  entry_date: null,
+  deposit_liability_gl_account_id: null,
+  memo: null,
+  lines: null
+)
+```
+

data/docs/CreateOwnershipAccountLedgerChargeRequest.md

@@ -0,0 +1,24 @@
+# Buildium::CreateOwnershipAccountLedgerChargeRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **date** | **Date** | Date of the charge. The date must be formatted as YYYY-MM-DD. |  |
+| **memo** | **String** | Memo associated with the charge. The value cannot exceed 65 characters. | [optional] |
+| **bill_id** | **Integer** | Unique identifier of the bill this charge is associated to. If provided, the property of the  ownership account ledger the charge is being created in must be in at least one line item of the bill. | [optional] |
+| **lines** | [**Array<OwnershipAccountLedgerChargeLinesSaveMessage>**](OwnershipAccountLedgerChargeLinesSaveMessage.md) | Collection of line items to be included in the charge. All existing line items will be deleted and replaced with the line items in this request. At least 1 line item is required. |  |
+
+## Example
+
+```ruby
+require 'buildium-ruby'
+
+instance = Buildium::CreateOwnershipAccountLedgerChargeRequest.new(
+  date: null,
+  memo: null,
+  bill_id: null,
+  lines: null
+)
+```
+

data/docs/CreateOwnershipAccountLedgerPaymentRequest.md

@@ -0,0 +1,30 @@
+# Buildium::CreateOwnershipAccountLedgerPaymentRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **date** | **Date** | The date of the transaction. The date must be formatted as YYYY-MM-DD. |  |
+| **payment_method** | **String** | The payment method used for the transaction. |  |
+| **payee_user_id** | **Integer** | The payee's user unique identifier. | [optional] |
+| **memo** | **String** | A brief note describing the reason for the payment. The value cannot exceed 65 characters. | [optional] |
+| **reference_number** | **String** | The reference Number of the transaction. The value cannot exceed 30 characters. | [optional] |
+| **send_email_receipt** | **Boolean** | An indicator for whether or not to send an email receipt to the payee. If the payee does not have an email address set, no email will be sent. |  |
+| **lines** | [**Array<OwnershipAccountLedgerPaymentLineSaveMessage>**](OwnershipAccountLedgerPaymentLineSaveMessage.md) | A collection of line items included in the payment. At least one line item is required. |  |
+
+## Example
+
+```ruby
+require 'buildium-ruby'
+
+instance = Buildium::CreateOwnershipAccountLedgerPaymentRequest.new(
+  date: null,
+  payment_method: null,
+  payee_user_id: null,
+  memo: null,
+  reference_number: null,
+  send_email_receipt: null,
+  lines: null
+)
+```
+

data/docs/CreateOwnershipAccountRecurringPaymentRequest.md

@@ -0,0 +1,34 @@
+# Buildium::CreateOwnershipAccountRecurringPaymentRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payer_user_id** | **Integer** | The unique identifier of the user making the payment. | [optional] |
+| **payment_method** | **String** | The payment method for the transaction. |  |
+| **lines** | [**Array<RecurringTransactionLinePostMessage>**](RecurringTransactionLinePostMessage.md) | Line items describing how the payment is to be allocated when the payment is processed. | [optional] |
+| **memo** | **String** | Memo associated with the recurring payment. This value cannot exceed 65 characters. | [optional] |
+| **first_occurrence_date** | **Date** | The date the payment will first be processed. This value along with the `Frequency` is also used as the basis for the date set on the transactions in future occurrences. |  |
+| **post_days_in_advance** | **Integer** | Specifies the number of days ahead of the transaction date the payment will post on the lease ledger. This setting can be used to add the payment to the ledger ahead of the due date for visibility. For example, if the `FirstOccurrenceDate` is set to 8/10/2022 and this value is set to 5 then the charge will added to the ledger on 8/5/2022, but will have transaction date of 8/10/2022. Note, the value must be between 0 to 45 or set to 60, 75 or 90. |  |
+| **frequency** | **String** | Specifies the frequency at which the recurring payment will be processed. |  |
+| **duration** | **String** | Specifies the period of time/occurrences the recurring payment will be processed. Note, if the `Frequency` field is set to `OneTime` this field should be set to `NULL` as any submitted value will be ignored. | [optional] |
+| **number_of_occurrences** | **Integer** | Indicates the number of times the recurring payment should be processed. This value is required if the `Duration` field is set to `SpecificNumber`. This value can not exceed 100. | [optional] |
+
+## Example
+
+```ruby
+require 'buildium-ruby'
+
+instance = Buildium::CreateOwnershipAccountRecurringPaymentRequest.new(
+  payer_user_id: null,
+  payment_method: null,
+  lines: null,
+  memo: null,
+  first_occurrence_date: null,
+  post_days_in_advance: null,
+  frequency: null,
+  duration: null,
+  number_of_occurrences: null
+)
+```
+

data/docs/CreateOwnershipAccountRefundRequest.md

@@ -0,0 +1,30 @@
+# Buildium::CreateOwnershipAccountRefundRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **date** | **Date** | The date of the refund. The date must be formatted as YYYY-MM-DD. |  |
+| **payee_user_ids** | **Array<Integer>** | Unique identifiers of the users receiving the refund. |  |
+| **memo** | **String** | A brief note describing the reason for the refund. The value cannot exceed 65 characters. | [optional] |
+| **check_number** | **String** | Check number associated with the refund, if applicable. The value cannot exceed 30 characters. | [optional] |
+| **bank_account_id** | **Integer** | Unique identifier of the bank account the refund is issued from. |  |
+| **address** | [**LeaseLedgerRefundPostMessageAddress**](LeaseLedgerRefundPostMessageAddress.md) |  |  |
+| **lines** | [**Array<OwnershipAccountRefundLinesPostMessage>**](OwnershipAccountRefundLinesPostMessage.md) | A collection of line items included in the refund. At least one line item is required. |  |
+
+## Example
+
+```ruby
+require 'buildium-ruby'
+
+instance = Buildium::CreateOwnershipAccountRefundRequest.new(
+  date: null,
+  payee_user_ids: null,
+  memo: null,
+  check_number: null,
+  bank_account_id: null,
+  address: null,
+  lines: null
+)
+```
+

data/docs/CreateOwnershipAccountsChargeRecurringTransactionRequest.md

@@ -0,0 +1,32 @@
+# Buildium::CreateOwnershipAccountsChargeRecurringTransactionRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **gl_account_id** | **Integer** | The general ledger account unique identifier under which the charge amount will be recorded. The general ledger account can only be an income or liability account. |  |
+| **amount** | **Float** | The amount to record when applying the charge to the lease ledger. |  |
+| **memo** | **String** | Memo associated with the recurring charge. This value cannot exceed 65 characters. | [optional] |
+| **first_occurrence_date** | **Date** | The date the charge will first be processed. This value along with the `Frequency` is also used as the basis for the date set on the transactions in future occurrences. |  |
+| **post_days_in_advance** | **Integer** | Specifies the number of days ahead of the transaction date the charge will post on the lease ledger. This setting can be used to add the charge to the ledger ahead of the due date for visibility. For example, if the `FirstOccurrenceDate` is set to 8/10/2022 and this value is set to 5 then the charge will added to the ledger on 8/5/2022, but will have transaction date of 8/10/2022. Note, the value must be between 0 to 45 or set to 60, 75 or 90. |  |
+| **frequency** | **String** | Specifies the frequency at which the recurring charge will be processed. |  |
+| **duration** | **String** | Specifies the period of time/occurrences the recurring payment will be processed. Note, if the `Frequency` field is set to `OneTime` this field should be set to `NULL` as any submitted value will be ignored. | [optional] |
+| **number_of_occurrences** | **Integer** | Indicates the number of times the recurring transaction should be processed. This value is required if the `Duration` field is set to `SpecificNumber`. This value can not exceed 100. | [optional] |
+
+## Example
+
+```ruby
+require 'buildium-ruby'
+
+instance = Buildium::CreateOwnershipAccountsChargeRecurringTransactionRequest.new(
+  gl_account_id: null,
+  amount: null,
+  memo: null,
+  first_occurrence_date: null,
+  post_days_in_advance: null,
+  frequency: null,
+  duration: null,
+  number_of_occurrences: null
+)
+```
+

data/docs/CreatePaymentRequest.md

@@ -0,0 +1,30 @@
+# Buildium::CreatePaymentRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **date** | **Date** | The date of the transaction. The date must be formatted as YYYY-MM-DD. |  |
+| **payment_method** | **String** | The payment method used for the transaction. |  |
+| **payee_user_id** | **Integer** | The payee's user unique identifier. | [optional] |
+| **memo** | **String** | A brief note describing the reason for the payment. The value cannot exceed 65 characters. | [optional] |
+| **reference_number** | **String** | The reference Number of the transaction. The value cannot exceed 30 characters. | [optional] |
+| **send_email_receipt** | **Boolean** | An indicator for whether or not to send an email receipt to the payee. If the payee does not have an email address set, no email will be sent. |  |
+| **lines** | [**Array<LeaseLedgerPaymentLineSaveMessage>**](LeaseLedgerPaymentLineSaveMessage.md) | A collection of line items included in the payment. At least one line item is required. |  |
+
+## Example
+
+```ruby
+require 'buildium-ruby'
+
+instance = Buildium::CreatePaymentRequest.new(
+  date: null,
+  payment_method: null,
+  payee_user_id: null,
+  memo: null,
+  reference_number: null,
+  send_email_receipt: null,
+  lines: null
+)
+```
+

data/docs/CreatePendingReconciliationsRequest.md

@@ -0,0 +1,24 @@
+# Buildium::CreatePendingReconciliationsRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **statement_ending_date** | **Date** | End date for the reconciliation statement period. The date must be formatted as YYYY-MM-DD. |  |
+| **total_checks_and_withdrawals** | **Float** | Sum of all checks and withdrawals for the reconciliation. | [optional] |
+| **total_deposits_and_additions** | **Float** | Sum of all deposits and additions for the reconciliation. | [optional] |
+| **ending_balance** | **Float** | Ending balance of the pending reconciliation. |  |
+
+## Example
+
+```ruby
+require 'buildium-ruby'
+
+instance = Buildium::CreatePendingReconciliationsRequest.new(
+  statement_ending_date: null,
+  total_checks_and_withdrawals: null,
+  total_deposits_and_additions: null,
+  ending_balance: null
+)
+```
+

data/docs/CreatePhoneLogRequest.md

@@ -0,0 +1,24 @@
+# Buildium::CreatePhoneLogRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **participant** | [**PhoneLogPostMessageParticipant**](PhoneLogPostMessageParticipant.md) |  |  |
+| **subject** | **String** | Subject of the phone call. This value is restricted to a maximum of 255 characters. |  |
+| **description** | **String** | Description of the phone call. This value is restricted to a maximum of 65,535 characters. |  |
+| **call_date_time** | **Time** | The date and time the call took place. Time of the phone call must be UTC. Example format: \"2021-01-26T13:59:15Z\" |  |
+
+## Example
+
+```ruby
+require 'buildium-ruby'
+
+instance = Buildium::CreatePhoneLogRequest.new(
+  participant: null,
+  subject: null,
+  description: null,
+  call_date_time: null
+)
+```
+

data/docs/CreatePropertyGroupRequest.md

@@ -0,0 +1,22 @@
+# Buildium::CreatePropertyGroupRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Property group name. The name can not exceed 127 characters. |  |
+| **description** | **String** | Description of the property group. The description can not exceed 1000 characters. | [optional] |
+| **property_ids** | **Array<Integer>** | A list of association and/or rental property unique identifiers to assign to the property group. Property groups cannot be created using inactive associations and/or rental properties. |  |
+
+## Example
+
+```ruby
+require 'buildium-ruby'
+
+instance = Buildium::CreatePropertyGroupRequest.new(
+  name: null,
+  description: null,
+  property_ids: null
+)
+```
+

data/docs/CreateQuickDepositRequest.md

@@ -0,0 +1,26 @@
+# Buildium::CreateQuickDepositRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **entry_date** | **Date** | Date the quick deposit was recorded. |  |
+| **offset_gl_account_id** | **Integer** | Offsetting general ledger account identifier. The offsetting general ledger account acts as a label for this deposit. For instance, if you're depositing money collected from a washing machine, you might select the \"Laundry income\" account. |  |
+| **amount** | **Float** | Amount to be deposited. |  |
+| **memo** | **String** | Memo associated with the quick deposit. | [optional] |
+| **accounting_entity** | [**BankAccountQuickDepositSaveMessageAccountingEntity**](BankAccountQuickDepositSaveMessageAccountingEntity.md) |  |  |
+
+## Example
+
+```ruby
+require 'buildium-ruby'
+
+instance = Buildium::CreateQuickDepositRequest.new(
+  entry_date: null,
+  offset_gl_account_id: null,
+  amount: null,
+  memo: null,
+  accounting_entity: null
+)
+```
+

data/docs/CreateRentScheduleRequest.md

@@ -0,0 +1,24 @@
+# Buildium::CreateRentScheduleRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **start_date** | **Date** | Indicates the start of the rent schedule. The date must be formatted as YYYY-MM-DD.  If no rent schedules exist on a lease, this date must match the lease start date. | [optional] |
+| **rent_cycle** | **String** | Indicates the cadence of when rent charges will be applied. |  |
+| **backdate_charges** | **Boolean** | Indicates if charges that should have posted prior to the date of Rent creation should be posted immediately with the appropriate dates. |  |
+| **charges** | [**Array<RentScheduleChargePostMessage>**](RentScheduleChargePostMessage.md) | List of charges to apply to the lease. |  |
+
+## Example
+
+```ruby
+require 'buildium-ruby'
+
+instance = Buildium::CreateRentScheduleRequest.new(
+  start_date: null,
+  rent_cycle: null,
+  backdate_charges: null,
+  charges: null
+)
+```
+

data/docs/CreateRentalApplianceRequest.md

@@ -0,0 +1,32 @@
+# Buildium::CreateRentalApplianceRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **property_id** | **Integer** | Rental property unique identifier that the appliance belongs to. |  |
+| **unit_id** | **Integer** | Rental unit unique identifier that the appliance belongs to. | [optional] |
+| **name** | **String** | The name of the appliance. The name cannot exceed 100 characters. |  |
+| **make** | **String** | The make of the appliance. The make cannot exceed 30 characters. | [optional] |
+| **model** | **String** | The model of the appliance. The model cannot exceed 30 characters. | [optional] |
+| **description** | **String** | The description of the appliance. The description cannot exceed 500 characters. | [optional] |
+| **install_date** | **Date** | The install date for the appliance's warranty. Must be formatted as `YYYY-MM-DD`. | [optional] |
+| **warranty_end_date** | **Date** | The end date for the appliance's warranty. The warranty's end date cannot be before the installed date, if it exists. Must be formatted as `YYYY-MM-DD`. | [optional] |
+
+## Example
+
+```ruby
+require 'buildium-ruby'
+
+instance = Buildium::CreateRentalApplianceRequest.new(
+  property_id: null,
+  unit_id: null,
+  name: null,
+  make: null,
+  model: null,
+  description: null,
+  install_date: null,
+  warranty_end_date: null
+)
+```
+

data/docs/CreateRentalApplianceServiceHistoryRequest.md

@@ -0,0 +1,22 @@
+# Buildium::CreateRentalApplianceServiceHistoryRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **service_type** | **String** | Specifies the type of service that occured. |  |
+| **date** | **Date** | Date the service was performed. Must be formatted as `YYYY-MM-DD`. |  |
+| **details** | **String** | The service history details associated with the appliance. The description cannot exceed 100 characters. | [optional] |
+
+## Example
+
+```ruby
+require 'buildium-ruby'
+
+instance = Buildium::CreateRentalApplianceServiceHistoryRequest.new(
+  service_type: null,
+  date: null,
+  details: null
+)
+```
+

data/docs/CreateRentalImageUploadFileRequestAsyncRequest.md

@@ -0,0 +1,22 @@
+# Buildium::CreateRentalImageUploadFileRequestAsyncRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **file_name** | **String** | Name of file being uploaded. The value can not exceed 255 characters. |  |
+| **description** | **String** | A description of the file. The value cannot exceed 100 characters. | [optional] |
+| **show_in_listing** | **Boolean** | Indicates whether the image will be shown in listings. |  |
+
+## Example
+
+```ruby
+require 'buildium-ruby'
+
+instance = Buildium::CreateRentalImageUploadFileRequestAsyncRequest.new(
+  file_name: null,
+  description: null,
+  show_in_listing: null
+)
+```
+

data/docs/CreateRentalOwnerRequest.md

@@ -0,0 +1,44 @@
+# Buildium::CreateRentalOwnerRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **first_name** | **String** | First name of the rental owner. Required if `IsCompany` is `false`. The value cannot exceed 127 characters. | [optional] |
+| **last_name** | **String** | Last name of the rental owner. Required if `IsCompany` is `false`. The value cannot exceed 127 characters. | [optional] |
+| **is_company** | **Boolean** | Indicates whether the rental owner should be considered a company or person. |  |
+| **company_name** | **String** | Company name of the rental owner. Required if `IsCompany` is `true`. The value cannot exceed 127 characters. | [optional] |
+| **date_of_birth** | **Date** | Date of birth of the rental owner. Must be formatted as `YYYY-MM-DD`. | [optional] |
+| **management_agreement_start_date** | **Date** | Start date of the management agreement with the rental owner. Must be formatted as `YYYY-MM-DD`. | [optional] |
+| **management_agreement_end_date** | **Date** | End date of the management agreement with the rental owner. Must be formatted as `YYYY-MM-DD`. | [optional] |
+| **email** | **String** | Email of the rental owner. | [optional] |
+| **alternate_email** | **String** | Alternate email of the rental owner. | [optional] |
+| **phone_numbers** | [**RentalOwnerPostMessagePhoneNumbers**](RentalOwnerPostMessagePhoneNumbers.md) |  | [optional] |
+| **address** | [**RentalOwnerPostMessageAddress**](RentalOwnerPostMessageAddress.md) |  |  |
+| **comment** | **String** | Comments about the rental owner. The comments cannot exceed 65,535 characters. | [optional] |
+| **property_ids** | **Array<Integer>** | A list of rental property ID's to associate with this rental owner. At least one property ID must be provided. |  |
+| **tax_information** | [**RentalOwnerPostMessageTaxInformation**](RentalOwnerPostMessageTaxInformation.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'buildium-ruby'
+
+instance = Buildium::CreateRentalOwnerRequest.new(
+  first_name: null,
+  last_name: null,
+  is_company: null,
+  company_name: null,
+  date_of_birth: null,
+  management_agreement_start_date: null,
+  management_agreement_end_date: null,
+  email: null,
+  alternate_email: null,
+  phone_numbers: null,
+  address: null,
+  comment: null,
+  property_ids: null,
+  tax_information: null
+)
+```
+

data/docs/CreateRentalOwnerRequestTaskRequest.md

@@ -0,0 +1,38 @@
+# Buildium::CreateRentalOwnerRequestTaskRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **title** | **String** | Request title. The title can not exceed 127 characters. |  |
+| **description** | **String** | Request description. The description can not exceed 65500 characters. | [optional] |
+| **category_id** | **Integer** | The category identifier to assign the request. | [optional] |
+| **sub_category_id** | **Integer** | The subcategory identifier to assign the request. | [optional] |
+| **property_id** | **Integer** | The unique identifier of property associated with the request. The assigned property must be active. | [optional] |
+| **unit_id** | **Integer** | The unique identifier of the unit associated with the request. The unit must be associated with the `PropertyId` specified. | [optional] |
+| **assigned_to_user_id** | **Integer** | The unique identifier of the staff user assigned to the request. The user must be a `Staff` user type. | [optional] |
+| **task_status** | **String** | Request status. |  |
+| **priority** | **String** | Request priority. |  |
+| **due_date** | **Date** | Request due date. The date must be formatted as YYYY-MM-DD. | [optional] |
+| **requested_by_rental_owner_id** | **Integer** | The unique identifier of the rental owner that submitted the request. |  |
+
+## Example
+
+```ruby
+require 'buildium-ruby'
+
+instance = Buildium::CreateRentalOwnerRequestTaskRequest.new(
+  title: null,
+  description: null,
+  category_id: null,
+  sub_category_id: null,
+  property_id: null,
+  unit_id: null,
+  assigned_to_user_id: null,
+  task_status: null,
+  priority: null,
+  due_date: null,
+  requested_by_rental_owner_id: null
+)
+```
+

data/docs/CreateRentalPropertyRequest.md

@@ -0,0 +1,36 @@
+# Buildium::CreateRentalPropertyRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Rental property name. The value cannot exceed 127 characters. |  |
+| **structure_description** | **String** | Description of the rental property building. The description cannot exceed 65,535 characters. | [optional] |
+| **address** | [**RentalPropertyPostMessageAddress**](RentalPropertyPostMessageAddress.md) |  |  |
+| **rental_sub_type** | **String** | Subtype of the rental property. |  |
+| **rental_owner_ids** | **Array<Integer>** | List of existing rental owner ID's that are owners of this property. | [optional] |
+| **operating_bank_account_id** | **Integer** | The primary bank account that a rental property uses for its income and expenses. |  |
+| **property_manager_id** | **Integer** | Indicates the staff member identifier that acts as the property manager for this rental property. Note, the staff member must have permissions to this rental to be assigned as the property manager.  Set this field to null if you don't want to assign a staff member to the rental property. | [optional] |
+| **reserve** | **Float** | A property reserve is cash that a property manager keeps on hand in case of unexpected expenses. It is available cash that isn't disbursed in an owner draw. | [optional] |
+| **year_built** | **Integer** | Indicates the year the rental property was built. If provided this value must be a four digit integer between 1000 and the current year. | [optional] |
+| **units** | [**Array<RentalPropertyUnitPostMessage>**](RentalPropertyUnitPostMessage.md) | Units of the rental property. If no values are provided, a default unit will be created for the property. The number of units cannot exceed 100. If you need to create more than 100 units for the property, use the <a href=\"#operation/RentalUnitsCreateRentalUnit\">Create a unit</a> endpoint to create the additional units once the property has been created. | [optional] |
+
+## Example
+
+```ruby
+require 'buildium-ruby'
+
+instance = Buildium::CreateRentalPropertyRequest.new(
+  name: null,
+  structure_description: null,
+  address: null,
+  rental_sub_type: null,
+  rental_owner_ids: null,
+  operating_bank_account_id: null,
+  property_manager_id: null,
+  reserve: null,
+  year_built: null,
+  units: null
+)
+```
+