# Buildium::LeaseRecurringPaymentMessage

## Properties

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **id** | **Integer** | The unique identifier for the recurring payment schedule. | [optional] |
| **lease_id** | **Integer** | The unique identifier of the lease that the recurring payment will be applied to. | [optional] |
| **payer** | [**PayeeMessage**](PayeeMessage.md) |  | [optional] |
| **payment_method** | **String** | The method of payment for the transaction. | [optional] |
| **lines** | [**Array<RecurringTransactionLineMessage>**](RecurringTransactionLineMessage.md) | Line items describing how the payment is to be allocated when the recurring transaction is processed. | [optional] |
| **amount** | **Float** | The total amount of the recurring payment based on sum of the `Lines.Amount`. | [optional] |
| **occurrences_remaining** | **Integer** | The number of remaining times this recurring payment will be processed. | [optional] |
| **first_occurrence_date** | **Date** | The date the first occurrence this payment was processed. | [optional] |
| **next_occurrence_date** | **Date** | The next date the scheduled payment will be processed. | [optional] |
| **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 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. | [optional] |
| **frequency** | **String** | Indicates the frequency at which the recurring payment is processed. | [optional] |
| **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] |
| **memo** | **String** | Memo associated with the recurring payment. | [optional] |

## Example

```ruby
require 'buildium-ruby'

instance = Buildium::LeaseRecurringPaymentMessage.new(
  id: null,
  lease_id: null,
  payer: null,
  payment_method: null,
  lines: null,
  amount: null,
  occurrences_remaining: null,
  first_occurrence_date: null,
  next_occurrence_date: null,
  post_days_in_advance: null,
  frequency: null,
  duration: null,
  memo: null
)
```