plaid2.model.credit_w_2 module
- class plaid2.model.credit_w_2.CreditW2(*, employee: CreditPayStubEmployee, federal_income_tax_withheld: Optional[str] = None, retirement_plan: Optional[str] = None, employer: CreditPayStubEmployer, medicare_wages_and_tips: Optional[str] = None, dependent_care_benefits: Optional[str] = None, social_security_wages: Optional[str] = None, document_id: str, wages_tips_other_comp: Optional[str] = None, box_9: Optional[str] = None, nonqualified_plans: Optional[str] = None, document_metadata: CreditDocumentMetadata, allocated_tips: Optional[str] = None, other: Optional[str] = None, state_and_local_wages: List[W2StateAndLocalWages], box_12: List[W2Box12], social_security_tax_withheld: Optional[str] = None, medicare_tax_withheld: Optional[str] = None, third_party_sick_pay: Optional[str] = None, tax_year: Optional[str] = None, employer_id_number: Optional[str] = None, social_security_tips: Optional[str] = None, statutory_employee: Optional[str] = None)[source]
Bases:
BaseModel- allocated_tips: Optional[str]
Allocated tips.
- box_9: Optional[str]
Contents from box 9 on the W2.
- dependent_care_benefits: Optional[str]
Dependent care benefits.
- dict(**kwargs: Any) Dict[str, Any][source]
Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict
- document_id: str
An identifier of the document referenced by the document metadata.
- document_metadata: CreditDocumentMetadata
Object representing metadata pertaining to the document.
- employee: CreditPayStubEmployee
Data about the employee.
- employer: CreditPayStubEmployer
Information about the employer on the pay stub.
- employer_id_number: Optional[str]
An employee identification number or EIN.
- federal_income_tax_withheld: Optional[str]
Federal income tax withheld for the tax year.
- json(**kwargs: Any) str[source]
Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json
- medicare_tax_withheld: Optional[str]
Medicare tax withheld for the tax year.
- medicare_wages_and_tips: Optional[str]
Wages and tips from medicare.
- nonqualified_plans: Optional[str]
Nonqualified plans.
- other: Optional[str]
Other.
- classmethod parse_obj(data: Any) CreditW2[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) CreditW2[source]
Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw
- retirement_plan: Optional[str]
Retirement plan.
- social_security_tax_withheld: Optional[str]
Social security tax withheld for the tax year.
- social_security_tips: Optional[str]
Tips from social security.
- social_security_wages: Optional[str]
Wages from social security.
- state_and_local_wages: List[W2StateAndLocalWages]
- statutory_employee: Optional[str]
Statutory employee.
- tax_year: Optional[str]
The tax year of the W2 document.
- third_party_sick_pay: Optional[str]
Third party sick pay.
- wages_tips_other_comp: Optional[str]
Wages from tips and other compensation.