Class: ModernTreasury::Models::InternalAccounts::BalanceReport::Balance

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/modern_treasury/models/internal_accounts/balance_report.rb

Defined Under Namespace

Modules: BalanceType

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(id: , amount: , as_of_date: , as_of_time: , balance_type: , created_at: , currency: , live_mode: , object: , updated_at: , value_date: , vendor_code: , vendor_code_type: ) ⇒ Object

Some parameter documentations has been truncated, see ModernTreasury::Models::InternalAccounts::BalanceReport::Balance for more details.

Parameters:

  • id (String) (defaults to: )
  • amount (Integer) (defaults to: ) —

    The balance amount.

  • as_of_date (Date, nil) (defaults to: ) —

    The date on which the balance became true for the account.

  • as_of_time (Time, nil) (defaults to: ) —

    The time on which the balance became true for the account.

  • balance_type (Symbol, ModernTreasury::Models::InternalAccounts::BalanceReport::Balance::BalanceType) (defaults to: ) —

    The specific type of balance reported. One of ‘opening_ledger`, `closing_ledger`

  • created_at (Time) (defaults to: )
  • currency (Symbol, ModernTreasury::Models::Currency) (defaults to: ) —

    The currency of the balance.

  • live_mode (Boolean) (defaults to: ) —

    This field will be true if this object exists in the live environment or false i

  • object (String) (defaults to: )
  • updated_at (Time) (defaults to: )
  • value_date (Date, nil) (defaults to: ) —

    The date on which the balance becomes available.

  • vendor_code (String) (defaults to: ) —

    The code used by the bank when reporting this specific balance.

  • vendor_code_type (String, nil) (defaults to: ) —

    The type of ‘vendor_code` being reported. Can be one of `bai2`, `bankprov`, `bnk




# File 'lib/modern_treasury/models/internal_accounts/balance_report.rb', line 190

Instance Attribute Details

#amount ⇒ Integer

The balance amount.

Returns:

  • (Integer) 


118
 
# File 'lib/modern_treasury/models/internal_accounts/balance_report.rb', line 118

required :amount, Integer

#as_of_date ⇒ Date?

The date on which the balance became true for the account.

Returns:

  • (Date, nil) 


124
 
# File 'lib/modern_treasury/models/internal_accounts/balance_report.rb', line 124

required :as_of_date, Date, nil?: true

#as_of_time ⇒ Time?

The time on which the balance became true for the account.

Returns:

  • (Time, nil) 


130
 
# File 'lib/modern_treasury/models/internal_accounts/balance_report.rb', line 130

required :as_of_time, Time, nil?: true

#balance_type ⇒ Symbol, ModernTreasury::Models::InternalAccounts::BalanceReport::Balance::BalanceType

The specific type of balance reported. One of ‘opening_ledger`, `closing_ledger`, `current_ledger`, `opening_available`, `opening_available_next_business_day`, `closing_available`, `current_available`, ’previously_closed_book’, or ‘other`.

Returns:



139
 
# File 'lib/modern_treasury/models/internal_accounts/balance_report.rb', line 139

required :balance_type, enum: -> { ModernTreasury::InternalAccounts::BalanceReport::Balance::BalanceType }

#created_at ⇒ Time

Returns:

  • (Time) 


144
 
# File 'lib/modern_treasury/models/internal_accounts/balance_report.rb', line 144

required :created_at, Time

#currency ⇒ Symbol, ModernTreasury::Models::Currency

The currency of the balance.

Returns:



150
 
# File 'lib/modern_treasury/models/internal_accounts/balance_report.rb', line 150

required :currency, enum: -> { ModernTreasury::Currency }

#id ⇒ String

Returns:

  • (String) 


112
 
# File 'lib/modern_treasury/models/internal_accounts/balance_report.rb', line 112

required :id, String

#live_mode ⇒ Boolean

This field will be true if this object exists in the live environment or false if it exists in the test environment.

Returns:

  • (Boolean) 


157
 
# File 'lib/modern_treasury/models/internal_accounts/balance_report.rb', line 157

required :live_mode, ModernTreasury::Internal::Type::Boolean

#object ⇒ String

Returns:

  • (String) 


162
 
# File 'lib/modern_treasury/models/internal_accounts/balance_report.rb', line 162

required :object, String

#updated_at ⇒ Time

Returns:

  • (Time) 


167
 
# File 'lib/modern_treasury/models/internal_accounts/balance_report.rb', line 167

required :updated_at, Time

#value_date ⇒ Date?

The date on which the balance becomes available.

Returns:

  • (Date, nil) 


173
 
# File 'lib/modern_treasury/models/internal_accounts/balance_report.rb', line 173

required :value_date, Date, nil?: true

#vendor_code ⇒ String

The code used by the bank when reporting this specific balance.

Returns:

  • (String) 


179
 
# File 'lib/modern_treasury/models/internal_accounts/balance_report.rb', line 179

required :vendor_code, String

#vendor_code_type ⇒ String?

The type of ‘vendor_code` being reported. Can be one of `bai2`, `bankprov`, `bnk_dev`, `cleartouch`, `currencycloud`, `cross_river`, `dc_bank`, `dwolla`, `evolve`, `goldman_sachs`, `iso20022`, `jpmc`, `mx`, `signet`, `silvergate`, `swift`, or `us_bank`.

Returns:

  • (String, nil) 


188
 
# File 'lib/modern_treasury/models/internal_accounts/balance_report.rb', line 188

required :vendor_code_type, String, nil?: true