class

Plaid::PayStubEarningsBreakdown

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

An object representing the earnings line items for the pay period.

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, canonical_description : String | Nil = nil, current_amount : Float64 | Nil = nil, description : String | Nil = nil, hours : Float64 | Nil = nil, iso_currency_code : String | Nil = nil, rate : Float64 | Nil = nil, unofficial_currency_code : String | Nil = nil, ytd_amount : Float64 | 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

canonical_description

Commonly used term to describe the earning line item.

Source
canonical_description=(new_value : String | Nil)

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

Source
current_amount

Raw amount of the earning line item.

Source
current_amount=(new_value : Float64 | Nil)

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

Source
description

Description of the earning line item.

Source
description=(new_value : String | Nil)

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

hours

Number of hours applicable for this earning.

Source
hours=(new_value : Float64 | Nil)

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

Source
iso_currency_code

The ISO-4217 currency code of the line item. Always null if unofficial_currency_code is non-null.

Source
iso_currency_code=(new_value : String | Nil)

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

Hourly rate applicable for this earning.

Source
rate=(new_value : Float64 | Nil)

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

Source
unofficial_currency_code

The unofficial currency code associated with the line item. Always null if iso_currency_code is non-null. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries. See the currency code schema for a full listing of supported iso_currency_codes.

Source
unofficial_currency_code=(new_value : String | Nil)

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

The year-to-date amount of the deduction.

Source
ytd_amount=(new_value : Float64 | Nil)

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

Source