class Plaid::IncomeSummary
- Plaid::IncomeSummary
- Reference
- Object
Overview
The verified fields from a paystub verification. All fields are provided as reported on the paystub.
Included Modules
- JSON::Serializable
- JSON::Serializable::Unmapped
- OpenApi::Json
- OpenApi::Validatable
Defined in:
plaid/models/income_summary.crConstructors
- .new(pull : JSON::PullParser)
-
.new(*, employer_name : Plaid::EmployerIncomeSummaryFieldString | Nil = nil, employee_name : Plaid::EmployeeIncomeSummaryFieldString | Nil = nil, ytd_gross_income : Plaid::YTDGrossIncomeSummaryFieldNumber | Nil = nil, ytd_net_income : Plaid::YTDNetIncomeSummaryFieldNumber | Nil = nil, pay_frequency : PayFrequency | Nil = nil, projected_wage : Plaid::ProjectedIncomeSummaryFieldNumber | Nil = nil, verified_transaction : TransactionData | 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.
- #employee_name : Plaid::EmployeeIncomeSummaryFieldString | Nil
-
#employee_name=(new_value : Plaid::EmployeeIncomeSummaryFieldString | Nil)
Custom attribute writer method checking allowed values (enum).
- #employer_name : Plaid::EmployerIncomeSummaryFieldString | Nil
-
#employer_name=(new_value : Plaid::EmployerIncomeSummaryFieldString | Nil)
Custom attribute writer method checking allowed values (enum).
-
#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.
- #pay_frequency : PayFrequency | Nil
-
#pay_frequency=(new_value : PayFrequency | Nil)
Custom attribute writer method checking allowed values (enum).
- #projected_wage : Plaid::ProjectedIncomeSummaryFieldNumber | Nil
-
#projected_wage=(new_value : Plaid::ProjectedIncomeSummaryFieldNumber | Nil)
Custom attribute writer method checking allowed values (enum).
-
#valid? : Bool
Check to see if the all the properties in the model are valid @return true if the model is valid
- #verified_transaction : TransactionData | Nil
-
#verified_transaction=(new_value : TransactionData | Nil)
Custom attribute writer method checking allowed values (enum).
- #ytd_gross_income : Plaid::YTDGrossIncomeSummaryFieldNumber | Nil
-
#ytd_gross_income=(new_value : Plaid::YTDGrossIncomeSummaryFieldNumber | Nil)
Custom attribute writer method checking allowed values (enum).
- #ytd_net_income : Plaid::YTDNetIncomeSummaryFieldNumber | Nil
-
#ytd_net_income=(new_value : Plaid::YTDNetIncomeSummaryFieldNumber | Nil)
Custom attribute writer method checking allowed values (enum).
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
Initializes the object @param [Hash] attributes Model attributes in the form of hash
Instance Method Detail
Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code
Custom attribute writer method checking allowed values (enum). @param [Object] employee_name Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] employer_name Object to be assigned
Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
Custom attribute writer method checking allowed values (enum). @param [Object] pay_frequency Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] projected_wage Object to be assigned
Check to see if the all the properties in the model are valid @return true if the model is valid
Custom attribute writer method checking allowed values (enum). @param [Object] verified_transaction Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] ytd_gross_income Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] ytd_net_income Object to be assigned