plaid2.model.liability_override module

class plaid2.model.liability_override.LiabilityOverride(*, origination_date: str, loan_name: str, cash_apr: float, interest_capitalization_grace_period_months: float, last_payment_amount: float, pslf_status: PslfStatus, nominal_apr: float, expected_payoff_date: str, purchase_apr: float, is_overdue: bool, servicer_address: Address, type: str, minimum_payment_amount: float, principal: float, payment_reference_number: str, repayment_plan_description: str, repayment_model: StudentLoanRepaymentModel, special_apr: float, sequence_number: str, balance_transfer_apr: float, is_federal: bool, guarantor: str, loan_status: StudentLoanStatus, repayment_plan_type: str)[source]

Bases: BaseModel

balance_transfer_apr: float: The balance transfer APR percentage value. Can only be set if type is credit. Can only be set if type is credit.

cash_apr: float: The cash APR percentage value. Can only be set if type is credit.

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

expected_payoff_date: str: Override the expected_payoff_date field. Can only be set if type is student.

guarantor: str: Override the guarantor field. Can only be set if type is student.

interest_capitalization_grace_period_months: float: If set, interest capitalization begins at the given number of months after loan origination. By default interest is never capitalized. Can only be set if type is student.

is_federal: bool: Override the is_federal field. Can only be set if type is student.

is_overdue: bool: Override the is_overdue field

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

last_payment_amount: float: Override the last_payment_amount field. Can only be set if type is credit.

loan_name: str: Override the loan_name field. Can only be set if type is student.

loan_status: StudentLoanStatus: An object representing the status of the student loan

minimum_payment_amount: float: Override the minimum_payment_amount field. Can only be set if type is credit or student.

nominal_apr: float: The interest rate on the loan as a percentage. Can only be set if type is student.

origination_date: str

//wikipedia.org/wiki/ISO_8601) (YYYY-MM-DD) format. Can only be set if type is student.

Type: The date on which the loan was initially lent, in [ISO 8601](https

classmethod parse_obj(data: Any) → LiabilityOverride[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) → LiabilityOverride[source]: Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

payment_reference_number: str: Override the payment_reference_number field. Can only be set if type is student.

principal: float: The original loan principal. Can only be set if type is student.

pslf_status: PslfStatus: Information about the student’s eligibility in the Public Service Loan Forgiveness program. This is only returned if the institution is Fedloan (ins_116527).

purchase_apr: float: The purchase APR percentage value. For simplicity, this is the only interest rate used to calculate interest charges. Can only be set if type is credit.

repayment_model: StudentLoanRepaymentModel: Student loan repayment information used to configure Sandbox test data for the Liabilities product

repayment_plan_description: str: Override the repayment_plan.description field. Can only be set if type is student.

repayment_plan_type: str

“extended graduated”, “extended standard”, “graduated”, “income-contingent repayment”, “income-based repayment”, “interest only”, “other”, “pay as you earn”, “revised pay as you earn”, or “standard”.

Type: Override the repayment_plan.type field. Can only be set if type is student. Possible values are

sequence_number: str: Override the sequence_number field. Can only be set if type is student.

servicer_address: Address: A physical mailing address.

special_apr: float: The special APR percentage value. Can only be set if type is credit.

type: str: The type of the liability object, either credit or student. Mortgages are not currently supported in the custom Sandbox.