plaid2.model.earnings module

class plaid2.model.earnings.Earnings(*, subtotals: Optional[List[EarningsTotal]] = None, total: Optional[EarningsTotal] = None, totals: Optional[List[EarningsTotal]] = None, breakdown: Optional[List[EarningsBreakdown]] = None)[source]

Bases: BaseModel

breakdown: Optional[List[EarningsBreakdown]]

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

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

subtotals: Optional[List[EarningsTotal]]

total: Optional[EarningsTotal]: An object representing both the current pay period and year to date amount for an earning category.

totals: Optional[List[EarningsTotal]]