Class: ModernTreasury::Models::ReconciliationRule

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

Defined Under Namespace

Modules: Direction, Type

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(amount_lower_bound: , amount_upper_bound: , direction: , internal_account_id: , counterparty_id: nil, currency: nil, custom_identifiers: nil, date_lower_bound: nil, date_upper_bound: nil, type: nil) ⇒ Object

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

Parameters:

  • amount_lower_bound (Integer) (defaults to: ) —

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

  • amount_upper_bound (Integer) (defaults to: ) —

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

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

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

  • internal_account_id (String) (defaults to: ) —

    The ID of the Internal Account for the expected payment

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

    The ID of the counterparty you expect for this payment

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

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

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

    A hash of custom identifiers for this payment

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

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

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

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

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

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




# File 'lib/modern_treasury/models/reconciliation_rule.rb', line 70

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) 


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

required :amount_lower_bound, Integer

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


18
 
# File 'lib/modern_treasury/models/reconciliation_rule.rb', line 18

required :amount_upper_bound, Integer

#counterparty_id ⇒ String?

The ID of the counterparty you expect for this payment

Returns:

  • (String, nil) 


37
 
# File 'lib/modern_treasury/models/reconciliation_rule.rb', line 37

optional :counterparty_id, String, nil?: true

#currency ⇒ Symbol, ...

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

Returns:



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

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

#custom_identifiers ⇒ Hash{Symbol=>String}?

A hash of custom identifiers for this payment

Returns:

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


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

optional :custom_identifiers, ModernTreasury::Internal::Type::HashOf[String], nil?: true

#date_lower_bound ⇒ Date?

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

Returns:

  • (Date, nil) 


55
 
# File 'lib/modern_treasury/models/reconciliation_rule.rb', line 55

optional :date_lower_bound, Date, nil?: true

#date_upper_bound ⇒ Date?

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

Returns:

  • (Date, nil) 


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

optional :date_upper_bound, Date, nil?: true

#direction ⇒ Symbol, ModernTreasury::Models::ReconciliationRule::Direction

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

Returns:



25
 
# File 'lib/modern_treasury/models/reconciliation_rule.rb', line 25

required :direction, enum: -> { ModernTreasury::ReconciliationRule::Direction }

#internal_account_id ⇒ String

The ID of the Internal Account for the expected payment

Returns:

  • (String) 


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

required :internal_account_id, String

#type ⇒ Symbol, ...

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

Returns:



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

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

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



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