class

Plaid::AssetReportInvestmentHolding

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

A securities holding at an institution.

Constructors

new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, account_id : String | Nil = nil, security_id : String | Nil = nil, ticker_symbol : String | Nil = nil, institution_price : Float64 | Nil = nil, institution_value : Float64 | Nil = nil, cost_basis : Float64 | Nil = nil, quantity : Float64 | Nil = nil, iso_currency_code : String | Nil = nil, unofficial_currency_code : String | Nil = nil, institution_price_as_of : Time | 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

account_id

The Plaid account_id associated with the holding.

Source
account_id=(new_value : String | Nil)

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

Source
cost_basis

The original total value of the holding. This field is calculated by Plaid as the sum of the purchase price of all of the shares in the holding.

Source
cost_basis=(new_value : Float64 | Nil)

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

institution_price

The last price given by the institution for this security.

Source
institution_price=(new_value : Float64 | Nil)

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

Source
institution_price_as_of

The date at which institution_price was current.

Source
institution_price_as_of=(new_value : Time | Nil)

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

Source
institution_price_as_of_present=(institution_price_as_of_present : Bool)
Source
institution_price_as_of_present?
Source
institution_value

The value of the holding, as reported by the institution.

Source
institution_value=(new_value : Float64 | Nil)

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

Source
iso_currency_code

The ISO-4217 currency code of the holding. 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
quantity

The total quantity of the asset held, as reported by the financial institution. If the security is an option, quantity will reflect the total number of options (typically the number of contracts multiplied by 100), not the number of contracts.

Source
quantity=(new_value : Float64 | Nil)

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

Source
security_id

The Plaid security_id associated with the holding. Security data is not specific to a user's account; any user who held the same security at the same financial institution at the same time would have identical security data. The security_id for the same security will typically be the same across different institutions, but this is not guaranteed. The security_id does not typically change, but may change if inherent details of the security change due to a corporate action, for example, in the event of a ticker symbol change or CUSIP change.

Source
security_id=(new_value : String | Nil)

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

Source
ticker_symbol

The holding's trading symbol for publicly traded holdings, and otherwise a short identifier if available.

Source
ticker_symbol=(new_value : String | Nil)

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

Source
unofficial_currency_code

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