java.lang.Object

com.plaid.client.model.W2

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2021-10-15T19:47:39.714Z[GMT]")
public class W2
extends java.lang.Object

W2 is an object that represents income data taken from a W2 tax document.

Field Summary

Fields
Modifier and Type	Field	Description
`static java.lang.String`	`SERIALIZED_NAME_ALLOCATED_TIPS`
`static java.lang.String`	`SERIALIZED_NAME_BOX12`
`static java.lang.String`	`SERIALIZED_NAME_BOX9`
`static java.lang.String`	`SERIALIZED_NAME_DEPENDENT_CARE_BENEFITS`
`static java.lang.String`	`SERIALIZED_NAME_EMPLOYEE`
`static java.lang.String`	`SERIALIZED_NAME_EMPLOYER`
`static java.lang.String`	`SERIALIZED_NAME_EMPLOYER_ID_NUMBER`
`static java.lang.String`	`SERIALIZED_NAME_FEDERAL_INCOME_TAX_WITHHELD`
`static java.lang.String`	`SERIALIZED_NAME_MEDICARE_TAX_WITHHELD`
`static java.lang.String`	`SERIALIZED_NAME_MEDICARE_WAGES_AND_TIPS`
`static java.lang.String`	`SERIALIZED_NAME_NONQUALIFIED_PLANS`
`static java.lang.String`	`SERIALIZED_NAME_OTHER`
`static java.lang.String`	`SERIALIZED_NAME_RETIREMENT_PLAN`
`static java.lang.String`	`SERIALIZED_NAME_SOCIAL_SECURITY_TAX_WITHHELD`
`static java.lang.String`	`SERIALIZED_NAME_SOCIAL_SECURITY_TIPS`
`static java.lang.String`	`SERIALIZED_NAME_SOCIAL_SECURITY_WAGES`
`static java.lang.String`	`SERIALIZED_NAME_STATE_AND_LOCAL_WAGES`
`static java.lang.String`	`SERIALIZED_NAME_STATUTORY_EMPLOYEE`
`static java.lang.String`	`SERIALIZED_NAME_TAX_YEAR`
`static java.lang.String`	`SERIALIZED_NAME_THIRD_PARTY_SICK_PAY`
`static java.lang.String`	`SERIALIZED_NAME_WAGES_TIPS_OTHER_COMP`

Constructor Summary

Constructors

Constructor Description

W2()

Method Summary

