Class: ModernTreasury::Models::ReturnObject

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• ModernTreasury::Models::ReturnObject

Defined in:

lib/modern_treasury/models/return_object.rb

Overview

See Also:

• Resources::Returns#create

Defined Under Namespace

Modules: Code, ReconciliationStatus, ReturnableType, Role, Status, Type Classes: Corrections, ReferenceNumber

Instance Attribute Summary

• #additional_information ⇒ String^?

  Some returns may include additional information from the bank.

• #amount ⇒ Integer

  Value in specified currency’s smallest unit.

• #code ⇒ Symbol, ...

  The return code.

• #corrections ⇒ ModernTreasury::Models::ReturnObject::Corrections^?

  Only relevant for ACH NOC returns.

• #created_at ⇒ Time
• #currency ⇒ Symbol, ModernTreasury::Models::Currency

  Currency that this transaction is denominated in.

• #current_return ⇒ ModernTreasury::Models::ReturnObject^?

  If the return’s status is ‘returned`, this will include the return object’s data that is returning this return.

• #data ⇒ Object^?

  The raw data from the return file that we get from the bank.

• #date_of_death ⇒ Date^?

  If the return code is ‘R14` or `R15` this is the date the deceased counterparty passed away.

• #discarded_at ⇒ Time^?
• #failure_reason ⇒ String^?

  If an originating return failed to be processed by the bank, a description of the failure reason will be available.

• #id ⇒ String
• #internal_account_id ⇒ String^?

  The ID of the relevant Internal Account.

• #ledger_transaction_id ⇒ String^?

  The ID of the ledger transaction linked to the return.

• #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.

• #object ⇒ String
• #reason ⇒ String^?

  Often the bank will provide an explanation for the return, which is a short human readable string.

• #reconciliation_status ⇒ Symbol, ModernTreasury::Models::ReturnObject::ReconciliationStatus

  One of ‘unreconciled`, `tentatively_reconciled` or `reconciled`.

• #reference_numbers ⇒ Array<ModernTreasury::Models::ReturnObject::ReferenceNumber>

  An array of Payment Reference objects.

• #returnable_id ⇒ String^?

  The ID of the object being returned or ‘null`.

• #returnable_type ⇒ Symbol, ...

  The type of object being returned or ‘null`.

• #role ⇒ Symbol, ModernTreasury::Models::ReturnObject::Role

  The role of the return, can be ‘originating` or `receiving`.

• #status ⇒ Symbol, ModernTreasury::Models::ReturnObject::Status

  The current status of the return.

• #transaction_id ⇒ String^?

  The ID of the relevant Transaction or ‘null`.

• #transaction_line_item_id ⇒ String^?

  The ID of the relevant Transaction Line Item or ‘null`.

• #type ⇒ Symbol, ModernTreasury::Models::ReturnObject::Type

  The type of return.

• #updated_at ⇒ Time

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(account_number: nil, company_id: nil, company_name: nil, individual_identification_number: nil, routing_number: nil, transaction_code: nil) ⇒ Object constructor

  Some parameter documentations has been truncated, see Corrections for more details.

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(account_number: nil, company_id: nil, company_name: nil, individual_identification_number: nil, routing_number: nil, transaction_code: nil) ⇒ Object

Some parameter documentations has been truncated, see Corrections for more details.

Only relevant for ACH NOC returns. This is an object containing all of the new and corrected information provided by the bank that was previously incorrect on the original outgoing payment.

Parameters:

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

  The updated account number that should replace the one originally used on the ou

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

  The updated company ID that should replace the one originally used on the outgoi

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

  The updated company name that should replace the one originally used on the outg

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

  The updated individual identification number that should replace the one origina

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

  The updated routing number that should replace the one originally used on the ou

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

  The updated account type code that should replace the one originally used on the

# File 'lib/modern_treasury/models/return_object.rb', line 175

Instance Attribute Details

#additional_information ⇒ String^?

Some returns may include additional information from the bank. In these cases, this string will be present.

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/return_object.rb', line 167

optional :additional_information, String, nil?: true

#amount ⇒ Integer

Value in specified currency’s smallest unit. e.g. $10 would be represented as 1000.

Returns:

• (Integer)

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

required :amount, Integer

#code ⇒ Symbol, ...

The return code. For ACH returns, this is the required ACH return code.

Returns:

• (Symbol, ModernTreasury::Models::ReturnObject::Code, nil)

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

required :code, enum: -> { ModernTreasury::ReturnObject::Code }, nil?: true

#corrections ⇒ ModernTreasury::Models::ReturnObject::Corrections^?

Only relevant for ACH NOC returns. This is an object containing all of the new and corrected information provided by the bank that was previously incorrect on the original outgoing payment.

Returns:

• (ModernTreasury::Models::ReturnObject::Corrections, nil)

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

required :corrections, -> { ModernTreasury::ReturnObject::Corrections }, nil?: true

#created_at ⇒ Time

Returns:

• (Time)

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

required :created_at, Time

#currency ⇒ Symbol, ModernTreasury::Models::Currency

Currency that this transaction is denominated in.

Returns:

• (Symbol, ModernTreasury::Models::Currency)

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

