class

Plaid::CreditBankIncomeHistoricalSummary

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

The end user's monthly summary for the income source(s).

Constructors

new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, total_amount : Float64 | Nil = nil, iso_currency_code : String | Nil = nil, unofficial_currency_code : String | Nil = nil, total_amounts : Array(CreditAmountWithCurrency) | Nil = nil, start_date : Time | Nil = nil, end_date : Time | Nil = nil, transactions : Array(CreditBankIncomeTransaction) | 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

end_date

The end date of the period included in this monthly summary. This date will be the last day of the month, unless the month being covered is a partial month because it is the last month included in the summary and the date range being requested does not end with the last day of the month. The date will be returned in an 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
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 amount or balance. Please use total_amounts instead.

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
iso_currency_code_present=(iso_currency_code_present : Bool)
Source
iso_currency_code_present?
Source
list_invalid_properties

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

Source
start_date

The start date of the period covered in this monthly summary. This date will be the first day of the month, unless the month being covered is a partial month because it is the first month included in the summary and the date range being requested does not begin with the first day of the month. The date will be returned in an 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
total_amount

Total amount of earnings for the income source(s) of the user for the month in the summary. This may return an incorrect value if the summary includes income sources in multiple currencies. Please use total_amounts instead.

Source
total_amount=(new_value : Float64 | Nil)

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

Source
total_amounts

Total amount of earnings for the income source(s) of the user for the month in the summary. This can contain multiple amounts, with each amount denominated in one unique currency.

Source
total_amounts=(new_value : Array(CreditAmountWithCurrency) | Nil)

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

Source
transactions
Source
transactions=(new_value : Array(CreditBankIncomeTransaction) | Nil)

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

Source
unofficial_currency_code

The unofficial currency code associated with the amount or balance. 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. Please use total_amounts instead.

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
unofficial_currency_code_present=(unofficial_currency_code_present : Bool)
Source
unofficial_currency_code_present?
Source
valid?

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

Source