Package com.plaid.client.model

Class MortgageLiability

java.lang.Object
com.plaid.client.model.MortgageLiability
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2021-08-13T23:02:46.991Z[GMT]")
public class MortgageLiability
extends java.lang.Object
Contains details about a mortgage account.

  • Field Details

    • SERIALIZED_NAME_ACCOUNT_ID

      public static final java.lang.String SERIALIZED_NAME_ACCOUNT_ID
      See Also:
      Constant Field Values

    • SERIALIZED_NAME_ACCOUNT_NUMBER

      public static final java.lang.String SERIALIZED_NAME_ACCOUNT_NUMBER
      See Also:
      Constant Field Values

    • SERIALIZED_NAME_CURRENT_LATE_FEE

      public static final java.lang.String SERIALIZED_NAME_CURRENT_LATE_FEE
      See Also:
      Constant Field Values

    • SERIALIZED_NAME_ESCROW_BALANCE

      public static final java.lang.String SERIALIZED_NAME_ESCROW_BALANCE
      See Also:
      Constant Field Values

    • SERIALIZED_NAME_HAS_PMI

      public static final java.lang.String SERIALIZED_NAME_HAS_PMI
      See Also:
      Constant Field Values

    • SERIALIZED_NAME_HAS_PREPAYMENT_PENALTY

      public static final java.lang.String SERIALIZED_NAME_HAS_PREPAYMENT_PENALTY
      See Also:
      Constant Field Values

    • SERIALIZED_NAME_INTEREST_RATE

      public static final java.lang.String SERIALIZED_NAME_INTEREST_RATE
      See Also:
      Constant Field Values

    • SERIALIZED_NAME_LAST_PAYMENT_AMOUNT

      public static final java.lang.String SERIALIZED_NAME_LAST_PAYMENT_AMOUNT
      See Also:
      Constant Field Values

    • SERIALIZED_NAME_LAST_PAYMENT_DATE

      public static final java.lang.String SERIALIZED_NAME_LAST_PAYMENT_DATE
      See Also:
      Constant Field Values

    • SERIALIZED_NAME_LOAN_TYPE_DESCRIPTION

      public static final java.lang.String SERIALIZED_NAME_LOAN_TYPE_DESCRIPTION
      See Also:
      Constant Field Values

    • SERIALIZED_NAME_LOAN_TERM

      public static final java.lang.String SERIALIZED_NAME_LOAN_TERM
      See Also:
      Constant Field Values

    • SERIALIZED_NAME_MATURITY_DATE

      public static final java.lang.String SERIALIZED_NAME_MATURITY_DATE
      See Also:
      Constant Field Values

    • SERIALIZED_NAME_NEXT_MONTHLY_PAYMENT

      public static final java.lang.String SERIALIZED_NAME_NEXT_MONTHLY_PAYMENT
      See Also:
      Constant Field Values

    • SERIALIZED_NAME_NEXT_PAYMENT_DUE_DATE

      public static final java.lang.String SERIALIZED_NAME_NEXT_PAYMENT_DUE_DATE
      See Also:
      Constant Field Values

    • SERIALIZED_NAME_ORIGINATION_DATE

      public static final java.lang.String SERIALIZED_NAME_ORIGINATION_DATE
      See Also:
      Constant Field Values

    • SERIALIZED_NAME_ORIGINATION_PRINCIPAL_AMOUNT

      public static final java.lang.String SERIALIZED_NAME_ORIGINATION_PRINCIPAL_AMOUNT
      See Also:
      Constant Field Values

    • SERIALIZED_NAME_PAST_DUE_AMOUNT

      public static final java.lang.String SERIALIZED_NAME_PAST_DUE_AMOUNT
      See Also:
      Constant Field Values

    • SERIALIZED_NAME_PROPERTY_ADDRESS

      public static final java.lang.String SERIALIZED_NAME_PROPERTY_ADDRESS
      See Also:
      Constant Field Values

    • SERIALIZED_NAME_YTD_INTEREST_PAID

      public static final java.lang.String SERIALIZED_NAME_YTD_INTEREST_PAID
      See Also:
      Constant Field Values

    • SERIALIZED_NAME_YTD_PRINCIPAL_PAID

      public static final java.lang.String SERIALIZED_NAME_YTD_PRINCIPAL_PAID
      See Also:
      Constant Field Values

  • Constructor Details

    • MortgageLiability

      public MortgageLiability()

  • Method Details

    • accountId

      public MortgageLiability accountId​(java.lang.String accountId)

    • getAccountId

      public java.lang.String getAccountId()
      The ID of the account that this liability belongs to.
      Returns:
      accountId

    • setAccountId

      public void setAccountId​(java.lang.String accountId)

    • accountNumber

      public MortgageLiability accountNumber​(java.lang.String accountNumber)

    • getAccountNumber

      public java.lang.String getAccountNumber()
      The account number of the loan.
      Returns:
      accountNumber

    • setAccountNumber

      public void setAccountNumber​(java.lang.String accountNumber)

    • currentLateFee

      public MortgageLiability currentLateFee​(java.lang.Double currentLateFee)

    • getCurrentLateFee

      @Nullable public java.lang.Double getCurrentLateFee()
      The current outstanding amount charged for late payment.
      Returns:
      currentLateFee

    • setCurrentLateFee

      public void setCurrentLateFee​(java.lang.Double currentLateFee)

    • escrowBalance

      public MortgageLiability escrowBalance​(java.lang.Double escrowBalance)

    • getEscrowBalance

      @Nullable public java.lang.Double getEscrowBalance()
      Total amount held in escrow to pay taxes and insurance on behalf of the borrower.
      Returns:
      escrowBalance

    • setEscrowBalance

      public void setEscrowBalance​(java.lang.Double escrowBalance)

    • hasPmi

      public MortgageLiability hasPmi​(java.lang.Boolean hasPmi)

    • getHasPmi

      @Nullable public java.lang.Boolean getHasPmi()
      Indicates whether the borrower has private mortgage insurance in effect.
      Returns:
      hasPmi

    • setHasPmi

      public void setHasPmi​(java.lang.Boolean hasPmi)

    • hasPrepaymentPenalty

      public MortgageLiability hasPrepaymentPenalty​(java.lang.Boolean hasPrepaymentPenalty)

    • getHasPrepaymentPenalty

      @Nullable public java.lang.Boolean getHasPrepaymentPenalty()
      Indicates whether the borrower will pay a penalty for early payoff of mortgage.
      Returns:
      hasPrepaymentPenalty

    • setHasPrepaymentPenalty

      public void setHasPrepaymentPenalty​(java.lang.Boolean hasPrepaymentPenalty)

    • interestRate

      public MortgageLiability interestRate​(MortgageInterestRate interestRate)

    • getInterestRate

      public MortgageInterestRate getInterestRate()
      Get interestRate
      Returns:
      interestRate

    • setInterestRate

      public void setInterestRate​(MortgageInterestRate interestRate)

    • lastPaymentAmount

      public MortgageLiability lastPaymentAmount​(java.lang.Double lastPaymentAmount)

    • getLastPaymentAmount

      @Nullable public java.lang.Double getLastPaymentAmount()
      The amount of the last payment.
      Returns:
      lastPaymentAmount

    • setLastPaymentAmount

      public void setLastPaymentAmount​(java.lang.Double lastPaymentAmount)

    • lastPaymentDate

      public MortgageLiability lastPaymentDate​(java.time.LocalDate lastPaymentDate)

    • getLastPaymentDate

      @Nullable public java.time.LocalDate getLastPaymentDate()
      The date of the last payment. Dates are returned in an ISO 8601 format (YYYY-MM-DD).
      Returns:
      lastPaymentDate

    • setLastPaymentDate

      public void setLastPaymentDate​(java.time.LocalDate lastPaymentDate)

    • loanTypeDescription

      public MortgageLiability loanTypeDescription​(java.lang.String loanTypeDescription)

    • getLoanTypeDescription

      @Nullable public java.lang.String getLoanTypeDescription()
      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.
      Returns:
      loanTypeDescription

    • setLoanTypeDescription

      public void setLoanTypeDescription​(java.lang.String loanTypeDescription)

    • loanTerm

      public MortgageLiability loanTerm​(java.lang.String loanTerm)

    • getLoanTerm

      @Nullable public java.lang.String getLoanTerm()
      Full duration of mortgage as at origination (e.g. `10 year`).
      Returns:
      loanTerm

    • setLoanTerm

      public void setLoanTerm​(java.lang.String loanTerm)

    • maturityDate

      public MortgageLiability maturityDate​(java.time.LocalDate maturityDate)

    • getMaturityDate

      @Nullable public java.time.LocalDate getMaturityDate()
      Original date on which mortgage is due in full. Dates are returned in an ISO 8601 format (YYYY-MM-DD).
      Returns:
      maturityDate

    • setMaturityDate

      public void setMaturityDate​(java.time.LocalDate maturityDate)

    • nextMonthlyPayment

      public MortgageLiability nextMonthlyPayment​(java.lang.Double nextMonthlyPayment)

    • getNextMonthlyPayment

      @Nullable public java.lang.Double getNextMonthlyPayment()
      The amount of the next payment.
      Returns:
      nextMonthlyPayment

    • setNextMonthlyPayment

      public void setNextMonthlyPayment​(java.lang.Double nextMonthlyPayment)

    • nextPaymentDueDate

      public MortgageLiability nextPaymentDueDate​(java.time.LocalDate nextPaymentDueDate)

    • getNextPaymentDueDate

      @Nullable public java.time.LocalDate getNextPaymentDueDate()
      The due date for the next payment. Dates are returned in an ISO 8601 format (YYYY-MM-DD).
      Returns:
      nextPaymentDueDate

    • setNextPaymentDueDate

      public void setNextPaymentDueDate​(java.time.LocalDate nextPaymentDueDate)

    • originationDate

      public MortgageLiability originationDate​(java.time.LocalDate originationDate)

    • getOriginationDate

      @Nullable public java.time.LocalDate getOriginationDate()
      The date on which the loan was initially lent. Dates are returned in an ISO 8601 format (YYYY-MM-DD).
      Returns:
      originationDate

    • setOriginationDate

      public void setOriginationDate​(java.time.LocalDate originationDate)

    • originationPrincipalAmount

      public MortgageLiability originationPrincipalAmount​(java.lang.Double originationPrincipalAmount)

    • getOriginationPrincipalAmount

      @Nullable public java.lang.Double getOriginationPrincipalAmount()
      The original principal balance of the mortgage.
      Returns:
      originationPrincipalAmount

    • setOriginationPrincipalAmount

      public void setOriginationPrincipalAmount​(java.lang.Double originationPrincipalAmount)

    • pastDueAmount

      public MortgageLiability pastDueAmount​(java.lang.Double pastDueAmount)

    • getPastDueAmount

      @Nullable public java.lang.Double getPastDueAmount()
      Amount of loan (principal + interest) past due for payment.
      Returns:
      pastDueAmount

    • setPastDueAmount

      public void setPastDueAmount​(java.lang.Double pastDueAmount)

    • propertyAddress

      public MortgageLiability propertyAddress​(MortgagePropertyAddress propertyAddress)

    • getPropertyAddress

      public MortgagePropertyAddress getPropertyAddress()
      Get propertyAddress
      Returns:
      propertyAddress

    • setPropertyAddress

      public void setPropertyAddress​(MortgagePropertyAddress propertyAddress)

    • ytdInterestPaid

      public MortgageLiability ytdInterestPaid​(java.lang.Double ytdInterestPaid)

    • getYtdInterestPaid

      @Nullable public java.lang.Double getYtdInterestPaid()
      The year to date (YTD) interest paid.
      Returns:
      ytdInterestPaid

    • setYtdInterestPaid

      public void setYtdInterestPaid​(java.lang.Double ytdInterestPaid)

    • ytdPrincipalPaid

      public MortgageLiability ytdPrincipalPaid​(java.lang.Double ytdPrincipalPaid)

    • getYtdPrincipalPaid

      @Nullable public java.lang.Double getYtdPrincipalPaid()
      The YTD principal paid.
      Returns:
      ytdPrincipalPaid

    • setYtdPrincipalPaid

      public void setYtdPrincipalPaid​(java.lang.Double ytdPrincipalPaid)

    • equals

      public boolean equals​(java.lang.Object o)
      Overrides:
      equals in class java.lang.Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class java.lang.Object

    • toString

      public java.lang.String toString()
      Overrides:
      toString in class java.lang.Object