Modifier and Type	Method	Description
`W2`	`addBox12Item(W2Box12 box12Item)`
`W2`	`addStateAndLocalWagesItem(W2StateAndLocalWages stateAndLocalWagesItem)`
`W2`	`allocatedTips(java.lang.String allocatedTips)`
`W2`	`box12(java.util.List<W2Box12> box12)`
`W2`	`box9(java.lang.String box9)`
`W2`	`dependentCareBenefits(java.lang.String dependentCareBenefits)`
`W2`	`employee(Employee employee)`
`W2`	`employer(PaystubEmployer employer)`
`W2`	`employerIdNumber(java.lang.String employerIdNumber)`
`boolean`	`equals(java.lang.Object o)`
`W2`	`federalIncomeTaxWithheld(java.lang.String federalIncomeTaxWithheld)`
`java.lang.String`	`getAllocatedTips()`	Allocated tips.
`java.util.List<W2Box12>`	`getBox12()`	Get box12
`java.lang.String`	`getBox9()`	Contents from box 9 on the W2.
`java.lang.String`	`getDependentCareBenefits()`	Dependent care benefits.
`Employee`	`getEmployee()`	Get employee
`PaystubEmployer`	`getEmployer()`	Get employer
`java.lang.String`	`getEmployerIdNumber()`	An employee identification number or EIN.
`java.lang.String`	`getFederalIncomeTaxWithheld()`	Federal income tax withheld for the tax year.
`java.lang.String`	`getMedicareTaxWithheld()`	Medicare tax withheld for the tax year.
`java.lang.String`	`getMedicareWagesAndTips()`	Wages and tips from medicare.
`java.lang.String`	`getNonqualifiedPlans()`	Nonqualified plans.
`java.lang.String`	`getOther()`	Other.
`java.lang.String`	`getRetirementPlan()`	Retirement plan.
`java.lang.String`	`getSocialSecurityTaxWithheld()`	Social security tax withheld for the tax year.
`java.lang.String`	`getSocialSecurityTips()`	Tips from social security.
`java.lang.String`	`getSocialSecurityWages()`	Wages from social security.
`java.util.List<W2StateAndLocalWages>`	`getStateAndLocalWages()`	Get stateAndLocalWages
`java.lang.String`	`getStatutoryEmployee()`	Statutory employee.
`java.lang.String`	`getTaxYear()`	The tax year of the W2 document.
`java.lang.String`	`getThirdPartySickPay()`	Third party sick pay.
`java.lang.String`	`getWagesTipsOtherComp()`	Wages from tips and other compensation.
`int`	`hashCode()`
`W2`	`medicareTaxWithheld(java.lang.String medicareTaxWithheld)`
`W2`	`medicareWagesAndTips(java.lang.String medicareWagesAndTips)`
`W2`	`nonqualifiedPlans(java.lang.String nonqualifiedPlans)`
`W2`	`other(java.lang.String other)`
`W2`	`retirementPlan(java.lang.String retirementPlan)`
`void`	`setAllocatedTips(java.lang.String allocatedTips)`
`void`	`setBox12(java.util.List<W2Box12> box12)`
`void`	`setBox9(java.lang.String box9)`
`void`	`setDependentCareBenefits(java.lang.String dependentCareBenefits)`
`void`	`setEmployee(Employee employee)`
`void`	`setEmployer(PaystubEmployer employer)`
`void`	`setEmployerIdNumber(java.lang.String employerIdNumber)`
`void`	`setFederalIncomeTaxWithheld(java.lang.String federalIncomeTaxWithheld)`
`void`	`setMedicareTaxWithheld(java.lang.String medicareTaxWithheld)`
`void`	`setMedicareWagesAndTips(java.lang.String medicareWagesAndTips)`
`void`	`setNonqualifiedPlans(java.lang.String nonqualifiedPlans)`
`void`	`setOther(java.lang.String other)`
`void`	`setRetirementPlan(java.lang.String retirementPlan)`
`void`	`setSocialSecurityTaxWithheld(java.lang.String socialSecurityTaxWithheld)`
`void`	`setSocialSecurityTips(java.lang.String socialSecurityTips)`
`void`	`setSocialSecurityWages(java.lang.String socialSecurityWages)`
`void`	`setStateAndLocalWages(java.util.List<W2StateAndLocalWages> stateAndLocalWages)`
`void`	`setStatutoryEmployee(java.lang.String statutoryEmployee)`
`void`	`setTaxYear(java.lang.String taxYear)`
`void`	`setThirdPartySickPay(java.lang.String thirdPartySickPay)`
`void`	`setWagesTipsOtherComp(java.lang.String wagesTipsOtherComp)`
`W2`	`socialSecurityTaxWithheld(java.lang.String socialSecurityTaxWithheld)`
`W2`	`socialSecurityTips(java.lang.String socialSecurityTips)`
`W2`	`socialSecurityWages(java.lang.String socialSecurityWages)`
`W2`	`stateAndLocalWages(java.util.List<W2StateAndLocalWages> stateAndLocalWages)`
`W2`	`statutoryEmployee(java.lang.String statutoryEmployee)`
`W2`	`taxYear(java.lang.String taxYear)`
`W2`	`thirdPartySickPay(java.lang.String thirdPartySickPay)`
`java.lang.String`	`toString()`
`W2`	`wagesTipsOtherComp(java.lang.String wagesTipsOtherComp)`

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details
- SERIALIZED_NAME_EMPLOYER
  
  public static final java.lang.String SERIALIZED_NAME_EMPLOYER
  
  See Also:
  
  Constant Field Values
- SERIALIZED_NAME_EMPLOYEE
  
  public static final java.lang.String SERIALIZED_NAME_EMPLOYEE
  
  See Also:
  
  Constant Field Values
- SERIALIZED_NAME_TAX_YEAR
  
  public static final java.lang.String SERIALIZED_NAME_TAX_YEAR
  
  See Also:
  
  Constant Field Values
