Class: ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest

Defined in:

lib/modern_treasury/models/bulk_request_create_params.rb,
sig/modern_treasury/models/bulk_request_create_params.rbs

Defined Under Namespace

Modules: AmountReconciledDirection, AmountUnreconciledDirection, Direction Classes: LineItem

Constant Summary

ModernTreasury =

Returns:

• (:LedgerTransactionCreateRequest)

Instance Attribute Summary

• #amount_lower_bound ⇒ Integer^?

  The lowest amount this expected payment may be equal to.

• #amount_reconciled ⇒ Integer^?

  The amount reconciled for this expected payment.

• #amount_reconciled_direction ⇒ Symbol, ...

  One of credit or debit.

• #amount_unreconciled ⇒ Integer^?

  The amount that remains unreconciled for this expected payment.

• #amount_unreconciled_direction ⇒ Symbol, ...

  One of credit or debit.

• #amount_upper_bound ⇒ Integer^?

  The highest amount this expected payment may be equal to.

• #counterparty_id ⇒ String^?

  The ID of the counterparty you expect for this payment.

• #currency ⇒ Symbol, ...

  Must conform to ISO 4217.

• #date_lower_bound ⇒ Date^?

  The earliest date the payment may come in.

• #date_upper_bound ⇒ Date^?

  The latest date the payment may come in.

• #description ⇒ String^?

  An optional description for internal use.

• #direction ⇒ Symbol, ...

  One of credit or debit.

• #external_id ⇒ String^?

  An optional user-defined 180 character unique identifier.

• #internal_account_id ⇒ String^?

  The ID of the Internal Account for the expected payment.

• #ledger_transaction ⇒ ModernTreasury::Models::LedgerTransactionCreateRequest^?

  Specifies a ledger transaction object that will be created with the expected payment.

• #ledger_transaction_id ⇒ String^?

  Either ledger_transaction or ledger_transaction_id can be provided.

• #line_items ⇒ Array<ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest::LineItem>^?
• #metadata ⇒ Hash{Symbol=>String}^?

  Additional data represented as key-value pairs.

• #reconciliation_filters ⇒ Object^?

  The reconciliation filters you have for this payment.

• #reconciliation_groups ⇒ Object^?

  The reconciliation groups you have for this payment.

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

  An array of reconciliation rule variables for this payment.

• #remittance_information ⇒ String^?

  For ach, this field will be passed through on an addenda record.

• #statement_descriptor ⇒ String^?

  The statement description you expect to see on the transaction.

• #type ⇒ Symbol, ...

  One of: ach, au_becs, bacs, book, check, eft, rtp, sepa, wire.

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(amount_lower_bound: nil, amount_reconciled: nil, amount_reconciled_direction: nil, amount_unreconciled: nil, amount_unreconciled_direction: nil, amount_upper_bound: nil, counterparty_id: nil, currency: nil, date_lower_bound: nil, date_upper_bound: nil, description: nil, direction: nil, external_id: nil, internal_account_id: nil, ledger_transaction: nil, ledger_transaction_id: nil, line_items: nil, metadata: nil, reconciliation_filters: nil, reconciliation_groups: nil, reconciliation_rule_variables: nil, remittance_information: nil, statement_descriptor: nil, type: nil) ⇒ Object constructor

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

• #to_hash ⇒ {

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(amount_lower_bound: nil, amount_reconciled: nil, amount_reconciled_direction: nil, amount_unreconciled: nil, amount_unreconciled_direction: nil, amount_upper_bound: nil, counterparty_id: nil, currency: nil, date_lower_bound: nil, date_upper_bound: nil, description: nil, direction: nil, external_id: nil, internal_account_id: nil, ledger_transaction: nil, ledger_transaction_id: nil, line_items: nil, metadata: nil, reconciliation_filters: nil, reconciliation_groups: nil, reconciliation_rule_variables: nil, remittance_information: nil, statement_descriptor: nil, type: nil) ⇒ Object

Some parameter documentations has been truncated, see ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest for more details.

Parameters:

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

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

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

  The amount reconciled for this expected payment. Value in specified currency's s

• amount_reconciled_direction (Symbol, ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest::AmountReconciledDirection, nil) (defaults to: nil) —

  One of credit or debit. Indicates whether amount_reconciled is a credit or debit

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

  The amount that remains unreconciled for this expected payment. Value in specifi

• amount_unreconciled_direction (Symbol, ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest::AmountUnreconciledDirection, nil) (defaults to: nil) —

  One of credit or debit. Indicates whether amount_unreconciled is a credit or deb

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

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

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

  The ID of the counterparty you expect for this payment.

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

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

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

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

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

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

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

  An optional description for internal use.

• direction (Symbol, ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest::Direction, nil) (defaults to: nil) —

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

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

  An optional user-defined 180 character unique identifier.

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

  The ID of the Internal Account for the expected payment.

• ledger_transaction (ModernTreasury::Models::LedgerTransactionCreateRequest) (defaults to: nil) —

  Specifies a ledger transaction object that will be created with the expected pay

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

  Either ledger_transaction or ledger_transaction_id can be provided. Only a pendi

• line_items (Array<ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest::LineItem>) (defaults to: nil)
• metadata (Hash{Symbol=>String}) (defaults to: nil) —

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

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

  The reconciliation filters you have for this payment.

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

  The reconciliation groups you have for this payment.

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

  An array of reconciliation rule variables for this payment.

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

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

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

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

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

  One of: ach, au_becs, bacs, book, check, eft, rtp, sepa, wire.

# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 1259

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.

Parameters:

• value (Integer, nil)

Returns:

• (Integer, nil)

# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 1087

optional :amount_lower_bound, Integer, nil?: true

#amount_reconciled ⇒ Integer^?

The amount reconciled for this expected payment. Value in specified currency's smallest unit. e.g. $10 would be represented as 1000.

Parameters:

• value (Integer, nil)

Returns:

• (Integer, nil)

# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 1094

optional :amount_reconciled, Integer, nil?: true

#amount_reconciled_direction ⇒ Symbol, ...

One of credit or debit. Indicates whether amount_reconciled is a credit or debit amount.

Parameters:

• value (ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest::amount_reconciled_direction, nil)

Returns:

• (Symbol, ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest::AmountReconciledDirection, nil)

# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 1101

optional :amount_reconciled_direction,
enum: -> {
  ModernTreasury::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest::AmountReconciledDirection
},
nil?: true

#amount_unreconciled ⇒ Integer^?

The amount that remains unreconciled for this expected payment. Value in specified currency's smallest unit. e.g. $10 would be represented as 1000.

Parameters:

• value (Integer, nil)

Returns:

• (Integer, nil)

# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 1112

optional :amount_unreconciled, Integer, nil?: true

#amount_unreconciled_direction ⇒ Symbol, ...

One of credit or debit. Indicates whether amount_unreconciled is a credit or debit amount.

Parameters:

• value (ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest::amount_unreconciled_direction, nil)

Returns:

• (Symbol, ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest::AmountUnreconciledDirection, nil)

# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 1119

optional :amount_unreconciled_direction,
enum: -> {
  ModernTreasury::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest::AmountUnreconciledDirection
},
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.

Parameters:

• value (Integer, nil)

Returns:

• (Integer, nil)

# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 1130

optional :amount_upper_bound, Integer, nil?: true

#counterparty_id ⇒ String^?

The ID of the counterparty you expect for this payment.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 1136

optional :counterparty_id, String, nil?: true

#currency ⇒ Symbol, ...

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

Parameters:

• value (ModernTreasury::Models::currency, nil)

Returns:

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

# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 1142

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

#date_lower_bound ⇒ Date^?

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

Parameters:

• value (Date, nil)

Returns:

• (Date, nil)

# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 1148

optional :date_lower_bound, Date, nil?: true

#date_upper_bound ⇒ Date^?

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

Parameters:

• value (Date, nil)

Returns:

• (Date, nil)

# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 1154

optional :date_upper_bound, Date, nil?: true

#description ⇒ String^?

An optional description for internal use.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 1160

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

Parameters:

• value (ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest::direction, nil)

Returns:

• (Symbol, ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest::Direction, nil)

# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 1167

optional :direction,
enum: -> {
  ModernTreasury::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest::Direction
},
nil?: true

#external_id ⇒ String^?

An optional user-defined 180 character unique identifier.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 1177

optional :external_id, String, nil?: true

#internal_account_id ⇒ String^?

The ID of the Internal Account for the expected payment.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 1183

optional :internal_account_id, String, nil?: true

#ledger_transaction ⇒ ModernTreasury::Models::LedgerTransactionCreateRequest^?

Specifies a ledger transaction object that will be created with the expected payment. If the ledger transaction cannot be created, then the expected payment creation will fail. The resulting ledger transaction will mirror the status of the expected payment.

Returns:

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

# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 1192

optional :ledger_transaction, -> { ModernTreasury::LedgerTransactionCreateRequest }

#ledger_transaction_id ⇒ String^?

Either ledger_transaction or ledger_transaction_id can be provided. Only a pending ledger transaction can be attached upon expected payment creation. Once the expected payment is created, the status of the ledger transaction tracks the expected payment automatically.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 1201

optional :ledger_transaction_id, String

#line_items ⇒ Array<ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest::LineItem>^?

Returns:

• (Array<ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest::LineItem>, nil)

# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 1206

optional :line_items,
-> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest::LineItem] }

#metadata ⇒ Hash{Symbol=>String}^?

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

Parameters:

• (::Hash[Symbol, String])

Returns:

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

# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 1214

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

#reconciliation_filters ⇒ Object^?

The reconciliation filters you have for this payment.

Parameters:

• value (top, nil)

Returns:

• (Object, nil)

# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 1220

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

#reconciliation_groups ⇒ Object^?

The reconciliation groups you have for this payment.

Parameters:

• value (top, nil)

Returns:

• (Object, nil)

# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 1226

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

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

An array of reconciliation rule variables for this payment.

Parameters:

• value (::Array[ModernTreasury::ReconciliationRule], nil)

Returns:

• (Array<ModernTreasury::Models::ReconciliationRule>, nil)

# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 1232

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

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 1242

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

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 1251

optional :statement_descriptor, String, nil?: true

#type ⇒ Symbol, ...

One of: ach, au_becs, bacs, book, check, eft, rtp, sepa, wire.

Parameters:

• value (ModernTreasury::Models::expected_payment_type, nil)

Returns:

• (Symbol, ModernTreasury::Models::ExpectedPaymentType, nil)

# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 1257

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

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 1322

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/modern_treasury/models/bulk_request_create_params.rbs', line 1007

def to_hash: -> {