class

Plaid::CreditBankIncomeSource

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

Detailed information for the income source.

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, income_source_id : String | Nil = nil, income_description : String | Nil = nil, income_category : Plaid::CreditBankIncomeCategory | Nil = nil, account_id : String | Nil = nil, start_date : Time | Nil = nil, end_date : Time | Nil = nil, pay_frequency : Plaid::CreditBankIncomePayFrequency | Nil = nil, total_amount : Float64 | Nil = nil, transaction_count : Int32 | Nil = nil, historical_summary : Array(CreditBankIncomeHistoricalSummary) | 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

Plaid's unique identifier for the account.

Source
account_id=(new_value : String | Nil)

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

Source
end_date

Maximum of all dates within the specific income sources in the user’s bank account for days requested by the client. The date will be returned in an ISO 8601 format (YYYY-MM-DD).

Source
end_date=(new_value : Time | Nil)

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

historical_summary
Source
historical_summary=(new_value : Array(CreditBankIncomeHistoricalSummary) | Nil)

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

Source
income_category
Source
income_category=(new_value : Plaid::CreditBankIncomeCategory | Nil)

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

Source
income_description

The most common name or original description for the underlying income transactions.

Source
income_description=(new_value : String | Nil)

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

Source
income_source_id

A unique identifier for an income source.

Source
income_source_id=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] income_source_id 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
pay_frequency
Source
pay_frequency=(new_value : Plaid::CreditBankIncomePayFrequency | Nil)

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

Source
start_date

Minimum of all dates within the specific income sources in the user's bank account for days requested by the client. The date will be returned in an ISO 8601 format (YYYY-MM-DD).

Source
start_date=(new_value : Time | Nil)

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

Source
total_amount

Total amount of earnings in the user’s bank account for the specific income source for days requested by the client.

Source
total_amount=(new_value : Float64 | Nil)

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

Source
transaction_count

Number of transactions for the income source within the start and end date.

Source
transaction_count=(new_value : Int32 | Nil)

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