class

Plaid::CreditW2

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)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, document_metadata : CreditDocumentMetadata | Nil = nil, document_id : String | Nil = nil, employer : CreditPayStubEmployer | Nil = nil, employee : CreditPayStubEmployee | 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

Source

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.

Source
allocated_tips=(new_value : String | Nil)

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

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

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

Source
box_9

Contents from box 9 on the W2.

Source
box_9=(new_value : String | Nil)

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

Source
dependent_care_benefits

Dependent care benefits.

Source
dependent_care_benefits=(new_value : String | Nil)

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

Source
document_id

An identifier of the document referenced by the document metadata.

Source
document_id=(new_value : String | Nil)

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

Source
document_metadata
Source
document_metadata=(new_value : CreditDocumentMetadata | Nil)

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

Source
employee
Source
employee=(new_value : CreditPayStubEmployee | Nil)

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

Source
employer
Source
employer=(new_value : CreditPayStubEmployer | Nil)

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

Source
employer_id_number

An employee identification number or EIN.

Source
employer_id_number=(new_value : String | Nil)

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

Source
federal_income_tax_withheld

Federal income tax withheld for the tax year.

Source
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

Source
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

Source
medicare_tax_withheld

Medicare tax withheld for the tax year.

Source
medicare_tax_withheld=(new_value : String | Nil)

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

Source
medicare_wages_and_tips

Wages and tips from medicare.

Source
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

Source
nonqualified_plans

Nonqualified plans.

Source
nonqualified_plans=(new_value : String | Nil)

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

Source
other

Other.

Source
other=(new_value : String | Nil)

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

Source
retirement_plan

Retirement plan.

Source
retirement_plan=(new_value : String | Nil)

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

Source
social_security_tax_withheld

Social security tax withheld for the tax year.

Source
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

Source
social_security_tips

Tips from social security.

Source
social_security_tips=(new_value : String | Nil)

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

Source
social_security_wages

Wages from social security.

Source
social_security_wages=(new_value : String | Nil)

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

Source
state_and_local_wages
Source
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

Source
statutory_employee

Statutory employee.

Source
statutory_employee=(new_value : String | Nil)

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

Source
tax_year

The tax year of the W2 document.

Source
tax_year=(new_value : String | Nil)

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

Source
third_party_sick_pay

Third party sick pay.

Source
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

Source
valid?

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

Source
wages_tips_other_comp

Wages from tips and other compensation.

Source
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

Source