class

Plaid::CraBankIncomeSummary

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

Summary for bank income across all income sources and items (max history of 730 days).

Constructors

new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, total_amounts : Array(CreditAmountWithCurrency) | Nil = nil, start_date : Time | Nil = nil, end_date : Time | Nil = nil, income_sources_count : Int32 | Nil = nil, income_categories_count : Int32 | Nil = nil, income_transactions_count : Int32 | Nil = nil, historical_average_monthly_gross_income : Array(CreditAmountWithCurrency) | Nil = nil, historical_average_monthly_income : Array(CreditAmountWithCurrency) | Nil = nil, forecasted_average_monthly_income : Array(CreditAmountWithCurrency) | Nil = nil, historical_summary : Array(CraBankIncomeHistoricalSummary) | 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

end_date

The latest date in which all income sources identified by Plaid appear in the user's account. 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
forecasted_average_monthly_income

The predicted average monthly income amount for the income source(s).

Source
forecasted_average_monthly_income=(new_value : Array(CreditAmountWithCurrency) | Nil)

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

An estimate of the average gross monthly income based on the historical net amount and income category for the income source(s).

Source
historical_average_monthly_gross_income=(new_value : Array(CreditAmountWithCurrency) | Nil)

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

Source
historical_average_monthly_income

The average monthly income amount estimated based on the historical data for the income source(s).

Source
historical_average_monthly_income=(new_value : Array(CreditAmountWithCurrency) | Nil)

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

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

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

Source
income_categories_count

Number of income categories per end user.

Source
income_categories_count=(new_value : Int32 | Nil)

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

Source
income_sources_count

Number of income sources per end user.

Source
income_sources_count=(new_value : Int32 | Nil)

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

Source
income_transactions_count

Number of income transactions per end user.

Source
income_transactions_count=(new_value : Int32 | Nil)

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

The earliest date within the days requested in which all income sources identified by Plaid appear in a user's account. 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_amounts

Total amount of earnings across all the income sources in the end user's Items for the days requested by the client. This can contain multiple amounts, with each amount denominated in one unique currency.

Source
total_amounts=(new_value : Array(CreditAmountWithCurrency) | Nil)

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