class

Plaid::PayStubPayPeriodDetails

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

Details about the pay period.

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, pay_amount : Float64 | Nil = nil, distribution_breakdown : Array(PayStubDistributionBreakdown) | Nil = nil, end_date : Time | Nil = nil, gross_earnings : Float64 | Nil = nil, iso_currency_code : String | Nil = nil, pay_date : Time | Nil = nil, pay_frequency : String | Nil = nil, start_date : Time | Nil = nil, unofficial_currency_code : String | Nil = nil, pay_basis : Plaid::CreditPayStubPayBasisType | 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

distribution_breakdown
Source
distribution_breakdown=(new_value : Array(PayStubDistributionBreakdown) | Nil)

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

Source
end_date

The date on which the pay period ended, in ISO 8601 format ("yyyy-mm-dd").

Source
end_date=(new_value : Time | Nil)

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

Source
gross_earnings

Total earnings before tax/deductions.

Source
gross_earnings=(new_value : Float64 | Nil)

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

iso_currency_code

The ISO-4217 currency code of the net pay. 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
pay_amount

The amount of the paycheck.

Source
pay_amount=(new_value : Float64 | Nil)

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

Source
pay_basis
Source
pay_basis=(new_value : Plaid::CreditPayStubPayBasisType | Nil)

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

Source
pay_date

The date on which the pay stub was issued, in ISO 8601 format ("yyyy-mm-dd").

Source
pay_date=(new_value : Time | Nil)

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

Source
pay_frequency

The frequency at which an individual is paid.

Source
pay_frequency=(new_value : String | Nil)

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

Source
start_date

The date on which the pay period started, in ISO 8601 format ("yyyy-mm-dd").

Source
start_date=(new_value : Time | Nil)

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

Source
unofficial_currency_code

The unofficial currency code associated with the net pay. 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