class Plaid::Paystub
- Plaid::Paystub
- Reference
- Object
Overview
An object representing data extracted from the end user's paystub.
Included Modules
- JSON::Serializable
- JSON::Serializable::Unmapped
- OpenApi::Json
- OpenApi::Validatable
Defined in:
plaid/models/paystub.crConstructors
- .new(pull : JSON::PullParser)
-
.new(*, deductions : Deductions | Nil = nil, doc_id : String | Nil = nil, earnings : Earnings | Nil = nil, employee : Employee | Nil = nil, employer : PaystubEmployer | Nil = nil, net_pay : NetPay | Nil = nil, pay_period_details : PayPeriodDetails | Nil = nil, employment_details : EmploymentDetails | Nil = nil, paystub_details : PaystubDetails | Nil = nil, income_breakdown : Array(IncomeBreakdown) | Nil = nil, ytd_earnings : PaystubYTDDetails | 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.
- #deductions : Deductions | Nil
-
#deductions=(new_value : Deductions | Nil)
Custom attribute writer method checking allowed values (enum).
- #doc_id : String | Nil
-
#doc_id=(new_value : String | Nil)
Custom attribute writer method checking allowed values (enum).
- #earnings : Earnings | Nil
-
#earnings=(new_value : Earnings | Nil)
Custom attribute writer method checking allowed values (enum).
- #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).
- #employment_details : EmploymentDetails | Nil
-
#employment_details=(new_value : EmploymentDetails | 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.
- #income_breakdown : Array(IncomeBreakdown) | Nil
-
#income_breakdown=(new_value : Array(IncomeBreakdown) | Nil)
Custom attribute writer method checking allowed values (enum).
-
#list_invalid_properties : Array(String)
Show invalid properties with the reasons.
- #net_pay : NetPay | Nil
-
#net_pay=(new_value : NetPay | Nil)
Custom attribute writer method checking allowed values (enum).
- #pay_period_details : PayPeriodDetails | Nil
-
#pay_period_details=(new_value : PayPeriodDetails | Nil)
Custom attribute writer method checking allowed values (enum).
- #paystub_details : PaystubDetails | Nil
-
#paystub_details=(new_value : PaystubDetails | 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
- #ytd_earnings : PaystubYTDDetails | Nil
-
#ytd_earnings=(new_value : PaystubYTDDetails | 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] deductions Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] doc_id Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] earnings Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] employee Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] employer Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] employment_details 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
Custom attribute writer method checking allowed values (enum). @param [Object] income_breakdown Object to be assigned
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] net_pay Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] pay_period_details Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] paystub_details 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] ytd_earnings Object to be assigned