- SERIALIZED_NAME_EMPLOYER_ID_NUMBER
  
  public static final java.lang.String SERIALIZED_NAME_EMPLOYER_ID_NUMBER
  
  See Also:
  
  Constant Field Values
- SERIALIZED_NAME_WAGES_TIPS_OTHER_COMP
  
  public static final java.lang.String SERIALIZED_NAME_WAGES_TIPS_OTHER_COMP
  
  See Also:
  
  Constant Field Values
- SERIALIZED_NAME_FEDERAL_INCOME_TAX_WITHHELD
  
  public static final java.lang.String SERIALIZED_NAME_FEDERAL_INCOME_TAX_WITHHELD
  
  See Also:
  
  Constant Field Values
- SERIALIZED_NAME_SOCIAL_SECURITY_WAGES
  
  public static final java.lang.String SERIALIZED_NAME_SOCIAL_SECURITY_WAGES
  
  See Also:
  
  Constant Field Values
- SERIALIZED_NAME_SOCIAL_SECURITY_TAX_WITHHELD
  
  public static final java.lang.String SERIALIZED_NAME_SOCIAL_SECURITY_TAX_WITHHELD
  
  See Also:
  
  Constant Field Values
- SERIALIZED_NAME_MEDICARE_WAGES_AND_TIPS
  
  public static final java.lang.String SERIALIZED_NAME_MEDICARE_WAGES_AND_TIPS
  
  See Also:
  
  Constant Field Values
- SERIALIZED_NAME_MEDICARE_TAX_WITHHELD
  
  public static final java.lang.String SERIALIZED_NAME_MEDICARE_TAX_WITHHELD
  
  See Also:
  
  Constant Field Values
- SERIALIZED_NAME_SOCIAL_SECURITY_TIPS
  
  public static final java.lang.String SERIALIZED_NAME_SOCIAL_SECURITY_TIPS
  
  See Also:
  
  Constant Field Values
- SERIALIZED_NAME_ALLOCATED_TIPS
  
  public static final java.lang.String SERIALIZED_NAME_ALLOCATED_TIPS
  
  See Also:
  
  Constant Field Values
- SERIALIZED_NAME_BOX9
  
  public static final java.lang.String SERIALIZED_NAME_BOX9
  
  See Also:
  
  Constant Field Values
- SERIALIZED_NAME_DEPENDENT_CARE_BENEFITS
  
  public static final java.lang.String SERIALIZED_NAME_DEPENDENT_CARE_BENEFITS
  
  See Also:
  
  Constant Field Values
- SERIALIZED_NAME_NONQUALIFIED_PLANS
  
  public static final java.lang.String SERIALIZED_NAME_NONQUALIFIED_PLANS
  
  See Also:
  
  Constant Field Values
- SERIALIZED_NAME_BOX12
  
  public static final java.lang.String SERIALIZED_NAME_BOX12
  
  See Also:
  
  Constant Field Values
- SERIALIZED_NAME_STATUTORY_EMPLOYEE
  
  public static final java.lang.String SERIALIZED_NAME_STATUTORY_EMPLOYEE
  
  See Also:
  
  Constant Field Values
- SERIALIZED_NAME_RETIREMENT_PLAN
  
  public static final java.lang.String SERIALIZED_NAME_RETIREMENT_PLAN
  
  See Also:
  
  Constant Field Values
- SERIALIZED_NAME_THIRD_PARTY_SICK_PAY
  
  public static final java.lang.String SERIALIZED_NAME_THIRD_PARTY_SICK_PAY
  
  See Also:
  
  Constant Field Values
- SERIALIZED_NAME_OTHER
  
  public static final java.lang.String SERIALIZED_NAME_OTHER
  
  See Also:
  
  Constant Field Values
- SERIALIZED_NAME_STATE_AND_LOCAL_WAGES
  
  public static final java.lang.String SERIALIZED_NAME_STATE_AND_LOCAL_WAGES
  
  See Also:
  
  Constant Field Values
Constructor Details
- W2
  
  public W2()
Method Details
- employer
  
  public W2 employer(PaystubEmployer employer)
- getEmployer
  
  @Nullable public PaystubEmployer getEmployer()
  
  Get employer
  
  Returns:
  
  employer
- setEmployer
  
  public void setEmployer(PaystubEmployer employer)
