plaid2.model.link_token_create_request_user_stated_income_source module
- class plaid2.model.link_token_create_request_user_stated_income_source.LinkTokenCreateRequestUserStatedIncomeSource(*, employer: Optional[str] = None, pay_per_cycle: Optional[float] = None, category: Optional[str] = None, pay_frequency: Optional[str] = None, pay_annual: Optional[float] = None, pay_type: Optional[str] = None)[source]
Bases:
BaseModel- category: Optional[str]
The income category for a specified income source
- dict(**kwargs: Any) Dict[str, Any][source]
Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict
- employer: Optional[str]
The employer corresponding to an income source specified by the user
- 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) LinkTokenCreateRequestUserStatedIncomeSource[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) LinkTokenCreateRequestUserStatedIncomeSource[source]
Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw
- pay_annual: Optional[float]
The income amount paid annually for a specified income source
- pay_frequency: Optional[str]
The pay frequency of a specified income source
- pay_per_cycle: Optional[float]
The income amount paid per cycle for a specified income source
- pay_type: Optional[str]
The pay type - GROSS, NET, or UNKNOWN for a specified income source