class

Plaid::PayPeriodDetails

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

Details about the pay period.

Constants

ERROR_MESSAGE_FOR_PAY_FREQUENCY = "invalid value for \"pay_frequency\", must be one of [PAY_FREQUENCY_UNKNOWN, PAY_FREQUENCY_WEEKLY, PAY_FREQUENCY_BIWEEKLY, PAY_FREQUENCY_SEMIMONTHLY, PAY_FREQUENCY_MONTHLY, null]."

VALID_VALUES_FOR_PAY_FREQUENCY = String.static_array("PAY_FREQUENCY_UNKNOWN", "PAY_FREQUENCY_WEEKLY", "PAY_FREQUENCY_BIWEEKLY", "PAY_FREQUENCY_SEMIMONTHLY", "PAY_FREQUENCY_MONTHLY", "null")

Constructors

new(pull : JSON::PullParser)

new(*, __pull_for_json_serializable pull : JSON::PullParser)

new(*, check_amount : Float64 | Nil = nil, distribution_breakdown : Array(DistributionBreakdown) | Nil = nil, end_date : Time | Nil = nil, gross_earnings : Float64 | Nil = nil, pay_date : Time | Nil = nil, pay_frequency : String | Nil = nil, pay_day : Time | Nil = nil, start_date : Time | Nil = nil)

Initializes the object @param [Hash] attributes Model attributes in the form of hash

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

check_amount

The amount of the paycheck.

check_amount=(new_value : Float64 | Nil)

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

check_amount_present=(check_amount_present : Bool)

check_amount_present?

distribution_breakdown

distribution_breakdown=(new_value : Array(DistributionBreakdown) | Nil)

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

end_date

The pay period end date, in ISO 8601 format: "yyyy-mm-dd".

end_date=(new_value : Time | Nil)

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

end_date_present=(end_date_present : Bool)

end_date_present?

gross_earnings

Total earnings before tax/deductions.

gross_earnings=(new_value : Float64 | Nil)

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

gross_earnings_present=(gross_earnings_present : Bool)

gross_earnings_present?

hash(hasher)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

list_invalid_properties

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

pay_date

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

pay_date=(new_value : Time | Nil)

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

pay_date_present=(pay_date_present : Bool)

pay_date_present?

pay_day

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

pay_day=(new_value : Time | Nil)

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

pay_day_present=(pay_day_present : Bool)

pay_day_present?

pay_frequency

The frequency at which an individual is paid.

pay_frequency=(new_value : String | Nil)

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

pay_frequency_present=(pay_frequency_present : Bool)

pay_frequency_present?

start_date

The pay period start date, in ISO 8601 format: "yyyy-mm-dd".

start_date=(new_value : Time | Nil)

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

start_date_present=(start_date_present : Bool)

start_date_present?

valid?

Check to see if the all the properties in the model are valid @return true if the model is valid