class Plaid::W2

• Plaid::W2
• Reference
• Object

Overview

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

Included Modules

• JSON::Serializable
• JSON::Serializable::Unmapped
• OpenApi::Json
• OpenApi::Validatable

Defined in:

plaid/models/w2.cr

Constructors

• .new(pull : JSON::PullParser)
• .new(*, employer : PaystubEmployer | Nil = nil, employee : Employee | Nil = nil, tax_year : String | Nil = nil, employer_id_number : String | Nil = nil, wages_tips_other_comp : String | Nil = nil, federal_income_tax_withheld : String | Nil = nil, social_security_wages : String | Nil = nil, social_security_tax_withheld : String | Nil = nil, medicare_wages_and_tips : String | Nil = nil, medicare_tax_withheld : String | Nil = nil, social_security_tips : String | Nil = nil, allocated_tips : String | Nil = nil, box_9 : String | Nil = nil, dependent_care_benefits : String | Nil = nil, nonqualified_plans : String | Nil = nil, box_12 : Array(W2Box12) | Nil = nil, statutory_employee : String | Nil = nil, retirement_plan : String | Nil = nil, third_party_sick_pay : String | Nil = nil, other : String | Nil = nil, state_and_local_wages : Array(W2StateAndLocalWages) | Nil = nil)

  Initializes the object @param [Hash] attributes Model attributes in the form of hash

Instance Method Summary

• #==(other : self)

  Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes.

• #allocated_tips : String | Nil
• #allocated_tips=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #allocated_tips_present=(allocated_tips_present : Bool)
• #allocated_tips_present? : Bool
• #box_12 : Array(W2Box12) | Nil
• #box_12=(new_value : Array(W2Box12) | Nil)

  Custom attribute writer method checking allowed values (enum).

• #box_9 : String | Nil
• #box_9=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #box_9_present=(box_9_present : Bool)
• #box_9_present? : Bool
• #dependent_care_benefits : String | Nil
• #dependent_care_benefits=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #dependent_care_benefits_present=(dependent_care_benefits_present : Bool)
• #dependent_care_benefits_present? : Bool
• #employee : Employee | Nil
• #employee=(new_value : Employee | Nil)

  Custom attribute writer method checking allowed values (enum).

• #employer : PaystubEmployer | Nil
• #employer=(new_value : PaystubEmployer | Nil)

  Custom attribute writer method checking allowed values (enum).

• #employer_id_number : String | Nil
• #employer_id_number=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #employer_id_number_present=(employer_id_number_present : Bool)
• #employer_id_number_present? : Bool
• #federal_income_tax_withheld : String | Nil
• #federal_income_tax_withheld=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #federal_income_tax_withheld_present=(federal_income_tax_withheld_present : Bool)
• #federal_income_tax_withheld_present? : Bool
• #hash(hasher)

  Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes.

• #list_invalid_properties : Array(String)

  Show invalid properties with the reasons.

• #medicare_tax_withheld : String | Nil
• #medicare_tax_withheld=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #medicare_tax_withheld_present=(medicare_tax_withheld_present : Bool)
• #medicare_tax_withheld_present? : Bool
• #medicare_wages_and_tips : String | Nil
• #medicare_wages_and_tips=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #medicare_wages_and_tips_present=(medicare_wages_and_tips_present : Bool)
• #medicare_wages_and_tips_present? : Bool
• #nonqualified_plans : String | Nil
• #nonqualified_plans=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #nonqualified_plans_present=(nonqualified_plans_present : Bool)
• #nonqualified_plans_present? : Bool
• #other : String | Nil
• #other=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #other_present=(other_present : Bool)
• #other_present? : Bool
• #retirement_plan : String | Nil
• #retirement_plan=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #retirement_plan_present=(retirement_plan_present : Bool)
• #retirement_plan_present? : Bool
• #social_security_tax_withheld : String | Nil
• #social_security_tax_withheld=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #social_security_tax_withheld_present=(social_security_tax_withheld_present : Bool)
• #social_security_tax_withheld_present? : Bool
• #social_security_tips : String | Nil
• #social_security_tips=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #social_security_tips_present=(social_security_tips_present : Bool)
• #social_security_tips_present? : Bool
• #social_security_wages : String | Nil
• #social_security_wages=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #social_security_wages_present=(social_security_wages_present : Bool)
• #social_security_wages_present? : Bool
• #state_and_local_wages : Array(W2StateAndLocalWages) | Nil
• #state_and_local_wages=(new_value : Array(W2StateAndLocalWages) | Nil)

  Custom attribute writer method checking allowed values (enum).

• #statutory_employee : String | Nil
• #statutory_employee=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #statutory_employee_present=(statutory_employee_present : Bool)
• #statutory_employee_present? : Bool
• #tax_year : String | Nil
• #tax_year=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #tax_year_present=(tax_year_present : Bool)
• #tax_year_present? : Bool
• #third_party_sick_pay : String | Nil
• #third_party_sick_pay=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #third_party_sick_pay_present=(third_party_sick_pay_present : Bool)
• #third_party_sick_pay_present? : Bool
• #valid? : Bool

  Check to see if the all the properties in the model are valid @return true if the model is valid

• #wages_tips_other_comp : String | Nil
• #wages_tips_other_comp=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #wages_tips_other_comp_present=(wages_tips_other_comp_present : Bool)
• #wages_tips_other_comp_present? : Bool

Constructor Detail

Instance Method Detail