class

Plaid::MortgageLiability

Inherits OpenApi::Json < OpenApi::Validatable < JSON::Serializable::Unmapped < JSON::Serializable < Reference < Object

Contains details about a mortgage account.

Constructors

new(pull : JSON::PullParser)

new(*, __pull_for_json_serializable pull : JSON::PullParser)

new(*, account_id : String | Nil = nil, account_number : String | Nil = nil, current_late_fee : Float64 | Nil = nil, escrow_balance : Float64 | Nil = nil, has_pmi : Bool | Nil = nil, has_prepayment_penalty : Bool | Nil = nil, interest_rate : MortgageInterestRate | Nil = nil, last_payment_amount : Float64 | Nil = nil, last_payment_date : Time | Nil = nil, loan_type_description : String | Nil = nil, loan_term : String | Nil = nil, maturity_date : Time | Nil = nil, next_monthly_payment : Float64 | Nil = nil, next_payment_due_date : Time | Nil = nil, origination_date : Time | Nil = nil, origination_principal_amount : Float64 | Nil = nil, past_due_amount : Float64 | Nil = nil, property_address : MortgagePropertyAddress | Nil = nil, ytd_interest_paid : Float64 | Nil = nil, ytd_principal_paid : Float64 | Nil = nil)

Initializes the object @param [Hash] attributes Model attributes in the form of hash

Instance methods

==(other : self)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

account_id

The ID of the account that this liability belongs to.

account_id=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] account_id Object to be assigned

account_number

The account number of the loan.

account_number=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] account_number Object to be assigned

current_late_fee

The current outstanding amount charged for late payment.

current_late_fee=(new_value : Float64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] current_late_fee Object to be assigned

escrow_balance

Total amount held in escrow to pay taxes and insurance on behalf of the borrower.

escrow_balance=(new_value : Float64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] escrow_balance Object to be assigned

has_pmi

Indicates whether the borrower has private mortgage insurance in effect.

has_pmi=(new_value : Bool | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] has_pmi Object to be assigned

has_prepayment_penalty

Indicates whether the borrower will pay a penalty for early payoff of mortgage.

has_prepayment_penalty=(new_value : Bool | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] has_prepayment_penalty Object to be assigned

hash(hasher)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

interest_rate

interest_rate=(new_value : MortgageInterestRate | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] interest_rate Object to be assigned

last_payment_amount

The amount of the last payment.

last_payment_amount=(new_value : Float64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] last_payment_amount Object to be assigned

last_payment_date

The date of the last payment. Dates are returned in an ISO 8601 format (YYYY-MM-DD).

last_payment_date=(new_value : Time | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] last_payment_date Object to be assigned

list_invalid_properties

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

loan_term

Full duration of mortgage as at origination (e.g. 10 year).

loan_term=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] loan_term Object to be assigned

loan_type_description

Description of the type of loan, for example conventional, fixed, or variable. This field is provided directly from the loan servicer and does not have an enumerated set of possible values.

loan_type_description=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] loan_type_description Object to be assigned

maturity_date

Original date on which mortgage is due in full. Dates are returned in an ISO 8601 format (YYYY-MM-DD).

maturity_date=(new_value : Time | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] maturity_date Object to be assigned

next_monthly_payment

The amount of the next payment.

next_monthly_payment=(new_value : Float64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] next_monthly_payment Object to be assigned

next_payment_due_date

The due date for the next payment. Dates are returned in an ISO 8601 format (YYYY-MM-DD).

next_payment_due_date=(new_value : Time | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] next_payment_due_date Object to be assigned

origination_date

The date on which the loan was initially lent. Dates are returned in an ISO 8601 format (YYYY-MM-DD).

origination_date=(new_value : Time | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] origination_date Object to be assigned

origination_principal_amount

The original principal balance of the mortgage.

origination_principal_amount=(new_value : Float64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] origination_principal_amount Object to be assigned

past_due_amount

Amount of loan (principal + interest) past due for payment.

past_due_amount=(new_value : Float64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] past_due_amount Object to be assigned

property_address

property_address=(new_value : MortgagePropertyAddress | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] property_address Object to be assigned

valid?

Check to see if the all the properties in the model are valid @return true if the model is valid

ytd_interest_paid

The year to date (YTD) interest paid.

ytd_interest_paid=(new_value : Float64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] ytd_interest_paid Object to be assigned

ytd_principal_paid

The YTD principal paid.

ytd_principal_paid=(new_value : Float64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] ytd_principal_paid Object to be assigned