plaid2.model.pay_period_details module

class plaid2.model.pay_period_details.PayPeriodDetails(*, start_date: Optional[str] = None, distribution_breakdown: Optional[List[DistributionBreakdown]] = None, end_date: Optional[str] = None, gross_earnings: Optional[float] = None, pay_date: Optional[str] = None, pay_frequency: Optional[str] = None, pay_day: Optional[str] = None, check_amount: Optional[float] = None)[source]

Bases: BaseModel

check_amount: Optional[float]: The amount of the paycheck.

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

distribution_breakdown: Optional[List[DistributionBreakdown]]

end_date: Optional[str]

“yyyy-mm-dd”.

Type: The pay period end date, in [ISO 8601](https
Type: //wikipedia.org/wiki/ISO_8601) format

gross_earnings: Optional[float]: Total earnings before tax/deductions.

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

pay_date: Optional[str]

//wikipedia.org/wiki/ISO_8601) format (“yyyy-mm-dd”).

Type: The date on which the paystub was issued, in [ISO 8601](https

pay_day: Optional[str]

//wikipedia.org/wiki/ISO_8601) format (“yyyy-mm-dd”).

Type: The date on which the paystub was issued, in [ISO 8601](https

pay_frequency: Optional[str]: The frequency at which an individual is paid.

start_date: Optional[str]

“yyyy-mm-dd”.

Type: The pay period start date, in [ISO 8601](https
Type: //wikipedia.org/wiki/ISO_8601) format