class

Plaid::CraBankIncomeSource

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

Detailed information for the income source.

Constructors

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, start_date : Time | Nil = nil, end_date : Time | Nil = nil, pay_frequency : Plaid::CreditBankIncomePayFrequency | Nil = nil, total_amount : Float64 | Nil = nil, iso_currency_code : String | Nil = nil, unofficial_currency_code : String | Nil = nil, transaction_count : Int32 | Nil = nil, next_payment_date : Time | Nil = nil, historical_average_monthly_gross_income : Float64 | Nil = nil, historical_average_monthly_income : Float64 | Nil = nil, forecasted_average_monthly_income : Float64 | Nil = nil, employer : CraBankIncomeEmployer | 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

employer
Source
employer=(new_value : CraBankIncomeEmployer | Nil)

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

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

Source
forecasted_average_monthly_income=(new_value : Float64 | Nil)

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

Source
forecasted_average_monthly_income_present=(forecasted_average_monthly_income_present : Bool)
Source
forecasted_average_monthly_income_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

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 : Float64 | Nil)

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

Source
historical_average_monthly_gross_income_present=(historical_average_monthly_gross_income_present : Bool)
Source
historical_average_monthly_gross_income_present?
Source
historical_average_monthly_income

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

Source
historical_average_monthly_income=(new_value : Float64 | Nil)

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

Source
historical_average_monthly_income_present=(historical_average_monthly_income_present : Bool)
Source
historical_average_monthly_income_present?
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_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
iso_currency_code

The ISO 4217 currency code of the amount or balance.

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
iso_currency_code_present=(iso_currency_code_present : Bool)
Source
iso_currency_code_present?
Source
list_invalid_properties

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

Source
next_payment_date

The expected date of the end user’s next paycheck for the income source. The date will be returned in an ISO 8601 format (YYYY-MM-DD).

Source
next_payment_date=(new_value : Time | Nil)

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

Source
next_payment_date_present=(next_payment_date_present : Bool)
Source
next_payment_date_present?
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
unofficial_currency_code

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

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
unofficial_currency_code_present=(unofficial_currency_code_present : Bool)
Source
unofficial_currency_code_present?
Source
valid?

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

Source