Class: ModernTreasury::Models::LedgerAccountCategory

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/modern_treasury/models/ledger_account_category.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: , balances: , created_at: , description: , discarded_at: , external_id: , ledger_id: , live_mode: , metadata: , name: , normal_balance: , object: , updated_at: ) ⇒ Object

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

Parameters:

  • id (String) (defaults to: )
  • balances (ModernTreasury::Models::LedgerBalances) (defaults to: ) —

    The pending, posted, and available balances for this ledger account category. Th

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

    The description of the ledger account category.

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

    An optional user-defined 180 character unique identifier.

  • ledger_id (String) (defaults to: ) —

    The id of the ledger that this account category 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

  • name (String) (defaults to: ) —

    The name of the ledger account category.

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

    The normal balance of the ledger account category.

  • object (String) (defaults to: )
  • updated_at (Time) (defaults to: ) 



# File 'lib/modern_treasury/models/ledger_account_category.rb', line 86

Instance Attribute Details

#balances ⇒ ModernTreasury::Models::LedgerBalances

The pending, posted, and available balances for this ledger account category. 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:



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

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

#created_at ⇒ Time

Returns:

  • (Time) 


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

required :created_at, Time

#description ⇒ String?

The description of the ledger account category.

Returns:

  • (String, nil) 


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

required :description, String, nil?: true

#discarded_at ⇒ Time?

Returns:

  • (Time, nil) 


36
 
# File 'lib/modern_treasury/models/ledger_account_category.rb', line 36

required :discarded_at, Time, nil?: true

#external_id ⇒ String?

An optional user-defined 180 character unique identifier.

Returns:

  • (String, nil) 


42
 
# File 'lib/modern_treasury/models/ledger_account_category.rb', line 42

required :external_id, String, nil?: true

#id ⇒ String

Returns:

  • (String) 


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

required :id, String

#ledger_id ⇒ String

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

Returns:

  • (String) 


48
 
# File 'lib/modern_treasury/models/ledger_account_category.rb', line 48

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) 


55
 
# File 'lib/modern_treasury/models/ledger_account_category.rb', line 55

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


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

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

#name ⇒ String

The name of the ledger account category.

Returns:

  • (String) 


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

required :name, String

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

The normal balance of the ledger account category.

Returns:



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

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

#object ⇒ String

Returns:

  • (String) 


79
 
# File 'lib/modern_treasury/models/ledger_account_category.rb', line 79

required :object, String

#updated_at ⇒ Time

Returns:

  • (Time) 


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

required :updated_at, Time