class Plaid::CraVoaReportAccountBalances
VOA Report information about an account’s balances.
Attributes
The amount of funds available to be withdrawn from the account, as determined by the financial institution. For ‘credit`-type accounts, the `available` balance typically equals the `limit` less the `current` balance, less any pending outflows plus any pending inflows. For `depository`-type accounts, the `available` balance typically equals the `current` balance less any pending outflows plus any pending inflows. For `depository`-type accounts, the `available` balance does not include the overdraft limit. For `investment`-type accounts (or `brokerage`-type accounts for API versions 2018-05-22 and earlier), the `available` balance is the total cash available to withdraw as presented by the institution. Note that not all institutions calculate the `available` balance. In the event that `available` balance is unavailable, Plaid
will return an `available` balance value of `null`. Available balance may be cached and is not guaranteed to be up-to-date in realtime unless the value was returned by `/accounts/balance/get`. If `current` is `null` this field is guaranteed not to be `null`.
The average balance in the account over the last 30 days. Calculated using the derived historical balances.
The average balance in the account over the last 60 days. Calculated using the derived historical balances.
The total amount of funds in or owed by the account. For ‘credit`-type accounts, a positive balance indicates the amount owed; a negative amount indicates the lender owing the account holder. For `loan`-type accounts, the current balance is the principal remaining on the loan, except in the case of student loan accounts at Sallie Mae (`ins_116944`). For Sallie Mae student loans, the account’s balance includes both principal and any outstanding interest. For ‘investment`-type accounts (or `brokerage`-type accounts for API versions 2018-05-22 and earlier), the current balance is the total value of assets as presented by the institution. Note that balance information may be cached unless the value was returned by `/accounts/balance/get`; if the Item
is enabled for Transactions, the balance will be at least as recent as the most recent Transaction
update. If you require realtime balance information, use the `available` balance as provided by `/accounts/balance/get`. When returned by `/accounts/balance/get`, this field may be `null`. When this happens, `available` is guaranteed not to be `null`.
Calculated data about the historical balances on the account.
The ISO-4217 currency code of the balance. Always null if ‘unofficial_currency_code` is non-null.
The number of NSF and overdraft fee transactions in the time range for the report in the given account.
The unofficial currency code associated with the 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. See the [currency code schema](plaid.com/docs/api/accounts#currency-code-schema) for a full listing of supported `unofficial_currency_code`s.
Public Class Methods
Source
# File lib/plaid/models/cra_voa_report_account_balances.rb, line 58 def self.acceptable_attributes attribute_map.values end
Returns all the JSON keys this model knows about
Source
# File lib/plaid/models/cra_voa_report_account_balances.rb, line 44 def self.attribute_map { :'available' => :'available', :'current' => :'current', :'iso_currency_code' => :'iso_currency_code', :'unofficial_currency_code' => :'unofficial_currency_code', :'historical_balances' => :'historical_balances', :'average_balance_30_days' => :'average_balance_30_days', :'average_balance_60_days' => :'average_balance_60_days', :'nsf_overdraft_transactions_count' => :'nsf_overdraft_transactions_count' } end
Attribute mapping from ruby-style variable name to JSON key.
Source
# File lib/plaid/models/cra_voa_report_account_balances.rb, line 191 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
Source
# File lib/plaid/models/cra_voa_report_account_balances.rb, line 90 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::CraVoaReportAccountBalances` initialize method" end # check to see if the attribute exists and convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.attribute_map.key?(k.to_sym)) fail ArgumentError, "`#{k}` is not a valid attribute in `Plaid::CraVoaReportAccountBalances`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect end h[k.to_sym] = v } if attributes.key?(:'available') self.available = attributes[:'available'] end if attributes.key?(:'current') self.current = attributes[:'current'] end if attributes.key?(:'iso_currency_code') self.iso_currency_code = attributes[:'iso_currency_code'] end if attributes.key?(:'unofficial_currency_code') self.unofficial_currency_code = attributes[:'unofficial_currency_code'] end if attributes.key?(:'historical_balances') if (value = attributes[:'historical_balances']).is_a?(Array) self.historical_balances = value end end if attributes.key?(:'average_balance_30_days') self.average_balance_30_days = attributes[:'average_balance_30_days'] end if attributes.key?(:'average_balance_60_days') self.average_balance_60_days = attributes[:'average_balance_60_days'] end if attributes.key?(:'nsf_overdraft_transactions_count') self.nsf_overdraft_transactions_count = attributes[:'nsf_overdraft_transactions_count'] end end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
Source
# File lib/plaid/models/cra_voa_report_account_balances.rb, line 77 def self.openapi_nullable Set.new([ :'available', :'current', :'iso_currency_code', :'unofficial_currency_code', :'average_balance_30_days', :'average_balance_60_days', ]) end
List of attributes with nullable: true
Source
# File lib/plaid/models/cra_voa_report_account_balances.rb, line 63 def self.openapi_types { :'available' => :'Float', :'current' => :'Float', :'iso_currency_code' => :'String', :'unofficial_currency_code' => :'String', :'historical_balances' => :'Array<CraVoaReportAccountHistoricalBalance>', :'average_balance_30_days' => :'Float', :'average_balance_60_days' => :'Float', :'nsf_overdraft_transactions_count' => :'Float' } end
Attribute type mapping.
Public Instance Methods
Source
# File lib/plaid/models/cra_voa_report_account_balances.rb, line 163 def ==(o) return true if self.equal?(o) self.class == o.class && available == o.available && current == o.current && iso_currency_code == o.iso_currency_code && unofficial_currency_code == o.unofficial_currency_code && historical_balances == o.historical_balances && average_balance_30_days == o.average_balance_30_days && average_balance_60_days == o.average_balance_60_days && nsf_overdraft_transactions_count == o.nsf_overdraft_transactions_count end
Checks equality by comparing each attribute. @param [Object] Object to be compared
Source
# File lib/plaid/models/cra_voa_report_account_balances.rb, line 222 def _deserialize(type, value) case type.to_sym when :Time Time.parse(value) when :Date Date.parse(value) when :String value.to_s when :Integer value.to_i when :Float value.to_f when :Boolean if value.to_s =~ /\A(true|t|yes|y|1)\z/i true else false end when :Object # generic object (usually a Hash), return directly value when /\AArray<(?<inner_type>.+)>\z/ inner_type = Regexp.last_match[:inner_type] value.map { |v| _deserialize(inner_type, v) } when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/ k_type = Regexp.last_match[:k_type] v_type = Regexp.last_match[:v_type] {}.tap do |hash| value.each do |k, v| hash[_deserialize(k_type, k)] = _deserialize(v_type, v) end end else # model # models (e.g. Pet) or oneOf klass = Plaid.const_get(type) klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) end end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
Source
# File lib/plaid/models/cra_voa_report_account_balances.rb, line 293 def _to_hash(value) if value.is_a?(Array) value.compact.map { |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
Source
# File lib/plaid/models/cra_voa_report_account_balances.rb, line 198 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) attributes = attributes.transform_keys(&:to_sym) self.class.openapi_types.each_pair do |key, type| if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key) self.send("#{key}=", nil) elsif type =~ /\AArray<(.*)>/i # check to ensure the input is an array given that the attribute # is documented as an array but the input is not if attributes[self.class.attribute_map[key]].is_a?(Array) self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) end elsif !attributes[self.class.attribute_map[key]].nil? self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) end end self end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
Source
# File lib/plaid/models/cra_voa_report_account_balances.rb, line 178 def eql?(o) self == o end
@see the ‘==` method @param [Object] Object to be compared
Source
# File lib/plaid/models/cra_voa_report_account_balances.rb, line 184 def hash [available, current, iso_currency_code, unofficial_currency_code, historical_balances, average_balance_30_days, average_balance_60_days, nsf_overdraft_transactions_count].hash end
Calculates hash code according to all attributes. @return [Integer] Hash code
Source
# File lib/plaid/models/cra_voa_report_account_balances.rb, line 140 def list_invalid_properties invalid_properties = Array.new if @historical_balances.nil? invalid_properties.push('invalid value for "historical_balances", historical_balances cannot be nil.') end if @nsf_overdraft_transactions_count.nil? invalid_properties.push('invalid value for "nsf_overdraft_transactions_count", nsf_overdraft_transactions_count cannot be nil.') end invalid_properties end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
Source
Source
# File lib/plaid/models/cra_voa_report_account_balances.rb, line 275 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) if value.nil? is_nullable = self.class.openapi_nullable.include?(attr) next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) end hash[param] = _to_hash(value) end hash end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
Source
# File lib/plaid/models/cra_voa_report_account_balances.rb, line 263 def to_s to_hash.to_s end
Returns the string representation of the object @return [String] String presentation of the object
Source
# File lib/plaid/models/cra_voa_report_account_balances.rb, line 155 def valid? return false if @historical_balances.nil? return false if @nsf_overdraft_transactions_count.nil? true end
Check to see if the all the properties in the model are valid @return true if the model is valid