Class: ModernTreasury::Models::LedgerTransactions::LedgerTransactionVersion

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

Overview

See Also:

Defined Under Namespace

Modules: LedgerableType, Status Classes: LedgerEntry

Instance Attribute Summary collapse

Class Method Summary collapse

Methods inherited from Internal::Type::BaseModel

#==, ==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, #initialize, 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

This class inherits a constructor from ModernTreasury::Internal::Type::BaseModel

Instance Attribute Details

#archived_reason ⇒ String?

System-set reason why the ledger transaction was archived; currently only ‘balance_lock_failure’ for transactions that violated balance constraints. Only populated when archive_on_balance_lock_failure is true and a balance lock violation occurs, otherwise null.

Returns:

  • (String, nil) 


20
 
# File 'lib/modern_treasury/models/ledger_transactions/ledger_transaction_version.rb', line 20

required :archived_reason, String, nil?: true

#created_at ⇒ Time

Returns:

  • (Time) 


25
 
# File 'lib/modern_treasury/models/ledger_transactions/ledger_transaction_version.rb', line 25

required :created_at, Time

#description ⇒ String?

An optional description for internal use.

Returns:

  • (String, nil) 


31
 
# File 'lib/modern_treasury/models/ledger_transactions/ledger_transaction_version.rb', line 31

required :description, String, nil?: true

#effective_at ⇒ Time

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

Returns:

  • (Time) 


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

required :effective_at, Time

#effective_date ⇒ Date

The date (YYYY-MM-DD) on which the ledger transaction happened for reporting purposes.

Returns:

  • (Date) 


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

required :effective_date, Date

#external_id ⇒ String?

A unique string to represent the ledger transaction. Only one pending or posted ledger transaction may have this ID in the ledger.

Returns:

  • (String, nil) 


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

required :external_id, String, nil?: true

#id ⇒ String

Returns:

  • (String) 


11
 
# File 'lib/modern_treasury/models/ledger_transactions/ledger_transaction_version.rb', line 11

required :id, String

#ledger_entries ⇒ Array<ModernTreasury::Models::LedgerTransactions::LedgerTransactionVersion::LedgerEntry>

An array of ledger entry objects.

Returns:



58
59
 
# File 'lib/modern_treasury/models/ledger_transactions/ledger_transaction_version.rb', line 58

required :ledger_entries,
-> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::LedgerTransactions::LedgerTransactionVersion::LedgerEntry] }

#ledger_id ⇒ String

The ID of the ledger this ledger transaction belongs to.

Returns:

  • (String) 


65
 
# File 'lib/modern_treasury/models/ledger_transactions/ledger_transaction_version.rb', line 65

required :ledger_id, String

#ledger_transaction_id ⇒ String

The ID of the ledger transaction

Returns:

  • (String) 


71
 
# File 'lib/modern_treasury/models/ledger_transactions/ledger_transaction_version.rb', line 71

required :ledger_transaction_id, String

#ledgerable_id ⇒ String?

If the ledger transaction can be reconciled to another object in Modern Treasury, the id will be populated here, otherwise null.

Returns:

  • (String, nil) 


78
 
# File 'lib/modern_treasury/models/ledger_transactions/ledger_transaction_version.rb', line 78

required :ledgerable_id, String, nil?: true

#ledgerable_type ⇒ Symbol, ...

If the ledger transaction can be reconciled to another object in Modern Treasury, the type will be populated here, otherwise null. This can be one of payment_order, incoming_payment_detail, expected_payment, return, or reversal.

Returns:



86
87
88
 
# File 'lib/modern_treasury/models/ledger_transactions/ledger_transaction_version.rb', line 86

required :ledgerable_type,
enum: -> { ModernTreasury::LedgerTransactions::LedgerTransactionVersion::LedgerableType },
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) 


95
 
# File 'lib/modern_treasury/models/ledger_transactions/ledger_transaction_version.rb', line 95

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


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

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

#object ⇒ String

Returns:

  • (String) 


107
 
# File 'lib/modern_treasury/models/ledger_transactions/ledger_transaction_version.rb', line 107

required :object, String

#partially_posts_ledger_transaction_id ⇒ String?

The ID of the ledger transaction that this ledger transaction partially posts.

Returns:

  • (String, nil) 


113
 
# File 'lib/modern_treasury/models/ledger_transactions/ledger_transaction_version.rb', line 113

required :partially_posts_ledger_transaction_id, String, nil?: true

#posted_at ⇒ Time?

The time on which the ledger transaction posted. This is null if the ledger transaction is pending.

Returns:

  • (Time, nil) 


120
 
# File 'lib/modern_treasury/models/ledger_transactions/ledger_transaction_version.rb', line 120

required :posted_at, Time, nil?: true

#reversed_by_ledger_transaction_id ⇒ String?

The ID of the ledger transaction that reversed this ledger transaction.

Returns:

  • (String, nil) 


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

required :reversed_by_ledger_transaction_id, String, nil?: true

#reverses_ledger_transaction_id ⇒ String?

The ID of the original ledger transaction. that this ledger transaction reverses.

Returns:

  • (String, nil) 


133
 
# File 'lib/modern_treasury/models/ledger_transactions/ledger_transaction_version.rb', line 133

required :reverses_ledger_transaction_id, String, nil?: true

#status ⇒ Symbol, ModernTreasury::Models::LedgerTransactions::LedgerTransactionVersion::Status

One of ‘pending`, `posted`, or `archived`.

Returns:



139
 
# File 'lib/modern_treasury/models/ledger_transactions/ledger_transaction_version.rb', line 139

required :status, enum: -> { ModernTreasury::LedgerTransactions::LedgerTransactionVersion::Status }

#version ⇒ Integer

Version number of the ledger transaction.

Returns:

  • (Integer) 


145
 
# File 'lib/modern_treasury/models/ledger_transactions/ledger_transaction_version.rb', line 145

required :version, Integer

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/modern_treasury/models/ledger_transactions/ledger_transaction_version.rb', line 337