class

Plaid::W2

Inherits OpenApi::Json < OpenApi::Validatable < JSON::Serializable::Unmapped < JSON::Serializable < Reference < Object

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

Constructors

new(pull : JSON::PullParser)

new(*, __pull_for_json_serializable 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 methods

==(other : self)

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

allocated_tips

Allocated tips.

allocated_tips=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] allocated_tips Object to be assigned

allocated_tips_present=(allocated_tips_present : Bool)

allocated_tips_present?

box_12

box_12=(new_value : Array(W2Box12) | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] box_12 Object to be assigned

box_9

Contents from box 9 on the W2.

box_9=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] box_9 Object to be assigned

box_9_present=(box_9_present : Bool)

box_9_present?

dependent_care_benefits

Dependent care benefits.

dependent_care_benefits=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] dependent_care_benefits Object to be assigned

dependent_care_benefits_present=(dependent_care_benefits_present : Bool)

dependent_care_benefits_present?

employee

employee=(new_value : Employee | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] employee Object to be assigned

employer

employer=(new_value : PaystubEmployer | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] employer Object to be assigned

employer_id_number

An employee identification number or EIN.

employer_id_number=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] employer_id_number Object to be assigned

employer_id_number_present=(employer_id_number_present : Bool)

employer_id_number_present?

federal_income_tax_withheld

Federal income tax withheld for the tax year.

federal_income_tax_withheld=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] federal_income_tax_withheld Object to be assigned

federal_income_tax_withheld_present=(federal_income_tax_withheld_present : Bool)

federal_income_tax_withheld_present?

hash(hasher)

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

list_invalid_properties

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

medicare_tax_withheld

Medicare tax withheld for the tax year.

medicare_tax_withheld=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] medicare_tax_withheld Object to be assigned

medicare_tax_withheld_present=(medicare_tax_withheld_present : Bool)

medicare_tax_withheld_present?

medicare_wages_and_tips

Wages and tips from medicare.

medicare_wages_and_tips=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] medicare_wages_and_tips Object to be assigned

medicare_wages_and_tips_present=(medicare_wages_and_tips_present : Bool)

medicare_wages_and_tips_present?

nonqualified_plans

Nonqualified plans.

nonqualified_plans=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] nonqualified_plans Object to be assigned

nonqualified_plans_present=(nonqualified_plans_present : Bool)

nonqualified_plans_present?

other

Other.

other=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] other Object to be assigned

other_present=(other_present : Bool)

other_present?

retirement_plan

Retirement plan.

retirement_plan=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] retirement_plan Object to be assigned

retirement_plan_present=(retirement_plan_present : Bool)

retirement_plan_present?

social_security_tax_withheld

Social security tax withheld for the tax year.

social_security_tax_withheld=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] social_security_tax_withheld Object to be assigned

social_security_tax_withheld_present=(social_security_tax_withheld_present : Bool)

social_security_tax_withheld_present?

social_security_tips

Tips from social security.

social_security_tips=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] social_security_tips Object to be assigned

social_security_tips_present=(social_security_tips_present : Bool)

social_security_tips_present?

social_security_wages

Wages from social security.

social_security_wages=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] social_security_wages Object to be assigned

social_security_wages_present=(social_security_wages_present : Bool)

social_security_wages_present?

state_and_local_wages

state_and_local_wages=(new_value : Array(W2StateAndLocalWages) | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] state_and_local_wages Object to be assigned

statutory_employee

Statutory employee.

statutory_employee=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] statutory_employee Object to be assigned

statutory_employee_present=(statutory_employee_present : Bool)

statutory_employee_present?

tax_year

The tax year of the W2 document.

tax_year=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] tax_year Object to be assigned

tax_year_present=(tax_year_present : Bool)

tax_year_present?

third_party_sick_pay

Third party sick pay.

third_party_sick_pay=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] third_party_sick_pay Object to be assigned

third_party_sick_pay_present=(third_party_sick_pay_present : Bool)

third_party_sick_pay_present?

valid?

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

wages_tips_other_comp

Wages from tips and other compensation.

wages_tips_other_comp=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] wages_tips_other_comp Object to be assigned

wages_tips_other_comp_present=(wages_tips_other_comp_present : Bool)

wages_tips_other_comp_present?