- employee
  
  public W2 employee(Employee employee)
- getEmployee
  
  @Nullable public Employee getEmployee()
  
  Get employee
  
  Returns:
  
  employee
- setEmployee
  
  public void setEmployee(Employee employee)
- taxYear
  
  public W2 taxYear(java.lang.String taxYear)
- getTaxYear
  
  @Nullable public java.lang.String getTaxYear()
  
  The tax year of the W2 document.
  
  Returns:
  
  taxYear
- setTaxYear
  
  public void setTaxYear(java.lang.String taxYear)
- employerIdNumber
  
  public W2 employerIdNumber(java.lang.String employerIdNumber)
- getEmployerIdNumber
  
  @Nullable public java.lang.String getEmployerIdNumber()
  
  An employee identification number or EIN.
  
  Returns:
  
  employerIdNumber
- setEmployerIdNumber
  
  public void setEmployerIdNumber(java.lang.String employerIdNumber)
- wagesTipsOtherComp
  
  public W2 wagesTipsOtherComp(java.lang.String wagesTipsOtherComp)
- getWagesTipsOtherComp
  
  @Nullable public java.lang.String getWagesTipsOtherComp()
  
  Wages from tips and other compensation.
  
  Returns:
  
  wagesTipsOtherComp
- setWagesTipsOtherComp
  
  public void setWagesTipsOtherComp(java.lang.String wagesTipsOtherComp)
- federalIncomeTaxWithheld
  
  public W2 federalIncomeTaxWithheld(java.lang.String federalIncomeTaxWithheld)
- getFederalIncomeTaxWithheld
  
  @Nullable public java.lang.String getFederalIncomeTaxWithheld()
  
  Federal income tax withheld for the tax year.
  
  Returns:
  
  federalIncomeTaxWithheld
- setFederalIncomeTaxWithheld
  
  public void setFederalIncomeTaxWithheld(java.lang.String federalIncomeTaxWithheld)
- socialSecurityWages
  
  public W2 socialSecurityWages(java.lang.String socialSecurityWages)
- getSocialSecurityWages
  
  @Nullable public java.lang.String getSocialSecurityWages()
  
  Wages from social security.
  
  Returns:
  
  socialSecurityWages
- setSocialSecurityWages
  
  public void setSocialSecurityWages(java.lang.String socialSecurityWages)
- socialSecurityTaxWithheld
  
  public W2 socialSecurityTaxWithheld(java.lang.String socialSecurityTaxWithheld)
- getSocialSecurityTaxWithheld
  
  @Nullable public java.lang.String getSocialSecurityTaxWithheld()
  
  Social security tax withheld for the tax year.
  
  Returns:
  
  socialSecurityTaxWithheld
- setSocialSecurityTaxWithheld
  
  public void setSocialSecurityTaxWithheld(java.lang.String socialSecurityTaxWithheld)
- medicareWagesAndTips
  
  public W2 medicareWagesAndTips(java.lang.String medicareWagesAndTips)
- getMedicareWagesAndTips
  
  @Nullable public java.lang.String getMedicareWagesAndTips()
  
  Wages and tips from medicare.
  
  Returns:
  
  medicareWagesAndTips
- setMedicareWagesAndTips
  
  public void setMedicareWagesAndTips(java.lang.String medicareWagesAndTips)
- medicareTaxWithheld
  
  public W2 medicareTaxWithheld(java.lang.String medicareTaxWithheld)
- getMedicareTaxWithheld
  
  @Nullable public java.lang.String getMedicareTaxWithheld()
  
  Medicare tax withheld for the tax year.
  
  Returns:
  
  medicareTaxWithheld
- setMedicareTaxWithheld
  
  public void setMedicareTaxWithheld(java.lang.String medicareTaxWithheld)
- socialSecurityTips
  
  public W2 socialSecurityTips(java.lang.String socialSecurityTips)
- getSocialSecurityTips
  
  @Nullable public java.lang.String getSocialSecurityTips()
  
  Tips from social security.
  
  Returns:
  
  socialSecurityTips
- setSocialSecurityTips
  
  public void setSocialSecurityTips(java.lang.String socialSecurityTips)