required :currency, enum: -> { ModernTreasury::Currency }

#current_return ⇒ ModernTreasury::Models::ReturnObject^?

If the return’s status is ‘returned`, this will include the return object’s data that is returning this return.

Returns:

• (ModernTreasury::Models::ReturnObject, nil)

# File 'lib/modern_treasury/models/return_object.rb', line 49

required :current_return, -> { ModernTreasury::ReturnObject }, nil?: true

#data ⇒ Object^?

The raw data from the return file that we get from the bank.

Returns:

• (Object, nil)

# File 'lib/modern_treasury/models/return_object.rb', line 173

optional :data, ModernTreasury::Internal::Type::Unknown, nil?: true

#date_of_death ⇒ Date^?

If the return code is ‘R14` or `R15` this is the date the deceased counterparty passed away.

Returns:

• (Date, nil)

# File 'lib/modern_treasury/models/return_object.rb', line 56

required :date_of_death, Date, nil?: true

#discarded_at ⇒ Time^?

Returns:

• (Time, nil)

# File 'lib/modern_treasury/models/return_object.rb', line 61

required :discarded_at, Time, nil?: true

#failure_reason ⇒ String^?

If an originating return failed to be processed by the bank, a description of the failure reason will be available.

Returns:

• (String, nil)

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

required :failure_reason, String, nil?: true

#id ⇒ String

Returns:

• (String)

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

required :id, String

#internal_account_id ⇒ String^?

The ID of the relevant Internal Account.

Returns:

• (String, nil)

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

required :internal_account_id, String, nil?: true

#ledger_transaction_id ⇒ String^?

The ID of the ledger transaction linked to the return.

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/return_object.rb', line 80

required :ledger_transaction_id, String, 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)

# File 'lib/modern_treasury/models/return_object.rb', line 87

required :live_mode, ModernTreasury::Internal::Type::Boolean

#object ⇒ String

Returns:

• (String)

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

required :object, String

#reason ⇒ String^?

Often the bank will provide an explanation for the return, which is a short human readable string.

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/return_object.rb', line 99

required :reason, String, nil?: true

#reconciliation_status ⇒ Symbol, ModernTreasury::Models::ReturnObject::ReconciliationStatus

One of ‘unreconciled`, `tentatively_reconciled` or `reconciled`.

Returns:

• (Symbol, ModernTreasury::Models::ReturnObject::ReconciliationStatus)

# File 'lib/modern_treasury/models/return_object.rb', line 105

required :reconciliation_status, enum: -> { ModernTreasury::ReturnObject::ReconciliationStatus }

#reference_numbers ⇒ Array<ModernTreasury::Models::ReturnObject::ReferenceNumber>

An array of Payment Reference objects.

Returns:

• (Array<ModernTreasury::Models::ReturnObject::ReferenceNumber>)

# File 'lib/modern_treasury/models/return_object.rb', line 111

required :reference_numbers,
-> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::ReturnObject::ReferenceNumber] }

#returnable_id ⇒ String^?

The ID of the object being returned or ‘null`.

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/return_object.rb', line 118

required :returnable_id, String, nil?: true

#returnable_type ⇒ Symbol, ...

The type of object being returned or ‘null`.

Returns:

• (Symbol, ModernTreasury::Models::ReturnObject::ReturnableType, nil)

# File 'lib/modern_treasury/models/return_object.rb', line 124

required :returnable_type, enum: -> { ModernTreasury::ReturnObject::ReturnableType }, nil?: true

#role ⇒ Symbol, ModernTreasury::Models::ReturnObject::Role

The role of the return, can be ‘originating` or `receiving`.

Returns:

• (Symbol, ModernTreasury::Models::ReturnObject::Role)

# File 'lib/modern_treasury/models/return_object.rb', line 130

required :role, enum: -> { ModernTreasury::ReturnObject::Role }

#status ⇒ Symbol, ModernTreasury::Models::ReturnObject::Status

The current status of the return.

Returns:

• (Symbol, ModernTreasury::Models::ReturnObject::Status)

# File 'lib/modern_treasury/models/return_object.rb', line 136

required :status, enum: -> { ModernTreasury::ReturnObject::Status }

#transaction_id ⇒ String^?

The ID of the relevant Transaction or ‘null`.

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/return_object.rb', line 142

required :transaction_id, String, nil?: true

#transaction_line_item_id ⇒ String^?

The ID of the relevant Transaction Line Item or ‘null`.

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/return_object.rb', line 148

required :transaction_line_item_id, String, nil?: true

#type ⇒ Symbol, ModernTreasury::Models::ReturnObject::Type

The type of return. Can be one of: ‘ach`, `ach_noc`, `au_becs`, `bacs`, `eft`, `interac`, `manual`, `paper_item`, `wire`.

Returns:

• (Symbol, ModernTreasury::Models::ReturnObject::Type)

# File 'lib/modern_treasury/models/return_object.rb', line 155

required :type, enum: -> { ModernTreasury::ReturnObject::Type }

#updated_at ⇒ Time

Returns:

• (Time)

# File 'lib/modern_treasury/models/return_object.rb', line 160

required :updated_at, Time

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/modern_treasury/models/return_object.rb', line 333