class Plaid::CreditW2

Overview

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

Included Modules

Defined in:

plaid/models/credit_w2.cr

Constructors

Instance Method Summary

Instance methods inherited from module OpenApi::Json

after_initialize after_initialize, eql?(o : self) eql?, to_hash : Hash(String, JSON::Any) to_hash, to_json_any : JSON::Any to_json_any

Class methods inherited from module OpenApi::Json

build_from_hash(hash : Hash) build_from_hash, build_from_json_any(json_any : JSON::Any) build_from_json_any

Instance methods inherited from module OpenApi::Validatable

list_invalid_properties : Array(String) list_invalid_properties, list_invalid_properties_for(key : String) : Array(String) list_invalid_properties_for, valid? : Bool valid?, validate : Nil validate

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]
def self.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


[View source]

Instance Method Detail

def ==(other : self) #

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


def allocated_tips : String | Nil #

[View source]
def allocated_tips=(new_value : String | Nil) #

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


[View source]
def box_12 : Array(W2Box12) | Nil #

[View source]
def box_12=(new_value : Array(W2Box12) | Nil) #

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


[View source]
def box_9 : String | Nil #

[View source]
def box_9=(new_value : String | Nil) #

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


[View source]
def dependent_care_benefits : String | Nil #

[View source]
def dependent_care_benefits=(new_value : String | Nil) #

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


[View source]
def document_id : String | Nil #

[View source]
def document_id=(new_value : String | Nil) #

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


[View source]
def document_metadata : CreditDocumentMetadata | Nil #

[View source]
def document_metadata=(new_value : CreditDocumentMetadata | Nil) #

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


[View source]
def employee : CreditPayStubEmployee | Nil #

[View source]
def employee=(new_value : CreditPayStubEmployee | Nil) #

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


[View source]
def employer : CreditPayStubEmployer | Nil #

[View source]
def employer=(new_value : CreditPayStubEmployer | Nil) #

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


[View source]
def employer_id_number : String | Nil #

[View source]
def employer_id_number=(new_value : String | Nil) #

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


[View source]
def federal_income_tax_withheld : String | Nil #

[View source]
def 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


[View source]
def hash(hasher) #

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


def list_invalid_properties : Array(String) #

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


[View source]
def medicare_tax_withheld : String | Nil #

[View source]
def medicare_tax_withheld=(new_value : String | Nil) #

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


[View source]
def medicare_wages_and_tips : String | Nil #

[View source]
def 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


[View source]
def nonqualified_plans : String | Nil #

[View source]
def nonqualified_plans=(new_value : String | Nil) #

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


[View source]
def other : String | Nil #

[View source]
def other=(new_value : String | Nil) #

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


[View source]
def retirement_plan : String | Nil #

[View source]
def retirement_plan=(new_value : String | Nil) #

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


[View source]
def social_security_tax_withheld : String | Nil #

[View source]
def 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


[View source]
def social_security_tips : String | Nil #

[View source]
def social_security_tips=(new_value : String | Nil) #

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


[View source]
def social_security_wages : String | Nil #

[View source]
def social_security_wages=(new_value : String | Nil) #

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


[View source]
def state_and_local_wages : Array(W2StateAndLocalWages) | Nil #

[View source]
def 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


[View source]
def statutory_employee : String | Nil #

[View source]
def statutory_employee=(new_value : String | Nil) #

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


[View source]
def tax_year : String | Nil #

[View source]
def tax_year=(new_value : String | Nil) #

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


[View source]
def third_party_sick_pay : String | Nil #

[View source]
def 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


[View source]
def valid? : Bool #

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


[View source]
def wages_tips_other_comp : String | Nil #

[View source]
def 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


[View source]