Class: ModernTreasury::Models::LedgerTransactionCreatePartialPostParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/modern_treasury/models/ledger_transaction_create_partial_post_params.rb

Overview

See Also:

Defined Under Namespace

Classes: PostedLedgerEntry

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Method Summary

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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

#description ⇒ String?

An optional free-form description for the posted ledger transaction. Maximum of 1000 characters allowed.

Returns:

  • (String, nil) 


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

optional :description, String

#effective_at ⇒ Time?

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

Returns:

  • (Time, nil) 


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

optional :effective_at, Time

#metadata ⇒ Hash{Symbol=>String}?

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

Returns:

  • (Hash{Symbol=>String}, nil) 


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

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

#posted_ledger_entries ⇒ Array<ModernTreasury::Models::LedgerTransactionCreatePartialPostParams::PostedLedgerEntry>

An array of ledger entry objects to be set on the posted ledger transaction. There must be one entry for each of the existing entries with a lesser amount than the existing entry.

Returns:



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

required :posted_ledger_entries,
-> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::LedgerTransactionCreatePartialPostParams::PostedLedgerEntry] }