- allocatedTips
  
  public W2 allocatedTips(java.lang.String allocatedTips)
- getAllocatedTips
  
  @Nullable public java.lang.String getAllocatedTips()
  
  Allocated tips.
  
  Returns:
  
  allocatedTips
- setAllocatedTips
  
  public void setAllocatedTips(java.lang.String allocatedTips)
- box9
  
  public W2 box9(java.lang.String box9)
- getBox9
  
  @Nullable public java.lang.String getBox9()
  
  Contents from box 9 on the W2.
  
  Returns:
  
  box9
- setBox9
  
  public void setBox9(java.lang.String box9)
- dependentCareBenefits
  
  public W2 dependentCareBenefits(java.lang.String dependentCareBenefits)
- getDependentCareBenefits
  
  @Nullable public java.lang.String getDependentCareBenefits()
  
  Dependent care benefits.
  
  Returns:
  
  dependentCareBenefits
- setDependentCareBenefits
  
  public void setDependentCareBenefits(java.lang.String dependentCareBenefits)
- nonqualifiedPlans
  
  public W2 nonqualifiedPlans(java.lang.String nonqualifiedPlans)
- getNonqualifiedPlans
  
  @Nullable public java.lang.String getNonqualifiedPlans()
  
  Nonqualified plans.
  
  Returns:
  
  nonqualifiedPlans
- setNonqualifiedPlans
  
  public void setNonqualifiedPlans(java.lang.String nonqualifiedPlans)
- box12
  
  public W2 box12(java.util.List<W2Box12> box12)
- addBox12Item
  
  public W2 addBox12Item(W2Box12 box12Item)
- getBox12
  
  @Nullable public java.util.List<W2Box12> getBox12()
  
  Get box12
  
  Returns:
  
  box12
- setBox12
  
  public void setBox12(java.util.List<W2Box12> box12)
- statutoryEmployee
  
  public W2 statutoryEmployee(java.lang.String statutoryEmployee)
- getStatutoryEmployee
  
  @Nullable public java.lang.String getStatutoryEmployee()
  
  Statutory employee.
  
  Returns:
  
  statutoryEmployee
- setStatutoryEmployee
  
  public void setStatutoryEmployee(java.lang.String statutoryEmployee)
- retirementPlan
  
  public W2 retirementPlan(java.lang.String retirementPlan)
- getRetirementPlan
  
  @Nullable public java.lang.String getRetirementPlan()
  
  Retirement plan.
  
  Returns:
  
  retirementPlan
- setRetirementPlan
  
  public void setRetirementPlan(java.lang.String retirementPlan)
- thirdPartySickPay
  
  public W2 thirdPartySickPay(java.lang.String thirdPartySickPay)
- getThirdPartySickPay
  
  @Nullable public java.lang.String getThirdPartySickPay()
  
  Third party sick pay.
  
  Returns:
  
  thirdPartySickPay
- setThirdPartySickPay
  
  public void setThirdPartySickPay(java.lang.String thirdPartySickPay)
- other
  
  public W2 other(java.lang.String other)
- getOther
  
  @Nullable public java.lang.String getOther()
  
  Other.
  
  Returns:
  
  other
- setOther
  
  public void setOther(java.lang.String other)
- stateAndLocalWages
  
  public W2 stateAndLocalWages(java.util.List<W2StateAndLocalWages> stateAndLocalWages)
- addStateAndLocalWagesItem
  
  public W2 addStateAndLocalWagesItem(W2StateAndLocalWages stateAndLocalWagesItem)
- getStateAndLocalWages
  
  @Nullable public java.util.List<W2StateAndLocalWages> getStateAndLocalWages()
  
  Get stateAndLocalWages
  
  Returns:
  
  stateAndLocalWages
- setStateAndLocalWages
  
  public void setStateAndLocalWages(java.util.List<W2StateAndLocalWages> stateAndLocalWages)
- equals
  
  public boolean equals(java.lang.Object o)
  
  Overrides:
  
  equals in class java.lang.Object
- hashCode
  
  public int hashCode()
  
  Overrides:
  
  hashCode in class java.lang.Object
- toString
  
  public java.lang.String toString()
  
  Overrides:
  
  toString in class java.lang.Object

Class W2

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Details

Constructor Details

Method Details