plaid2.model.credit_bank_income_summary module

class plaid2.model.credit_bank_income_summary.CreditBankIncomeSummary(*, income_sources_count: Optional[int] = None, unofficial_currency_code: Optional[str] = None, start_date: Optional[str] = None, end_date: Optional[str] = None, income_categories_count: Optional[int] = None, total_amount: Optional[float] = None, income_transactions_count: Optional[int] = None, historical_summary: Optional[List[CreditBankIncomeHistoricalSummary]] = None, iso_currency_code: Optional[str] = None)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]: Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

end_date: Optional[str]: The latest date in which all income sources identified by Plaid appear in the user’s account. The date will be returned in an ISO 8601 format (YYYY-MM-DD).

historical_summary: Optional[List[CreditBankIncomeHistoricalSummary]]

income_categories_count: Optional[int]: Number of income categories per end user.

income_sources_count: Optional[int]: Number of income sources per end user.

income_transactions_count: Optional[int]: Number of income transactions per end user.

iso_currency_code: Optional[str]: The ISO 4217 currency code of the amount or balance.

json(**kwargs: Any) → str[source]: Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → CreditBankIncomeSummary[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) → CreditBankIncomeSummary[source]: Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

start_date: Optional[str]: The earliest date within the days requested in which all income sources identified by Plaid appear in a user’s account. The date will be returned in an ISO 8601 format (YYYY-MM-DD).

total_amount: Optional[float]: Total amount of earnings across all the income sources in the end user’s Items for the days requested by the client.

unofficial_currency_code: Optional[str]: The unofficial currency code associated with the amount or balance. Always null if iso_currency_code is non-null. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries.