plaid2.model.total module

class plaid2.model.total.Total(*, description: Optional[str] = None, current_pay: Optional[Pay] = None, canonical_description: Optional[str] = None, ytd_pay: Optional[Pay] = None)[source]

Bases: BaseModel

canonical_description: Optional[str]: Commonly used term to describe the line item.

current_pay: Optional[Pay]: An object representing a monetary amount.

description: Optional[str]: Text of the line item as printed on the paystub.

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

ytd_pay: Optional[Pay]: An object representing a monetary amount.