plaid2.model.income_breakdown module

class plaid2.model.income_breakdown.IncomeBreakdown(*, type: Optional[str] = None, hours: Optional[float] = None, rate: Optional[float] = None, total: Optional[float] = 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

hours: Optional[float]: The number of hours logged for this income for this pay period.

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

rate: Optional[float]: The hourly rate at which the income is paid.

total: Optional[float]: The total pay for this pay period.

type: Optional[str]: The type of income. Possible values include: “regular”: regular income “overtime”: overtime income “bonus”: bonus income