Class: ModernTreasury::Models::VirtualAccount

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

Overview

See Also:

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: , account_details: , counterparty_id: , created_at: , credit_ledger_account_id: , debit_ledger_account_id: , description: , discarded_at: , internal_account_id: , ledger_account_id: , live_mode: , metadata: , name: , object: , routing_details: , updated_at: ) ⇒ Object

Some parameter documentations has been truncated, see ModernTreasury::Models::VirtualAccount for more details.

Parameters:

  • id (String) (defaults to: )
  • account_details (Array<ModernTreasury::Models::AccountDetail>) (defaults to: ) —

    An array of account detail objects.

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

    The ID of a counterparty that the virtual account belongs to. Optional.

  • created_at (Time) (defaults to: )
  • credit_ledger_account_id (String, nil) (defaults to: ) —

    The ID of a credit normal ledger account. When money enters the virtual account,

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

    The ID of a debit normal ledger account. When money enters the virtual account,

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

    An optional free-form description for internal use.

  • discarded_at (Time, nil) (defaults to: )
  • internal_account_id (String) (defaults to: ) —

    The ID of the internal account that the virtual account is in.

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

    If the virtual account links to a ledger account in Modern Treasury, the id of t

  • live_mode (Boolean) (defaults to: ) —

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

  • metadata (Hash{Symbol=>String}) (defaults to: ) —

    Additional data represented as key-value pairs. Both the key and value must be s

  • name (String) (defaults to: ) —

    The name of the virtual account.

  • object (String) (defaults to: )
  • routing_details (Array<ModernTreasury::Models::RoutingDetail>) (defaults to: ) —

    An array of routing detail objects. These will be the routing details of the int

  • updated_at (Time) (defaults to: ) 



# File 'lib/modern_treasury/models/virtual_account.rb', line 106

Instance Attribute Details

#account_details ⇒ Array<ModernTreasury::Models::AccountDetail>

An array of account detail objects.

Returns:



16
 
# File 'lib/modern_treasury/models/virtual_account.rb', line 16

required :account_details, -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::AccountDetail] }

#counterparty_id ⇒ String?

The ID of a counterparty that the virtual account belongs to. Optional.

Returns:

  • (String, nil) 


22
 
# File 'lib/modern_treasury/models/virtual_account.rb', line 22

required :counterparty_id, String, nil?: true

#created_at ⇒ Time

Returns:

  • (Time) 


27
 
# File 'lib/modern_treasury/models/virtual_account.rb', line 27

required :created_at, Time

#credit_ledger_account_id ⇒ String?

The ID of a credit normal ledger account. When money enters the virtual account, this ledger account will be credited. Must be accompanied by a debit_ledger_account_id if present.

Returns:

  • (String, nil) 


35
 
# File 'lib/modern_treasury/models/virtual_account.rb', line 35

required :credit_ledger_account_id, String, nil?: true

#debit_ledger_account_id ⇒ String?

The ID of a debit normal ledger account. When money enters the virtual account, this ledger account will be debited. Must be accompanied by a credit_ledger_account_id if present.

Returns:

  • (String, nil) 


43
 
# File 'lib/modern_treasury/models/virtual_account.rb', line 43

required :debit_ledger_account_id, String, nil?: true

#description ⇒ String?

An optional free-form description for internal use.

Returns:

  • (String, nil) 


49
 
# File 'lib/modern_treasury/models/virtual_account.rb', line 49

required :description, String, nil?: true

#discarded_at ⇒ Time?

Returns:

  • (Time, nil) 


54
 
# File 'lib/modern_treasury/models/virtual_account.rb', line 54

required :discarded_at, Time, nil?: true

#id ⇒ String

Returns:

  • (String) 


10
 
# File 'lib/modern_treasury/models/virtual_account.rb', line 10

required :id, String

#internal_account_id ⇒ String

The ID of the internal account that the virtual account is in.

Returns:

  • (String) 


60
 
# File 'lib/modern_treasury/models/virtual_account.rb', line 60

required :internal_account_id, String

#ledger_account_id ⇒ String?

If the virtual account links to a ledger account in Modern Treasury, the id of the ledger account will be populated here.

Returns:

  • (String, nil) 


67
 
# File 'lib/modern_treasury/models/virtual_account.rb', line 67

required :ledger_account_id, String, nil?: true

#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) 


74
 
# File 'lib/modern_treasury/models/virtual_account.rb', line 74

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

#metadata ⇒ Hash{Symbol=>String}

Additional data represented as key-value pairs. Both the key and value must be strings.

Returns:

  • (Hash{Symbol=>String}) 


81
 
# File 'lib/modern_treasury/models/virtual_account.rb', line 81

required :metadata, ModernTreasury::Internal::Type::HashOf[String]

#name ⇒ String

The name of the virtual account.

Returns:

  • (String) 


87
 
# File 'lib/modern_treasury/models/virtual_account.rb', line 87

required :name, String

#object ⇒ String

Returns:

  • (String) 


92
 
# File 'lib/modern_treasury/models/virtual_account.rb', line 92

required :object, String

#routing_details ⇒ Array<ModernTreasury::Models::RoutingDetail>

An array of routing detail objects. These will be the routing details of the internal account.

Returns:



99
 
# File 'lib/modern_treasury/models/virtual_account.rb', line 99

required :routing_details, -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::RoutingDetail] }

#updated_at ⇒ Time

Returns:

  • (Time) 


104
 
# File 'lib/modern_treasury/models/virtual_account.rb', line 104

required :updated_at, Time