Class: ModernTreasury::Models::ExpectedPayment

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

Overview

See Also:

Defined Under Namespace

Modules: Direction, ReconciliationMethod, 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(id: , amount_lower_bound: , amount_upper_bound: , counterparty_id: , created_at: , currency: , date_lower_bound: , date_upper_bound: , description: , direction: , external_id: , internal_account_id: , ledger_transaction_id: , live_mode: , metadata: , object: , reconciliation_filters: , reconciliation_groups: , reconciliation_method: , reconciliation_rule_variables: , remittance_information: , statement_descriptor: , status: , transaction_id: , transaction_line_item_id: , type: , updated_at: ) ⇒ Object

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

Parameters:

  • id (String) (defaults to: )
  • amount_lower_bound (Integer, nil) (defaults to: ) —

    The lowest amount this expected payment may be equal to. Value in specified curr

  • amount_upper_bound (Integer, nil) (defaults to: ) —

    The highest amount this expected payment may be equal to. Value in specified cur

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

    The ID of the counterparty you expect for this payment.

  • created_at (Time) (defaults to: )
  • currency (Symbol, ModernTreasury::Models::Currency, nil) (defaults to: ) —

    Must conform to ISO 4217. Defaults to the currency of the internal account.

  • date_lower_bound (Date, nil) (defaults to: ) —

    The earliest date the payment may come in. Format: yyyy-mm-dd

  • date_upper_bound (Date, nil) (defaults to: ) —

    The latest date the payment may come in. Format: yyyy-mm-dd

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

    An optional description for internal use.

  • direction (Symbol, ModernTreasury::Models::ExpectedPayment::Direction, nil) (defaults to: ) —

    One of credit or debit. When you are receiving money, use credit. When you are b

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

    An optional user-defined 180 character unique identifier.

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

    The ID of the Internal Account for the expected payment.

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

    The ID of the ledger transaction linked to the expected payment.

  • 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

  • object (String) (defaults to: )
  • reconciliation_filters (Object, nil) (defaults to: ) —

    The reconciliation filters you have for this payment.

  • reconciliation_groups (Object, nil) (defaults to: ) —

    The reconciliation groups you have for this payment.

  • reconciliation_method (Symbol, ModernTreasury::Models::ExpectedPayment::ReconciliationMethod, nil) (defaults to: ) —

    One of manual if this expected payment was manually reconciled in the dashboard,

  • reconciliation_rule_variables (Array<ModernTreasury::Models::ReconciliationRule>, nil) (defaults to: ) —

    An array of reconciliation rule variables for this payment.

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

    For ‘ach`, this field will be passed through on an addenda record. For `wire` pa

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

    The statement description you expect to see on the transaction. For ACH payments

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

    One of unreconciled, partially_reconciled, reconciled, or archived.

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

    The ID of the Transaction this expected payment object has been matched to.

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

    The ID of the Transaction Line Item this expected payment has been matched to.

  • type (Symbol, ModernTreasury::Models::ExpectedPaymentType, nil) (defaults to: ) —

    One of: ach, au_becs, bacs, book, check, eft, interac, provxchange, rtp, sen, se

  • updated_at (Time) (defaults to: ) 



# File 'lib/modern_treasury/models/expected_payment.rb', line 182

Instance Attribute Details

#amount_lower_bound ⇒ Integer?

The lowest amount this expected payment may be equal to. Value in specified currency’s smallest unit. e.g. $10 would be represented as 1000.

Returns:

  • (Integer, nil) 


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

required :amount_lower_bound, Integer, nil?: true

#amount_upper_bound ⇒ Integer?

The highest amount this expected payment may be equal to. Value in specified currency’s smallest unit. e.g. $10 would be represented as 1000.

Returns:

  • (Integer, nil) 


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

required :amount_upper_bound, Integer, nil?: true

#counterparty_id ⇒ String?

The ID of the counterparty you expect for this payment.

Returns:

  • (String, nil) 


30
 
# File 'lib/modern_treasury/models/expected_payment.rb', line 30

required :counterparty_id, String, nil?: true

#created_at ⇒ Time

Returns:

  • (Time) 


35
 
# File 'lib/modern_treasury/models/expected_payment.rb', line 35

required :created_at, Time

#currency ⇒ Symbol, ...

Must conform to ISO 4217. Defaults to the currency of the internal account.

Returns:



41
 
# File 'lib/modern_treasury/models/expected_payment.rb', line 41

required :currency, enum: -> { ModernTreasury::Currency }, nil?: true

#date_lower_bound ⇒ Date?

The earliest date the payment may come in. Format: yyyy-mm-dd

Returns:

  • (Date, nil) 


47
 
# File 'lib/modern_treasury/models/expected_payment.rb', line 47

required :date_lower_bound, Date, nil?: true

#date_upper_bound ⇒ Date?

The latest date the payment may come in. Format: yyyy-mm-dd

Returns:

  • (Date, nil) 


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

required :date_upper_bound, Date, nil?: true

#description ⇒ String?

An optional description for internal use.

Returns:

  • (String, nil) 


59
 
# File 'lib/modern_treasury/models/expected_payment.rb', line 59

required :description, String, nil?: true

#direction ⇒ Symbol, ...

One of credit or debit. When you are receiving money, use credit. When you are being charged, use debit.

Returns:



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

required :direction, enum: -> { ModernTreasury::ExpectedPayment::Direction }, nil?: true

#external_id ⇒ String?

An optional user-defined 180 character unique identifier.

Returns:

  • (String, nil) 


72
 
# File 'lib/modern_treasury/models/expected_payment.rb', line 72

required :external_id, String, nil?: true

#id ⇒ String

Returns:

  • (String) 


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

required :id, String

#internal_account_id ⇒ String?

The ID of the Internal Account for the expected payment.

Returns:

  • (String, nil) 


78
 
# File 'lib/modern_treasury/models/expected_payment.rb', line 78

required :internal_account_id, String, nil?: true

#ledger_transaction_id ⇒ String?

The ID of the ledger transaction linked to the expected payment.

Returns:

  • (String, nil) 


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

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) 


91
 
# File 'lib/modern_treasury/models/expected_payment.rb', line 91

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


98
 
# File 'lib/modern_treasury/models/expected_payment.rb', line 98

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

#object ⇒ String

Returns:

  • (String) 


103
 
# File 'lib/modern_treasury/models/expected_payment.rb', line 103

required :object, String

#reconciliation_filters ⇒ Object?

The reconciliation filters you have for this payment.

Returns:

  • (Object, nil) 


109
 
# File 'lib/modern_treasury/models/expected_payment.rb', line 109

required :reconciliation_filters, ModernTreasury::Internal::Type::Unknown, nil?: true

#reconciliation_groups ⇒ Object?

The reconciliation groups you have for this payment.

Returns:

  • (Object, nil) 


115
 
# File 'lib/modern_treasury/models/expected_payment.rb', line 115

required :reconciliation_groups, ModernTreasury::Internal::Type::Unknown, nil?: true

#reconciliation_method ⇒ Symbol, ...

One of manual if this expected payment was manually reconciled in the dashboard, automatic if it was automatically reconciled by Modern Treasury, or null if it is unreconciled.

Returns:



123
124
125
 
# File 'lib/modern_treasury/models/expected_payment.rb', line 123

required :reconciliation_method,
enum: -> { ModernTreasury::ExpectedPayment::ReconciliationMethod },
nil?: true

#reconciliation_rule_variables ⇒ Array<ModernTreasury::Models::ReconciliationRule>?

An array of reconciliation rule variables for this payment.

Returns:



131
132
133
 
# File 'lib/modern_treasury/models/expected_payment.rb', line 131

required :reconciliation_rule_variables,
-> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::ReconciliationRule] },
nil?: true

#remittance_information ⇒ String?

For ‘ach`, this field will be passed through on an addenda record. For `wire` payments the field will be passed through as the “Originator to Beneficiary Information”, also known as OBI or Fedwire tag 6000.

