plaid2.model.override_accounts module
- class plaid2.model.override_accounts.OverrideAccounts(*, currency: str, liability: LiabilityOverride, subtype: Optional[str] = None, transactions: List[TransactionOverride], starting_balance: float, investment_transactions: Optional[InvestmentsTransactionsOverride] = None, identity: OwnerOverride, inflow_model: InflowModel, numbers: Numbers, income: Optional[List[PaystubOverride]] = None, meta: Meta, type: str, force_available_balance: float, holdings: Optional[HoldingsOverride] = None)[source]
Bases:
BaseModel- currency: str
ISO-4217 currency code. If provided, the account will be denominated in the given currency. Transactions will also be in this currency by default.
- dict(**kwargs: Any) Dict[str, Any][source]
Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict
- force_available_balance: float
If provided, the account will always have this amount as its available balance, regardless of current balance or changes in transactions over time.
- holdings: Optional[HoldingsOverride]
Specify the holdings on the account.
- identity: OwnerOverride
Data about the owner or owners of an account. Any fields not specified will be filled in with default Sandbox information.
- income: Optional[List[PaystubOverride]]
Specify payroll data on the account.
- inflow_model: InflowModel
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.
- investment_transactions: Optional[InvestmentsTransactionsOverride]
Specify the list of investments transactions on the account.
- json(**kwargs: Any) str[source]
Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json
- liability: LiabilityOverride
Used to configure Sandbox test data for the Liabilities product
- numbers: Numbers
Account and bank identifier number data used to configure the test account. All values are optional.
- classmethod parse_obj(data: Any) OverrideAccounts[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) OverrideAccounts[source]
Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw
- starting_balance: float
If provided, the account will start with this amount as the current balance.
- subtype: Optional[str]
//plaid.com/docs/api/accounts/#account-type-schema) for a full listing of account types and corresponding subtypes.
- Type
See the [Account type schema](https
- transactions: List[TransactionOverride]
Specify the list of transactions on the account.
- type: str
` Investment account.
credit: Credit card
depository: Depository account
loan: Loan account
payroll: Payroll account
other: Non-specified account type
See the [Account type schema](https://plaid.com/docs/api/accounts#account-type-schema) for a full listing of account types and corresponding subtypes.
- Type
`investment