com.plaid.client.model

Class InflowModel

java.lang.Object

com.plaid.client.model.InflowModel

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2024-11-14T16:41:31.650700Z[Etc/UTC]")
public class InflowModel
extends Object

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`.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERIALIZED_NAME_INCOME_AMOUNT
static String	SERIALIZED_NAME_PAYMENT_DAY_OF_MONTH
static String	SERIALIZED_NAME_STATEMENT_DAY_OF_MONTH
static String	SERIALIZED_NAME_TRANSACTION_NAME
static String	SERIALIZED_NAME_TYPE

Constructor Summary

Constructors

Constructor and Description
InflowModel()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
Double	getIncomeAmount() Amount of income per month.
Double	getPaymentDayOfMonth() Number between 1 and 28, or `last` meaning the last day of the month.
String	getStatementDayOfMonth() Number between 1 and 28, or `last` meaning the last day of the month.
String	getTransactionName() The name of the income transaction.
String	getType() Inflow model.
int	hashCode()
InflowModel	incomeAmount(Double incomeAmount)
InflowModel	paymentDayOfMonth(Double paymentDayOfMonth)
void	setIncomeAmount(Double incomeAmount)
void	setPaymentDayOfMonth(Double paymentDayOfMonth)
void	setStatementDayOfMonth(String statementDayOfMonth)
void	setTransactionName(String transactionName)
void	setType(String type)
InflowModel	statementDayOfMonth(String statementDayOfMonth)
String	toString()
InflowModel	transactionName(String transactionName)
InflowModel	type(String type)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SERIALIZED_NAME_TYPE

public static final String SERIALIZED_NAME_TYPE

See Also:

Constant Field Values

SERIALIZED_NAME_INCOME_AMOUNT

public static final String SERIALIZED_NAME_INCOME_AMOUNT

See Also:

Constant Field Values

SERIALIZED_NAME_PAYMENT_DAY_OF_MONTH

public static final String SERIALIZED_NAME_PAYMENT_DAY_OF_MONTH

See Also:

Constant Field Values

SERIALIZED_NAME_TRANSACTION_NAME

public static final String SERIALIZED_NAME_TRANSACTION_NAME

See Also:

Constant Field Values

SERIALIZED_NAME_STATEMENT_DAY_OF_MONTH

public static final String SERIALIZED_NAME_STATEMENT_DAY_OF_MONTH

See Also:

Constant Field Values

Constructor Detail

InflowModel

public InflowModel()

Method Detail

type

public InflowModel type(String type)

getType

public String getType()

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`.

Returns:

type

setType

public void setType(String type)

incomeAmount

public InflowModel incomeAmount(Double incomeAmount)

getIncomeAmount

public Double getIncomeAmount()

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

Returns:

incomeAmount

setIncomeAmount

public void setIncomeAmount(Double incomeAmount)

paymentDayOfMonth

public InflowModel paymentDayOfMonth(Double paymentDayOfMonth)

getPaymentDayOfMonth

public Double getPaymentDayOfMonth()

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`.

Returns:

paymentDayOfMonth

setPaymentDayOfMonth

public void setPaymentDayOfMonth(Double paymentDayOfMonth)

transactionName

public InflowModel transactionName(String transactionName)

getTransactionName

public String getTransactionName()

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

Returns:

transactionName

setTransactionName

public void setTransactionName(String transactionName)

statementDayOfMonth

public InflowModel statementDayOfMonth(String statementDayOfMonth)

getStatementDayOfMonth

public String getStatementDayOfMonth()

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`.

Returns:

statementDayOfMonth

setStatementDayOfMonth

public void setStatementDayOfMonth(String statementDayOfMonth)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object