Class: ModernTreasury::Models::LedgerTransactionCreateReversalParams

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_reversal_params.rb

Overview

See Also:

Defined Under Namespace

Modules: LedgerableType, Status

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary collapse

Instance Method Summary collapse

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, 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(description: nil, effective_at: nil, external_id: nil, ledgerable_id: nil, ledgerable_type: nil, metadata: nil, status: nil, request_options: {}) ⇒ Object

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

Parameters:

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

    An optional free-form description for the reversal ledger transaction. Maximum o

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

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

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

    Must be unique within the ledger.

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

    Specify this if you’d like to link the reversal ledger transaction to a Payment

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

    Specify this if you’d like to link the reversal ledger transaction to a Payment

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

    Additional data to be added to the reversal ledger transaction as key-value pair

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

    Status of the reversal ledger transaction. It defaults to ‘posted` if not provid

  • request_options (ModernTreasury::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



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

Instance Attribute Details

#description ⇒ String?

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

Returns:

  • (String, nil) 


15
 
# File 'lib/modern_treasury/models/ledger_transaction_create_reversal_params.rb', line 15

optional :description, String

#effective_at ⇒ Time?

The timestamp (ISO8601 format) at which the reversal ledger transaction happened for reporting purposes. It defaults to the ‘effective_at` of the original ledger transaction if not provided.

Returns:

  • (Time, nil) 


23
 
# File 'lib/modern_treasury/models/ledger_transaction_create_reversal_params.rb', line 23

optional :effective_at, Time, nil?: true

#external_id ⇒ String?

Must be unique within the ledger.

Returns:

  • (String, nil) 


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

optional :external_id, String

#ledgerable_id ⇒ String?

Specify this if you’d like to link the reversal ledger transaction to a Payment object like Return or Reversal.

Returns:

  • (String, nil) 


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

optional :ledgerable_id, String

#ledgerable_type ⇒ Symbol, ...

Specify this if you’d like to link the reversal ledger transaction to a Payment object like Return or Reversal.

Returns:



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

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

#metadata ⇒ Hash{Symbol=>String}?

Additional data to be added to the reversal ledger transaction as key-value pairs. Both the key and value must be strings.

Returns:

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


51
 
# File 'lib/modern_treasury/models/ledger_transaction_create_reversal_params.rb', line 51

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

#status ⇒ Symbol, ...

Status of the reversal ledger transaction. It defaults to ‘posted` if not provided.

Returns:



58
 
# File 'lib/modern_treasury/models/ledger_transaction_create_reversal_params.rb', line 58

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

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/modern_treasury/models/ledger_transaction_create_reversal_params.rb', line 92