Struct plaid_openapi::LiabilityOverride

pub struct LiabilityOverride {

    pub type_: String,
    pub purchase_apr: f64,
    pub cash_apr: f64,
    pub balance_transfer_apr: f64,
    pub special_apr: f64,
    pub last_payment_amount: f64,
    pub minimum_payment_amount: f64,
    pub is_overdue: bool,
    pub origination_date: String,
    pub principal: f64,
    pub nominal_apr: f64,
    pub interest_capitalization_grace_period_months: f64,
    pub repayment_model: StudentLoanRepaymentModel,
    pub expected_payoff_date: String,
    pub guarantor: String,
    pub is_federal: bool,
    pub loan_name: String,
    pub loan_status: StudentLoanStatus,
    pub payment_reference_number: String,
    pub pslf_status: PSLFStatus,
    pub repayment_plan_description: String,
    pub repayment_plan_type: String,
    pub sequence_number: String,
    pub servicer_address: Address,
}

Fields

type_: String

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

purchase_apr: f64

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.

cash_apr: f64

The cash APR percentage value. Can only be set if type is credit.

balance_transfer_apr: f64

The balance transfer APR percentage value. Can only be set if type is credit. Can only be set if type is credit.

special_apr: f64

The special APR percentage value. Can only be set if type is credit.

last_payment_amount: f64

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

minimum_payment_amount: f64

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

is_overdue: bool

Override the is_overdue field

origination_date: String

The date on which the loan was initially lent, in ISO 8601 (YYYY-MM-DD) format. Can only be set if type is student.

principal: f64

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

nominal_apr: f64

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

interest_capitalization_grace_period_months: f64

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.

repayment_model: StudentLoanRepaymentModel

Student loan repayment information used to configure Sandbox test data for the Liabilities product

expected_payoff_date: String

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

guarantor: String

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

is_federal: bool

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

loan_name: String

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

payment_reference_number: String

Override the payment_reference_number field. 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).

repayment_plan_description: String

Override the repayment_plan.description field. Can only be set if type is student.

repayment_plan_type: String

Override the repayment_plan.type field. Can only be set if type is student. Possible values are: "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".

sequence_number: String

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

servicer_address: Address

A physical mailing address.

Trait Implementations

impl Debug for LiabilityOverride

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for LiabilityOverride

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Serialize for LiabilityOverride

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.