Class: ModernTreasury::Models::LedgerAccountStatementCreateResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/modern_treasury/models/ledger_account_statement_create_response.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: , created_at: , description: , effective_at_lower_bound: , effective_at_upper_bound: , ending_balance: , ledger_account_id: , ledger_account_lock_version: , ledger_account_normal_balance: , ledger_id: , live_mode: , metadata: , object: , starting_balance: , updated_at: ) ⇒ Object

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

Parameters:

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

    The description of the ledger account statement.

  • effective_at_lower_bound (Time) (defaults to: ) —

    The inclusive lower bound of the effective_at timestamp of the ledger entries to

  • effective_at_upper_bound (Time) (defaults to: ) —

    The exclusive upper bound of the effective_at timestamp of the ledger entries to

  • ending_balance (ModernTreasury::Models::LedgerBalances) (defaults to: ) —

    The pending, posted, and available balances for this ledger account at the ‘effe

  • ledger_account_id (String) (defaults to: ) —

    The id of the ledger account whose ledger entries are queried against, and its b

  • ledger_account_lock_version (Integer) (defaults to: ) —

    Lock version of the ledger account at the time of statement generation.

  • ledger_account_normal_balance (Symbol, ModernTreasury::Models::TransactionDirection) (defaults to: ) —

    The normal balance of the ledger account.

  • ledger_id (String) (defaults to: ) —

    The id of the ledger that this ledger account statement belongs to.

  • 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

  • object (String) (defaults to: )
  • starting_balance (ModernTreasury::Models::LedgerBalances) (defaults to: ) —

    The pending, posted, and available balances for this ledger account at the ‘effe

  • updated_at (Time) (defaults to: ) 



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

Instance Attribute Details

#created_at ⇒ Time

Returns:

  • (Time) 


15
 
# File 'lib/modern_treasury/models/ledger_account_statement_create_response.rb', line 15

required :created_at, Time

#description ⇒ String?

The description of the ledger account statement.

Returns:

  • (String, nil) 


21
 
# File 'lib/modern_treasury/models/ledger_account_statement_create_response.rb', line 21

required :description, String, nil?: true

#effective_at_lower_bound ⇒ Time

The inclusive lower bound of the effective_at timestamp of the ledger entries to be included in the ledger account statement.

Returns:

  • (Time) 


28
 
# File 'lib/modern_treasury/models/ledger_account_statement_create_response.rb', line 28

required :effective_at_lower_bound, Time

#effective_at_upper_bound ⇒ Time

The exclusive upper bound of the effective_at timestamp of the ledger entries to be included in the ledger account statement.

Returns:

  • (Time) 


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

required :effective_at_upper_bound, Time

#ending_balance ⇒ ModernTreasury::Models::LedgerBalances

The pending, posted, and available balances for this ledger account at the ‘effective_at_upper_bound`. The posted balance is the sum of all posted entries on the account. The pending balance is the sum of all pending and posted entries on the account. The available balance is the posted incoming entries minus the sum of the pending and posted outgoing amounts.

Returns:



45
 
# File 'lib/modern_treasury/models/ledger_account_statement_create_response.rb', line 45

required :ending_balance, -> { ModernTreasury::LedgerBalances }

#id ⇒ String

Returns:

  • (String) 


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

required :id, String

#ledger_account_id ⇒ String

The id of the ledger account whose ledger entries are queried against, and its balances are computed as a result.

Returns:

  • (String) 


52
 
# File 'lib/modern_treasury/models/ledger_account_statement_create_response.rb', line 52

required :ledger_account_id, String

#ledger_account_lock_version ⇒ Integer

Lock version of the ledger account at the time of statement generation.

Returns:

  • (Integer) 


58
 
# File 'lib/modern_treasury/models/ledger_account_statement_create_response.rb', line 58

required :ledger_account_lock_version, Integer

#ledger_account_normal_balance ⇒ Symbol, ModernTreasury::Models::TransactionDirection

The normal balance of the ledger account.

Returns:



64
 
# File 'lib/modern_treasury/models/ledger_account_statement_create_response.rb', line 64

required :ledger_account_normal_balance, enum: -> { ModernTreasury::TransactionDirection }

#ledger_id ⇒ String

The id of the ledger that this ledger account statement belongs to.

Returns:

  • (String) 


70
 
# File 'lib/modern_treasury/models/ledger_account_statement_create_response.rb', line 70

required :ledger_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) 


77
 
# File 'lib/modern_treasury/models/ledger_account_statement_create_response.rb', line 77

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


84
 
# File 'lib/modern_treasury/models/ledger_account_statement_create_response.rb', line 84

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

#object ⇒ String

Returns:

  • (String) 


89
 
# File 'lib/modern_treasury/models/ledger_account_statement_create_response.rb', line 89

required :object, String

#starting_balance ⇒ ModernTreasury::Models::LedgerBalances

The pending, posted, and available balances for this ledger account at the ‘effective_at_lower_bound`. The posted balance is the sum of all posted entries on the account. The pending balance is the sum of all pending and posted entries on the account. The available balance is the posted incoming entries minus the sum of the pending and posted outgoing amounts.

Returns:



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

required :starting_balance, -> { ModernTreasury::LedgerBalances }

#updated_at ⇒ Time

Returns:

  • (Time) 


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

required :updated_at, Time