Class: ModernTreasury::Models::LedgerTransactionCreateRequest

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

Direct Known Subclasses

LedgerTransactionCreateParams

Defined Under Namespace

Modules: LedgerableType, Status

Instance Attribute Summary collapse

Class Method 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(ledger_entries: , description: nil, effective_at: nil, effective_date: nil, external_id: nil, ledgerable_id: nil, ledgerable_type: nil, metadata: nil, status: nil) ⇒ Object

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

Parameters:

  • ledger_entries (Array<ModernTreasury::Models::LedgerEntryCreateRequest>) (defaults to: ) —

    An array of ledger entry objects.

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

    An optional description for internal use.

  • effective_at (Time) (defaults to: nil) —

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

  • effective_date (Date) (defaults to: nil) —

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

  • external_id (String) (defaults to: nil) —

    A unique string to represent the ledger transaction. Only one pending or posted

  • ledgerable_id (String) (defaults to: nil) —

    If the ledger transaction can be reconciled to another object in Modern Treasury

  • ledgerable_type (Symbol, ModernTreasury::Models::LedgerTransactionCreateRequest::LedgerableType) (defaults to: nil) —

    If the ledger transaction can be reconciled to another object in Modern Treasury

  • metadata (Hash{Symbol=>String}) (defaults to: nil) —

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

  • status (Symbol, ModernTreasury::Models::LedgerTransactionCreateRequest::Status) (defaults to: nil) —

    To post a ledger transaction at creation, use ‘posted`.




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

Instance Attribute Details

#description ⇒ String?

An optional description for internal use.

Returns:

  • (String, nil) 


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

optional :description, String, nil?: true

#effective_at ⇒ Time?

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

Returns:

  • (Time, nil) 


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

optional :effective_at, Time

#effective_date ⇒ Date?

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

Returns:

  • (Date, nil) 


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

optional :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) 


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

optional :external_id, String

#ledger_entries ⇒ Array<ModernTreasury::Models::LedgerEntryCreateRequest>

An array of ledger entry objects.

Returns:



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

required :ledger_entries,
-> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::LedgerEntryCreateRequest] }

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


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

optional :ledgerable_id, String

#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:



53
 
# File 'lib/modern_treasury/models/ledger_transaction_create_request.rb', line 53

optional :ledgerable_type, enum: -> { ModernTreasury::LedgerTransactionCreateRequest::LedgerableType }

#metadata ⇒ Hash{Symbol=>String}?

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

Returns:

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


60
 
# File 'lib/modern_treasury/models/ledger_transaction_create_request.rb', line 60

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

#status ⇒ Symbol, ...

To post a ledger transaction at creation, use ‘posted`.

Returns:



66
 
# File 'lib/modern_treasury/models/ledger_transaction_create_request.rb', line 66

optional :status, enum: -> { ModernTreasury::LedgerTransactionCreateRequest::Status }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



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