plaid2.model.credit_bank_income_source module

class plaid2.model.credit_bank_income_source.CreditBankIncomeSource(*, total_amount: Optional[float] = None, income_category: Optional[str] = None, start_date: Optional[str] = None, end_date: Optional[str] = None, income_source_id: Optional[str] = None, historical_summary: Optional[List[CreditBankIncomeHistoricalSummary]] = None, transaction_count: Optional[int] = None, pay_frequency: Optional[str] = None, account_id: Optional[str] = None, income_description: Optional[str] = None)[source]

Bases: BaseModel

account_id: Optional[str]: Plaid’s unique idenfier for the account.

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]: Maximum of all dates within the specific income sources in the user’s bank account for days requested by the client. The date will be returned in an ISO 8601 format (YYYY-MM-DD).

historical_summary: Optional[List[CreditBankIncomeHistoricalSummary]]

income_category: Optional[str]: The income category.

income_description: Optional[str]: The most common name or original description for the underlying income transactions.

income_source_id: Optional[str]: A unique identifier for an income source.

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

pay_frequency: Optional[str]: The income pay frequency.

start_date: Optional[str]: Minimum of all dates within the specific income sources in the user’s bank account for days requested by the client. The date will be returned in an ISO 8601 format (YYYY-MM-DD).

total_amount: Optional[float]: Total amount of earnings in the user’s bank account for the specific income source for days requested by the client.

transaction_count: Optional[int]: Number of transactions for the income source within the start and end date.