plaid2.model.paystub module
- class plaid2.model.paystub.Paystub(*, earnings: Earnings, employment_details: Optional[EmploymentDetails] = None, employer: PaystubEmployer, pay_period_details: PayPeriodDetails, net_pay: NetPay, paystub_details: Optional[PaystubDetails] = None, deductions: Deductions, income_breakdown: Optional[List[IncomeBreakdown]] = None, employee: Employee, doc_id: str, ytd_earnings: Optional[PaystubYtdDetails] = None, verification: Optional[PaystubVerification] = None)[source]
Bases:
BaseModel- deductions: Deductions
An object with the deduction information found on a paystub.
- dict(**kwargs: Any) Dict[str, Any][source]
Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict
- doc_id: str
An identifier of the document referenced by the document metadata.
- earnings: Earnings
An object representing both a breakdown of earnings on a paystub and the total earnings.
- employer: PaystubEmployer
Information about the employer on the paystub
- employment_details: Optional[EmploymentDetails]
An object representing employment details found on a paystub.
- income_breakdown: Optional[List[IncomeBreakdown]]
- 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) Paystub[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) Paystub[source]
Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw
- pay_period_details: PayPeriodDetails
Details about the pay period.
- paystub_details: Optional[PaystubDetails]
An object representing details that can be found on the paystub.
- verification: Optional[PaystubVerification]
An object containing details on the paystub’s verification status. This object will only be populated if the [income_verification.access_tokens](/docs/api/tokens/#link-token-create-request-income-verification-access-tokens) parameter was provided during the /link/token/create call or if a problem was detected with the information supplied by the user; otherwise it will be null.
- ytd_earnings: Optional[PaystubYtdDetails]
The amount of income earned year to date, as based on paystub data.