Struct plaid::model::InflowModel

pub struct InflowModel {
    pub income_amount: f64,
    pub payment_day_of_month: f64,
    pub statement_day_of_month: String,
    pub transaction_name: String,
    pub type_: String,
}

The inflow_model allows you to model a test account that receives regular income or make regular payments on a loan. Any transactions generated by the inflow_model will appear in addition to randomly generated test data or transactions specified by override_accounts.

Fields

income_amount: f64

Amount of income per month. This value is required if type is monthly-income.

payment_day_of_month: f64

Number between 1 and 28, or last meaning the last day of the month. The day of the month on which the income transaction will appear. The name of the income transaction. This field is required if type is monthly-income, monthly-balance-payment or monthly-interest-only-payment.

statement_day_of_month: String

Number between 1 and 28, or last meaning the last day of the month. The day of the month on which the balance is calculated for the next payment. The name of the income transaction. This field is required if type is monthly-balance-payment or monthly-interest-only-payment.

transaction_name: String

The name of the income transaction. This field is required if type is monthly-income, monthly-balance-payment or monthly-interest-only-payment.

type_: String

Inflow model. One of the following:

none: No income

monthly-income: Income occurs once per month monthly-balance-payment: Pays off the balance on a liability account at the given statement day of month.

monthly-interest-only-payment: Makes an interest-only payment on a liability account at the given statement day of month.

Note that account types supported by Liabilities will accrue interest in the Sandbox. The types impacted are account type credit with subtype credit or paypal, and account type loan with subtype student or mortgage.

Trait Implementations

impl Clone for InflowModel

fn clone(&self) -> InflowModel

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for InflowModel

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

Formats the value using the given formatter.

impl Default for InflowModel

fn default() -> InflowModel

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for InflowModel

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for InflowModel

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

Formats the value using the given formatter.

impl Serialize for InflowModel

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

where __S: Serializer,

Serialize this value into the given Serde serializer.