class

Plaid::Paystub

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

An object representing data extracted from the end user's paystub.

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
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

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

deductions
Source
deductions=(new_value : Deductions | Nil)

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

Source
doc_id

An identifier of the document referenced by the document metadata.

Source
doc_id=(new_value : String | Nil)

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

Source
earnings
Source
earnings=(new_value : Earnings | Nil)

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

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

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

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

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

Source
employment_details
Source
employment_details=(new_value : EmploymentDetails | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] employment_details 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

income_breakdown
Source
income_breakdown=(new_value : Array(IncomeBreakdown) | Nil)

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

Source
list_invalid_properties

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

Source
net_pay
Source
net_pay=(new_value : NetPay | Nil)

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

Source
pay_period_details
Source
pay_period_details=(new_value : PayPeriodDetails | Nil)

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

Source
paystub_details
Source
paystub_details=(new_value : PaystubDetails | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] paystub_details 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
ytd_earnings
Source
ytd_earnings=(new_value : PaystubYTDDetails | Nil)

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

Source