class

Plaid::BaseReportAccount

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

Base Report information about an account

Constructors

new(pull : JSON::PullParser)

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

new(*, balances : Plaid::BaseReportAccountBalances | Nil = nil, mask : String | Nil = nil, name : String | Nil = nil, official_name : String | Nil = nil, _type : Plaid::AccountType | Nil = nil, subtype : Plaid::AccountSubtype | Nil = nil, days_available : Float64 | Nil = nil, transactions : Array(BaseReportTransaction) | Nil = nil, owners : Array(Owner) | Nil = nil, ownership_type : Plaid::OwnershipType | Nil = nil, historical_balances : Array(HistoricalBalance) | Nil = nil, account_insights : BaseReportAccountInsights | 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

_type

_type=(new_value : Plaid::AccountType | Nil)

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

account_insights

account_insights=(new_value : BaseReportAccountInsights | Nil)

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

balances

balances=(new_value : Plaid::BaseReportAccountBalances | Nil)

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

days_available

The duration of transaction history available for this Item, typically defined as the time since the date of the earliest transaction in that account. Only returned by Base Report endpoints.

days_available=(new_value : Float64 | Nil)

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

hash(hasher)

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

historical_balances

Calculated data about the historical balances on the account. Only returned by Base Report endpoints and currently not supported by brokerage or investment accounts.

historical_balances=(new_value : Array(HistoricalBalance) | Nil)

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

list_invalid_properties

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

mask

The last 2-4 alphanumeric characters of an account's official account number. Note that the mask may be non-unique between an Item's accounts, and it may also not match the mask that the bank displays to the user.

mask=(new_value : String | Nil)

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

name

The name of the account, either assigned by the user or by the financial institution itself

name=(new_value : String | Nil)

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

official_name

The official name of the account as given by the financial institution

official_name=(new_value : String | Nil)

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

owners

Data returned by the financial institution about the account owner or owners. For business accounts, the name reported may be either the name of the individual or the name of the business, depending on the institution. Multiple owners on a single account will be represented in the same owner object, not in multiple owner objects within the array.

owners=(new_value : Array(Owner) | Nil)

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

ownership_type

ownership_type=(new_value : Plaid::OwnershipType | Nil)

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

subtype

subtype=(new_value : Plaid::AccountSubtype | Nil)

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

transactions

Transaction history associated with the account. Only returned by Base Report endpoints. Transaction history returned by endpoints such as /transactions/get or /investments/transactions/get will be returned in the top-level transactions field instead.

transactions=(new_value : Array(BaseReportTransaction) | Nil)

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

valid?

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