Package com.plaid.client.model

Class InflowModel

java.lang.Object
com.plaid.client.model.InflowModel
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2021-10-15T19:47:39.714Z[GMT]")
public class InflowModel
extends java.lang.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 Details

  • Constructor Details

  • Method Details

    • type

      public InflowModel type​(java.lang.String type)

    • getType

      public java.lang.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 are account type `credit` with subtype `credit` or `paypal`, and account type `loan` with subtype `student` or `mortgage`.
      Returns:
      type

    • setType

      public void setType​(java.lang.String type)

    • incomeAmount

      public InflowModel incomeAmount​(java.lang.Double incomeAmount)

    • getIncomeAmount

      public java.lang.Double getIncomeAmount()
      Amount of income per month. This value is required if `type` is `monthly-income`.
      Returns:
      incomeAmount

    • setIncomeAmount

      public void setIncomeAmount​(java.lang.Double incomeAmount)

    • paymentDayOfMonth

      public InflowModel paymentDayOfMonth​(java.lang.Double paymentDayOfMonth)

    • getPaymentDayOfMonth

      public java.lang.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​(java.lang.Double paymentDayOfMonth)

    • transactionName

      public InflowModel transactionName​(java.lang.String transactionName)

    • getTransactionName

      public java.lang.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​(java.lang.String transactionName)

    • statementDayOfMonth

      public InflowModel statementDayOfMonth​(java.lang.String statementDayOfMonth)

    • getStatementDayOfMonth

      public java.lang.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​(java.lang.String statementDayOfMonth)

    • equals

      public boolean equals​(java.lang.Object o)
      Overrides:
      equals in class java.lang.Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class java.lang.Object

    • toString

      public java.lang.String toString()
      Overrides:
      toString in class java.lang.Object