plaid2.model.credit_bank_income_historical_summary module

class plaid2.model.credit_bank_income_historical_summary.CreditBankIncomeHistoricalSummary(*, start_date: Optional[str] = None, total_amount: Optional[float] = None, unofficial_currency_code: Optional[str] = None, end_date: Optional[str] = None, transactions: Optional[List[CreditBankIncomeTransaction]] = 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 end date of the period included in this monthly summary. This date will be the last day of the month, unless the month being covered is a partial month because it is the last month included in the summary and the date range being requested does not end with the last day of the month. The date will be returned in an ISO 8601 format (YYYY-MM-DD).

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

start_date: Optional[str]: The start date of the period covered in this monthly summary. This date will be the first day of the month, unless the month being covered is a partial month because it is the first month included in the summary and the date range being requested does not begin with the first day of the month. The date will be returned in an ISO 8601 format (YYYY-MM-DD).

total_amount: Optional[float]: Total amount of earnings for the income source(s) of the user for the month in the summary.

transactions: Optional[List[CreditBankIncomeTransaction]]

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.