plaid2.model.credit_bank_income module

class plaid2.model.credit_bank_income.CreditBankIncome(*, items: Optional[List[CreditBankIncomeItem]] = None, bank_income_id: Optional[str] = None, days_requested: Optional[int] = None, generated_time: Optional[str] = None, bank_income_summary: Optional[CreditBankIncomeSummary] = None, warnings: Optional[List[CreditBankIncomeWarning]] = None)

Bases: BaseModel

bank_income_id: Optional[str]

The unique identifier associated with the Bank Income Report.

bank_income_summary: Optional[CreditBankIncomeSummary]

Summary for bank income across all income sources and items (max history of 730 days).

days_requested: Optional[int]

The number of days requested by the customer for the Bank Income Report.

dict(**kwargs: Any) → Dict[str, Any]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

generated_time: Optional[str]

The time when the Bank Income Report was generated.

items: Optional[List[CreditBankIncomeItem]]

The list of Items in the report along with the associated metadata about the Item.

json(**kwargs: Any) → str

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → CreditBankIncome

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → CreditBankIncome

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

warnings: Optional[List[CreditBankIncomeWarning]]

If data from the Bank Income report was unable to be retrieved, the warnings will contain information about the error that caused the data to be incomplete.