plaid2.model.credit_pay_stub module
- class plaid2.model.credit_pay_stub.CreditPayStub(*, employee: CreditPayStubEmployee, deductions: CreditPayStubDeductions, employer: CreditPayStubEmployer, document_id: Optional[str] = None, document_metadata: CreditDocumentMetadata, pay_period_details: PayStubPayPeriodDetails, net_pay: CreditPayStubNetPay, verification: Optional[CreditPayStubVerification] = None, earnings: CreditPayStubEarnings)[source]
Bases:
BaseModel- deductions: CreditPayStubDeductions
An object with the deduction information found on a pay stub.
- dict(**kwargs: Any) Dict[str, Any][source]
Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict
- document_id: Optional[str]
An identifier of the document referenced by the document metadata.
- document_metadata: CreditDocumentMetadata
Object representing metadata pertaining to the document.
- earnings: CreditPayStubEarnings
An object representing both a breakdown of earnings on a pay stub and the total earnings.
- employee: CreditPayStubEmployee
Data about the employee.
- employer: CreditPayStubEmployer
Information about the employer on the pay stub.
- json(**kwargs: Any) str[source]
Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json
- net_pay: CreditPayStubNetPay
An object representing information about the net pay amount on the pay stub.
- classmethod parse_obj(data: Any) CreditPayStub[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) CreditPayStub[source]
Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw
- pay_period_details: PayStubPayPeriodDetails
Details about the pay period.
- verification: Optional[CreditPayStubVerification]
(To be deprecated) Verification info will be moved to a separate endpoint in the future. 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.