plaid2.model.paystub_details module

class plaid2.model.paystub_details.PaystubDetails(*, paystub_provider: Optional[str] = None, pay_date: Optional[str] = None, pay_period_end_date: Optional[str] = None, pay_period_start_date: Optional[str] = None, pay_frequency: 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

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

pay_date: Optional[str]: Pay date on the paystub in the ‘YYYY-MM-DD’ format.

pay_frequency: Optional[str]

MONTHLY, BI-WEEKLY, WEEKLY, SEMI-MONTHLY.

Type: The frequency at which the employee is paid. Possible values

pay_period_end_date: Optional[str]: Ending date of the pay period on the paystub in the ‘YYYY-MM-DD’ format.

pay_period_start_date: Optional[str]: Beginning date of the pay period on the paystub in the ‘YYYY-MM-DD’ format.

paystub_provider: Optional[str]: The name of the payroll provider that generated the paystub, e.g. ADP