class Plaid::CraBankIncomeSource
 
  - Plaid::CraBankIncomeSource
 - Reference
 - Object
 
Overview
Detailed information for the income source.
Included Modules
- JSON::Serializable
 - JSON::Serializable::Unmapped
 - OpenApi::Json
 - OpenApi::Validatable
 
Defined in:
plaid/models/cra_bank_income_source.crConstructors
- .new(pull : JSON::PullParser)
 - 
        .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
 
Instance Method Summary
- 
        #==(other : self)
        
          
Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes.
 - #employer : CraBankIncomeEmployer | Nil
 - 
        #employer=(new_value : CraBankIncomeEmployer | Nil)
        
          
Custom attribute writer method checking allowed values (enum).
 - #end_date : Time | Nil
 - 
        #end_date=(new_value : Time | Nil)
        
          
Custom attribute writer method checking allowed values (enum).
 - #forecasted_average_monthly_income : Float64 | Nil
 - 
        #forecasted_average_monthly_income=(new_value : Float64 | Nil)
        
          
Custom attribute writer method checking allowed values (enum).
 - #forecasted_average_monthly_income_present=(forecasted_average_monthly_income_present : Bool)
 - #forecasted_average_monthly_income_present? : Bool
 - 
        #hash(hasher)
        
          
Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes.
 - #historical_average_monthly_gross_income : Float64 | Nil
 - 
        #historical_average_monthly_gross_income=(new_value : Float64 | Nil)
        
          
Custom attribute writer method checking allowed values (enum).
 - #historical_average_monthly_gross_income_present=(historical_average_monthly_gross_income_present : Bool)
 - #historical_average_monthly_gross_income_present? : Bool
 - #historical_average_monthly_income : Float64 | Nil
 - 
        #historical_average_monthly_income=(new_value : Float64 | Nil)
        
          
Custom attribute writer method checking allowed values (enum).
 - #historical_average_monthly_income_present=(historical_average_monthly_income_present : Bool)
 - #historical_average_monthly_income_present? : Bool
 - #historical_summary : Array(CraBankIncomeHistoricalSummary) | Nil
 - 
        #historical_summary=(new_value : Array(CraBankIncomeHistoricalSummary) | Nil)
        
          
Custom attribute writer method checking allowed values (enum).
 - #income_category : Plaid::CreditBankIncomeCategory | Nil
 - 
        #income_category=(new_value : Plaid::CreditBankIncomeCategory | Nil)
        
          
Custom attribute writer method checking allowed values (enum).
 - #income_description : String | Nil
 - 
        #income_description=(new_value : String | Nil)
        
          
Custom attribute writer method checking allowed values (enum).
 - #income_source_id : String | Nil
 - 
        #income_source_id=(new_value : String | Nil)
        
          
Custom attribute writer method checking allowed values (enum).
 - #iso_currency_code : String | Nil
 - 
        #iso_currency_code=(new_value : String | Nil)
        
          
Custom attribute writer method checking allowed values (enum).
 - #iso_currency_code_present=(iso_currency_code_present : Bool)
 - #iso_currency_code_present? : Bool
 - 
        #list_invalid_properties : Array(String)
        
          
Show invalid properties with the reasons.
 - #next_payment_date : Time | Nil
 - 
        #next_payment_date=(new_value : Time | Nil)
        
          
Custom attribute writer method checking allowed values (enum).
 - #next_payment_date_present=(next_payment_date_present : Bool)
 - #next_payment_date_present? : Bool
 - #pay_frequency : Plaid::CreditBankIncomePayFrequency | Nil
 - 
        #pay_frequency=(new_value : Plaid::CreditBankIncomePayFrequency | Nil)
        
          
Custom attribute writer method checking allowed values (enum).
 - #start_date : Time | Nil
 - 
        #start_date=(new_value : Time | Nil)
        
          
Custom attribute writer method checking allowed values (enum).
 - #total_amount : Float64 | Nil
 - 
        #total_amount=(new_value : Float64 | Nil)
        
          
Custom attribute writer method checking allowed values (enum).
 - #transaction_count : Int32 | Nil
 - 
        #transaction_count=(new_value : Int32 | Nil)
        
          
Custom attribute writer method checking allowed values (enum).
 - #unofficial_currency_code : String | Nil
 - 
        #unofficial_currency_code=(new_value : String | Nil)
        
          
Custom attribute writer method checking allowed values (enum).
 - #unofficial_currency_code_present=(unofficial_currency_code_present : Bool)
 - #unofficial_currency_code_present? : Bool
 - 
        #valid? : Bool
        
          
Check to see if the all the properties in the model are valid @return true if the model is valid
 
Instance methods inherited from module OpenApi::Json
  
  
    
      after_initialize
    after_initialize, 
    
  
    
      eql?(o : self)
    eql?, 
    
  
    
      to_hash : Hash(String, JSON::Any)
    to_hash, 
    
  
    
      to_json_any : JSON::Any
    to_json_any
    
  
    
    
  Class methods inherited from module OpenApi::Json
  
  
    
      build_from_hash(hash : Hash)
    build_from_hash, 
    
  
    
      build_from_json_any(json_any : JSON::Any)
    build_from_json_any
    
  
  
    
  Instance methods inherited from module OpenApi::Validatable
  
  
    
      list_invalid_properties : Array(String)
    list_invalid_properties, 
    
  
    
      list_invalid_properties_for(key : String) : Array(String)
    list_invalid_properties_for, 
    
  
    
      valid? : Bool
    valid?, 
    
  
    
      validate : Nil
    validate
    
  
    
    
  
    
    
    
  
    
    
    
  
    
    
    
  
    
    
    
  
Constructor Detail
Initializes the object @param [Hash] attributes Model attributes in the form of hash
Instance Method Detail
Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code
Custom attribute writer method checking allowed values (enum). @param [Object] employer Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] end_date Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] forecasted_average_monthly_income Object to be assigned
Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code
Custom attribute writer method checking allowed values (enum). @param [Object] historical_average_monthly_gross_income Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] historical_average_monthly_income Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] historical_summary Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] income_category Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] income_description Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] income_source_id Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] iso_currency_code Object to be assigned
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
Custom attribute writer method checking allowed values (enum). @param [Object] next_payment_date Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] pay_frequency Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] start_date Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] total_amount Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] transaction_count Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] unofficial_currency_code Object to be assigned
Check to see if the all the properties in the model are valid @return true if the model is valid