Class: ModernTreasury::Models::LedgerTransactionListParams::Amount

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

Instance Attribute 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: nil, after_cursor: nil, amount: nil, effective_at: nil, effective_date: nil, external_id: nil, ledger_account_category_id: nil, ledger_account_id: nil, ledger_account_settlement_id: nil, ledger_id: nil, ledgerable_id: nil, ledgerable_type: nil, metadata: nil, order_by: nil, partially_posts_ledger_transaction_id: nil, per_page: nil, posted_at: nil, reverses_ledger_transaction_id: nil, status: nil, updated_at: nil, request_options: {}) ⇒ Object

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

Parameters:

  • id (Array<String>) (defaults to: nil) —

    If you have specific IDs to retrieve in bulk, you can pass them as query paramet

  • after_cursor (String, nil) (defaults to: nil)
  • amount (ModernTreasury::Models::LedgerTransactionListParams::Amount) (defaults to: nil) —

    Use ‘gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by amount.

  • effective_at (Hash{Symbol=>Time}) (defaults to: nil) —

    Use “gt” (>), “gte” (>=), “lt” (<), “lte” (<=), or “eq” (=) to filter by effecti

  • effective_date (Hash{Symbol=>Time}) (defaults to: nil) —

    Use ‘gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by effecti

  • external_id (String) (defaults to: nil)
  • ledger_account_category_id (String) (defaults to: nil)
  • ledger_account_id (String) (defaults to: nil)
  • ledger_account_settlement_id (String) (defaults to: nil)
  • ledger_id (String) (defaults to: nil)
  • ledgerable_id (String) (defaults to: nil)
  • ledgerable_type (Symbol, ModernTreasury::Models::LedgerTransactionListParams::LedgerableType) (defaults to: nil)
  • metadata (Hash{Symbol=>String}) (defaults to: nil) —

    For example, if you want to query for records with metadata key ‘Type` and value

  • order_by (ModernTreasury::Models::LedgerTransactionListParams::OrderBy) (defaults to: nil) —

    Order by ‘created_at` or `effective_at` in `asc` or `desc` order. For example, t

  • partially_posts_ledger_transaction_id (String) (defaults to: nil)
  • per_page (Integer) (defaults to: nil)
  • posted_at (Hash{Symbol=>Time}) (defaults to: nil) —

    Use ‘gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by the pos

  • reverses_ledger_transaction_id (String) (defaults to: nil)
  • status (Symbol, Array<Symbol, ModernTreasury::Models::LedgerTransactionListParams::Status::UnionMember1>, ModernTreasury::Models::LedgerTransactionListParams::Status) (defaults to: nil)
  • updated_at (Hash{Symbol=>Time}) (defaults to: nil) —

    Use ‘gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by the pos

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


177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/modern_treasury/models/ledger_transaction_list_params.rb', line 177

class Amount < ModernTreasury::Internal::Type::BaseModel
  # @!attribute eq
  #
  #   @return [Integer, nil]
  optional :eq, Integer

  # @!attribute gt
  #
  #   @return [Integer, nil]
  optional :gt, Integer

  # @!attribute gte
  #
  #   @return [Integer, nil]
  optional :gte, Integer

  # @!attribute lt
  #
  #   @return [Integer, nil]
  optional :lt, Integer

  # @!attribute lte
  #
  #   @return [Integer, nil]
  optional :lte, Integer

  # @!method initialize(eq: nil, gt: nil, gte: nil, lt: nil, lte: nil)
  #   Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by amount.
  #
  #   @param eq [Integer]
  #   @param gt [Integer]
  #   @param gte [Integer]
  #   @param lt [Integer]
  #   @param lte [Integer]
end

Instance Attribute Details

#eq ⇒ Integer?

Returns:

  • (Integer, nil) 


181
 
# File 'lib/modern_treasury/models/ledger_transaction_list_params.rb', line 181

optional :eq, Integer

#gt ⇒ Integer?

Returns:

  • (Integer, nil) 


186
 
# File 'lib/modern_treasury/models/ledger_transaction_list_params.rb', line 186

optional :gt, Integer

#gte ⇒ Integer?

Returns:

  • (Integer, nil) 


191
 
# File 'lib/modern_treasury/models/ledger_transaction_list_params.rb', line 191

optional :gte, Integer

#lt ⇒ Integer?

Returns:

  • (Integer, nil) 


196
 
# File 'lib/modern_treasury/models/ledger_transaction_list_params.rb', line 196

optional :lt, Integer

#lte ⇒ Integer?

Returns:

  • (Integer, nil) 


201
 
# File 'lib/modern_treasury/models/ledger_transaction_list_params.rb', line 201

optional :lte, Integer