Class: ModernTreasury::Models::LedgerEntryListParams::Amount

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/modern_treasury/models/ledger_entry_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, as_of_lock_version: nil, direction: nil, effective_at: nil, effective_date: nil, ledger_account_category_id: nil, ledger_account_id: nil, ledger_account_lock_version: nil, ledger_account_payout_id: nil, ledger_account_settlement_id: nil, ledger_account_statement_id: nil, ledger_transaction_id: nil, metadata: nil, order_by: nil, per_page: nil, show_balances: nil, show_deleted: nil, status: nil, updated_at: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see ModernTreasury::Models::LedgerEntryListParams 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::LedgerEntryListParams::Amount) (defaults to: nil) —

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

  • as_of_lock_version (Integer) (defaults to: nil) —

    Shows all ledger entries that were present on a ledger account at a particular ‘

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

    If true, response will include ledger entries that were deleted. When you update

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

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

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

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

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

    Get all ledger entries that match the direction specified. One of ‘credit`, `deb

  • ledger_account_id (String) (defaults to: nil)
  • ledger_account_lock_version (Hash{Symbol=>Integer}) (defaults to: nil) —

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

  • ledger_account_payout_id (String) (defaults to: nil)
  • ledger_account_settlement_id (String) (defaults to: nil)
  • ledger_account_statement_id (String) (defaults to: nil) —

    Get all ledger entries that are included in the ledger account statement.

  • ledger_transaction_id (String) (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::LedgerEntryListParams::OrderBy) (defaults to: nil) —

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

  • per_page (Integer) (defaults to: nil)
  • show_balances (Boolean) (defaults to: nil) —

    If true, response will include the balances attached to the ledger entry. If the

  • show_deleted (Boolean) (defaults to: nil) —

    If true, response will include ledger entries that were deleted. When you update

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

    Get all ledger entries that match the status specified. One of ‘pending`, `poste

  • 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: {}) 


199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/modern_treasury/models/ledger_entry_list_params.rb', line 199

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) 


203
 
# File 'lib/modern_treasury/models/ledger_entry_list_params.rb', line 203

optional :eq, Integer

#gt ⇒ Integer?

Returns:

  • (Integer, nil) 


208
 
# File 'lib/modern_treasury/models/ledger_entry_list_params.rb', line 208

optional :gt, Integer

#gte ⇒ Integer?

Returns:

  • (Integer, nil) 


213
 
# File 'lib/modern_treasury/models/ledger_entry_list_params.rb', line 213

optional :gte, Integer

#lt ⇒ Integer?

Returns:

  • (Integer, nil) 


218
 
# File 'lib/modern_treasury/models/ledger_entry_list_params.rb', line 218

optional :lt, Integer

#lte ⇒ Integer?

Returns:

  • (Integer, nil) 


223
 
# File 'lib/modern_treasury/models/ledger_entry_list_params.rb', line 223

optional :lte, Integer