Class: ModernTreasury::Models::LedgerEntry

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/modern_treasury/models/ledger_entry.rb,
sig/modern_treasury/models/ledger_entry.rbs

Overview

See Also:

  • ModernTreasury::Resources::LedgerEntries#retrieve

Defined Under Namespace

Modules: Status

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:, amount_string:, created_at:, direction:, discarded_at:, effective_at:, ledger_account_currency:, ledger_account_currency_exponent:, ledger_account_id:, ledger_account_lock_version:, ledger_transaction_id:, live_mode:, metadata:, object:, resulting_ledger_account_balances:, status:, updated_at:) ⇒ Object

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

Parameters:

  • id (String)
  • amount (Integer) —

    Value in specified currency's smallest unit. e.g. $10 would be represented as 10

  • amount_string (String) —

    The amount of the ledger entry as a string, preserving full precision for values

  • created_at (Time)
  • direction (Symbol, ModernTreasury::Models::TransactionDirection) —

    One of credit, debit. Describes the direction money is flowing in the transa

  • discarded_at (Time, nil)
  • effective_at (Time) —

    The timestamp (ISO8601 format) at which the ledger transaction happened for repo

  • ledger_account_currency (String) —

    The currency of the ledger account.

  • ledger_account_currency_exponent (Integer) —

    The currency exponent of the ledger account.

  • ledger_account_id (String) —

    The ledger account that this ledger entry is associated with.

  • ledger_account_lock_version (Integer, nil) —

    Lock version of the ledger account. This can be passed when creating a ledger tr

  • ledger_transaction_id (String) —

    The ledger transaction that this ledger entry is associated with.

  • live_mode (Boolean) —

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

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

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

  • object (String)
  • resulting_ledger_account_balances (ModernTreasury::Models::LedgerBalances, nil) —

    The pending, posted, and available balances for this ledger entry's ledger accou

  • status (Symbol, ModernTreasury::Models::LedgerEntry::Status) —

    Equal to the state of the ledger transaction when the ledger entry was created.

  • updated_at (Time) 



# File 'lib/modern_treasury/models/ledger_entry.rb', line 128

Instance Attribute Details

#amount ⇒ Integer

Value in specified currency's smallest unit. e.g. $10 would be represented as 1000. Can be any integer up to 36 digits.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


17
 
# File 'lib/modern_treasury/models/ledger_entry.rb', line 17

required :amount, Integer

#amount_string ⇒ String

The amount of the ledger entry as a string, preserving full precision for values that may exceed safe integer limits in some languages.

Parameters:

  • value (String)

Returns:

  • (String) 


24
 
# File 'lib/modern_treasury/models/ledger_entry.rb', line 24

required :amount_string, String

#created_at ⇒ Time

Parameters:

  • value (Time)

Returns:

  • (Time) 


29
 
# File 'lib/modern_treasury/models/ledger_entry.rb', line 29

required :created_at, Time

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

One of credit, debit. Describes the direction money is flowing in the transaction. A credit moves money from your account to someone else's. A debit pulls money from someone else's account to your own. Note that wire, rtp, and check payments will always be credit.

Parameters:

  • value (ModernTreasury::Models::transaction_direction)

Returns:



38
 
# File 'lib/modern_treasury/models/ledger_entry.rb', line 38

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

#discarded_at ⇒ Time?

Parameters:

  • value (Time, nil)

Returns:

  • (Time, nil) 


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

required :discarded_at, Time, nil?: true

#effective_at ⇒ Time

The timestamp (ISO8601 format) at which the ledger transaction happened for reporting purposes.

Parameters:

  • value (Time)

Returns:

  • (Time) 


50
 
# File 'lib/modern_treasury/models/ledger_entry.rb', line 50

required :effective_at, Time

#id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :id, String

#ledger_account_currency ⇒ String

The currency of the ledger account.

Parameters:

  • value (String)

Returns:

  • (String) 


56
 
# File 'lib/modern_treasury/models/ledger_entry.rb', line 56

required :ledger_account_currency, String

#ledger_account_currency_exponent ⇒ Integer

The currency exponent of the ledger account.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


62
 
# File 'lib/modern_treasury/models/ledger_entry.rb', line 62

required :ledger_account_currency_exponent, Integer

#ledger_account_id ⇒ String

The ledger account that this ledger entry is associated with.

Parameters:

  • value (String)

Returns:

  • (String) 


68
 
# File 'lib/modern_treasury/models/ledger_entry.rb', line 68

required :ledger_account_id, String

#ledger_account_lock_version ⇒ Integer?

Lock version of the ledger account. This can be passed when creating a ledger transaction to only succeed if no ledger transactions have posted since the given version. See our post about Designing the Ledgers API with Optimistic Locking for more details.

Parameters:

  • value (Integer, nil)

Returns:

  • (Integer, nil) 


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

required :ledger_account_lock_version, Integer, nil?: true

#ledger_transaction_id ⇒ String

The ledger transaction that this ledger entry is associated with.

Parameters:

  • value (String)

Returns:

  • (String) 


83
 
# File 'lib/modern_treasury/models/ledger_entry.rb', line 83

required :ledger_transaction_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.

Parameters:

  • value (Boolean)

Returns:

  • (Boolean) 


90
 
# File 'lib/modern_treasury/models/ledger_entry.rb', line 90

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.

Parameters:

  • value (::Hash[Symbol, String])

Returns:

  • (Hash{Symbol=>String}) 


97
 
# File 'lib/modern_treasury/models/ledger_entry.rb', line 97

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

#object ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


102
 
# File 'lib/modern_treasury/models/ledger_entry.rb', line 102

required :object, String

#resulting_ledger_account_balances ⇒ ModernTreasury::Models::LedgerBalances?

The pending, posted, and available balances for this ledger entry's ledger account. 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. Please see https://docs.moderntreasury.com/docs/transaction-status-and-balances for more details.

Parameters:

Returns:



114
 
# File 'lib/modern_treasury/models/ledger_entry.rb', line 114

required :resulting_ledger_account_balances, -> { ModernTreasury::LedgerBalances }, nil?: true

#status ⇒ Symbol, ModernTreasury::Models::LedgerEntry::Status

Equal to the state of the ledger transaction when the ledger entry was created. One of pending, posted, or archived.

Parameters:

  • value (ModernTreasury::Models::LedgerEntry::status)

Returns:



121
 
# File 'lib/modern_treasury/models/ledger_entry.rb', line 121

required :status, enum: -> { ModernTreasury::LedgerEntry::Status }

#updated_at ⇒ Time

Parameters:

  • value (Time)

Returns:

  • (Time) 


126
 
# File 'lib/modern_treasury/models/ledger_entry.rb', line 126

required :updated_at, Time

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


83
 
# File 'sig/modern_treasury/models/ledger_entry.rbs', line 83

def to_hash: -> {