Returns:

  • (String, nil) 


141
 
# File 'lib/modern_treasury/models/expected_payment.rb', line 141

required :remittance_information, String, nil?: true

#statement_descriptor ⇒ String?

The statement description you expect to see on the transaction. For ACH payments, this will be the full line item passed from the bank. For wire payments, this will be the OBI field on the wire. For check payments, this will be the memo field.

Returns:

  • (String, nil) 


150
 
# File 'lib/modern_treasury/models/expected_payment.rb', line 150

required :statement_descriptor, String, nil?: true

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

One of unreconciled, partially_reconciled, reconciled, or archived.

Returns:



156
 
# File 'lib/modern_treasury/models/expected_payment.rb', line 156

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

#transaction_id ⇒ String?

The ID of the Transaction this expected payment object has been matched to.

Returns:

  • (String, nil) 


162
 
# File 'lib/modern_treasury/models/expected_payment.rb', line 162

required :transaction_id, String, nil?: true

#transaction_line_item_id ⇒ String?

The ID of the Transaction Line Item this expected payment has been matched to.

Returns:

  • (String, nil) 


168
 
# File 'lib/modern_treasury/models/expected_payment.rb', line 168

required :transaction_line_item_id, String, nil?: true

#type ⇒ Symbol, ...

One of: ach, au_becs, bacs, book, check, eft, interac, provxchange, rtp, sen, sepa, signet, wire.

Returns:



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

required :type, enum: -> { ModernTreasury::ExpectedPaymentType }, nil?: true

#updated_at ⇒ Time

Returns:

  • (Time) 


180
 
# File 'lib/modern_treasury/models/expected_payment.rb', line 180

required :updated_at, Time

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/modern_treasury/models/expected_payment.rb', line 250