plaid2.model.mortgage_liability module

class plaid2.model.mortgage_liability.MortgageLiability(*, property_address: MortgagePropertyAddress, escrow_balance: Optional[float] = None, has_pmi: Optional[bool] = None, last_payment_amount: Optional[float] = None, loan_term: Optional[str] = None, account_number: str, next_monthly_payment: Optional[float] = None, current_late_fee: Optional[float] = None, next_payment_due_date: Optional[str] = None, last_payment_date: Optional[str] = None, account_id: str, ytd_principal_paid: Optional[float] = None, maturity_date: Optional[str] = None, loan_type_description: Optional[str] = None, has_prepayment_penalty: Optional[bool] = None, origination_date: Optional[str] = None, origination_principal_amount: Optional[float] = None, past_due_amount: Optional[float] = None, interest_rate: MortgageInterestRate, ytd_interest_paid: Optional[float] = None)[source]

Bases: BaseModel

account_id: str: The ID of the account that this liability belongs to.

account_number: str: The account number of the loan.

current_late_fee: Optional[float]: The current outstanding amount charged for late payment.

dict(**kwargs: Any) → Dict[str, Any][source]: Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

escrow_balance: Optional[float]: Total amount held in escrow to pay taxes and insurance on behalf of the borrower.

has_pmi: Optional[bool]: Indicates whether the borrower has private mortgage insurance in effect.

has_prepayment_penalty: Optional[bool]: Indicates whether the borrower will pay a penalty for early payoff of mortgage.

interest_rate: MortgageInterestRate: Object containing metadata about the interest rate for the mortgage.

json(**kwargs: Any) → str[source]: Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

last_payment_amount: Optional[float]: The amount of the last payment.

last_payment_date: Optional[str]

//wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).

Type: The date of the last payment. Dates are returned in an [ISO 8601](https

loan_term: Optional[str]: Full duration of mortgage as at origination (e.g. 10 year).

loan_type_description: Optional[str]: 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.

maturity_date: Optional[str]

//wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).

Type: Original date on which mortgage is due in full. Dates are returned in an [ISO 8601](https

next_monthly_payment: Optional[float]: The amount of the next payment.

next_payment_due_date: Optional[str]

//wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).

Type: The due date for the next payment. Dates are returned in an [ISO 8601](https

origination_date: Optional[str]

//wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).

Type: The date on which the loan was initially lent. Dates are returned in an [ISO 8601](https

origination_principal_amount: Optional[float]: The original principal balance of the mortgage.

classmethod parse_obj(data: Any) → MortgageLiability[source]: Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → MortgageLiability[source]: Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

past_due_amount: Optional[float]: Amount of loan (principal + interest) past due for payment.

property_address: MortgagePropertyAddress: Object containing fields describing property address.

ytd_interest_paid: Optional[float]: The year to date (YTD) interest paid.

ytd_principal_paid: Optional[float]: The YTD principal paid.