class

Plaid::HistoricalBalance

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

An object representing a balance held by an account in the past

Constructors

new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, date : Time | Nil = nil, current : Float64 | Nil = nil, iso_currency_code : String | Nil = nil, unofficial_currency_code : String | 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

current

The total amount of funds in the account, calculated from the current balance in the balance object by subtracting inflows and adding back outflows according to the posted date of each transaction. If the account has any pending transactions, historical balance amounts on or after the date of the earliest pending transaction may differ if retrieved in subsequent Asset Reports as a result of those pending transactions posting.

Source
current=(new_value : Float64 | Nil)

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

Source
date

The date of the calculated historical balance, in an ISO 8601 format (YYYY-MM-DD)

Source
date=(new_value : Time | Nil)

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

The unofficial currency code associated with the balance. Always null if iso_currency_code is non-null. See the currency code schema for a full listing of supported unofficial_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