class

Plaid::BaseReportTransaction

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

A transaction on the Base Report

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, amount : Float64 | Nil = nil, iso_currency_code : String | Nil = nil, unofficial_currency_code : String | Nil = nil, original_description : String | Nil = nil, date : Time | Nil = nil, pending : Bool | Nil = nil, credit_category : CreditCategory | Nil = nil, check_number : String | Nil = nil, date_transacted : String | Nil = nil, location : Location | Nil = nil, merchant_name : String | Nil = nil, account_owner : 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

account_owner

The name of the account owner. This field is not typically populated and only relevant when dealing with sub-accounts.

Source
account_owner=(new_value : String | Nil)

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

Source
account_owner_present=(account_owner_present : Bool)
Source
account_owner_present?
Source
amount

The settled value of the transaction, denominated in the transaction's currency, as stated in iso_currency_code or unofficial_currency_code. Positive values when money moves out of the account; negative values when money moves in. For example, debit card purchases are positive; credit card payments, direct deposits, and refunds are negative.

Source
amount=(new_value : Float64 | Nil)

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

Source
check_number

The check number of the transaction. This field is only populated for check transactions.

Source
check_number=(new_value : String | Nil)

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

Source
check_number_present=(check_number_present : Bool)
Source
check_number_present?
Source
credit_category
Source
credit_category=(new_value : CreditCategory | Nil)

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

Source
credit_category_present=(credit_category_present : Bool)
Source
credit_category_present?
Source
date

For pending transactions, the date that the transaction occurred; for posted transactions, the date that the transaction posted. Both dates are returned 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
date_transacted

The date on which the transaction took place, in IS0 8601 format.

Source
date_transacted=(new_value : String | Nil)

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

Source
date_transacted_present=(date_transacted_present : Bool)
Source
date_transacted_present?
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 transaction. 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
location
Source
location=(new_value : Location | Nil)

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

Source
merchant_name

The merchant name, as enriched by Plaid from the name field. This is typically a more human-readable version of the merchant counterparty in the transaction. For some bank transactions (such as checks or account transfers) where there is no meaningful merchant name, this value will be null.

Source
merchant_name=(new_value : String | Nil)

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

Source
merchant_name_present=(merchant_name_present : Bool)
Source
merchant_name_present?
Source
original_description

The string returned by the financial institution to describe the transaction.

Source
original_description=(new_value : String | Nil)

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

Source
pending

When true, identifies the transaction as pending or unsettled. Pending transaction details (name, type, amount, category ID) may change before they are settled.

Source
pending=(new_value : Bool | Nil)

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

Source
unofficial_currency_code

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