Class: ModernTreasury::Models::LedgerEntryListParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• ModernTreasury::Models::LedgerEntryListParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/modern_treasury/models/ledger_entry_list_params.rb

Overview

See Also:

• Resources::LedgerEntries#list

Defined Under Namespace

Modules: Status Classes: Amount, OrderBy

Instance Attribute Summary

• #after_cursor ⇒ String^?
• #amount ⇒ ModernTreasury::Models::LedgerEntryListParams::Amount^?

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

• #as_of_lock_version ⇒ Integer^?

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

• #direction ⇒ Symbol, ...

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

• #effective_at ⇒ Hash{Symbol=>Time}^?

  Use ‘gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by the transaction’s effective time.

• #effective_date ⇒ Hash{Symbol=>Date}^?

  Use ‘gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by the transaction’s effective date.

• #id ⇒ Array<String>^?

  If you have specific IDs to retrieve in bulk, you can pass them as query parameters delimited with ‘id[]=`, for example `?id[]=123&id=abc`.

• #ledger_account_category_id ⇒ String^?

  Get all ledger entries that match the direction specified.

• #ledger_account_id ⇒ String^?
• #ledger_account_lock_version ⇒ Hash{Symbol=>Integer}^?

  Use ‘gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by the lock_version of a ledger account.

• #ledger_account_payout_id ⇒ String^?
• #ledger_account_settlement_id ⇒ String^?
• #ledger_account_statement_id ⇒ String^?

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

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

  For example, if you want to query for records with metadata key ‘Type` and value `Loan`, the query would be `metadata%5BType%5D=Loan`.

• #order_by ⇒ ModernTreasury::Models::LedgerEntryListParams::OrderBy^?

  Order by ‘created_at` or `effective_at` in `asc` or `desc` order.

• #per_page ⇒ Integer^?
• #show_balances ⇒ Boolean^?

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

• #show_deleted ⇒ Boolean^?

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

• #status ⇒ Array<Symbol, ModernTreasury::Models::LedgerEntryListParams::Status>^?

  Get all ledger entries that match the status specified.

• #updated_at ⇒ Hash{Symbol=>Time}^?

  Use ‘gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by the posted at timestamp.

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(eq: nil, gt: nil, gte: nil, lt: nil, lte: nil) ⇒ Object constructor

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

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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(eq: nil, gt: nil, gte: nil, lt: nil, lte: nil) ⇒ Object

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

Parameters:

• eq (Integer) (defaults to: nil)
• gt (Integer) (defaults to: nil)
• gte (Integer) (defaults to: nil)
• lt (Integer) (defaults to: nil)
• lte (Integer) (defaults to: nil)

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

Instance Attribute Details

#after_cursor ⇒ String^?

Returns:

• (String, nil)

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

optional :after_cursor, String, nil?: true

#amount ⇒ ModernTreasury::Models::LedgerEntryListParams::Amount^?

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

Returns:

• (ModernTreasury::Models::LedgerEntryListParams::Amount, nil)

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

optional :amount, -> { ModernTreasury::LedgerEntryListParams::Amount }

#as_of_lock_version ⇒ Integer^?

Shows all ledger entries that were present on a ledger account at a particular ‘lock_version`. You must also specify `ledger_account_id`.

Returns:

• (Integer, nil)

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

optional :as_of_lock_version, Integer

#direction ⇒ Symbol, ...

If true, response will include ledger entries that were deleted. When you update a ledger transaction to specify a new set of entries, the previous entries are deleted.

Returns:

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

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

optional :direction, enum: -> { ModernTreasury::TransactionDirection }

#effective_at ⇒ Hash{Symbol=>Time}^?

Use ‘gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by the transaction’s effective time. Format ISO8601

Returns:

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

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

optional :effective_at, ModernTreasury::Internal::Type::HashOf[Time]

#effective_date ⇒ Hash{Symbol=>Date}^?

Use ‘gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by the transaction’s effective date. Format YYYY-MM-DD

Returns:

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

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

optional :effective_date, ModernTreasury::Internal::Type::HashOf[Date]

#id ⇒ Array<String>^?

If you have specific IDs to retrieve in bulk, you can pass them as query parameters delimited with ‘id[]=`, for example `?id[]=123&id=abc`.

Returns:

• (Array<String>, nil)

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

optional :id, ModernTreasury::Internal::Type::ArrayOf[String]

#ledger_account_category_id ⇒ String^?

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

Returns:

• (String, nil)

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

optional :ledger_account_category_id, String

#ledger_account_id ⇒ String^?

Returns:

• (String, nil)

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

optional :ledger_account_id, String

#ledger_account_lock_version ⇒ Hash{Symbol=>Integer}^?

Use ‘gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by the lock_version of a ledger account. For example, for all entries created at or before before lock_version 1000 of a ledger account, use `ledger_account_lock_version%5Blte%5D=1000`.

Returns:

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

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

optional :ledger_account_lock_version, ModernTreasury::Internal::Type::HashOf[Integer]

#ledger_account_payout_id ⇒ String^?

Returns:

• (String, nil)

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

optional :ledger_account_payout_id, String

#ledger_account_settlement_id ⇒ String^?

Returns:

• (String, nil)

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

optional :ledger_account_settlement_id, String

#ledger_account_statement_id ⇒ String^?

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

Returns:

• (String, nil)

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

optional :ledger_account_statement_id, String

#ledger_transaction_id ⇒ String^?

Returns:

• (String, nil)

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

optional :ledger_transaction_id, String

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

For example, if you want to query for records with metadata key ‘Type` and value `Loan`, the query would be `metadata%5BType%5D=Loan`. This encodes the query parameters.

Returns:

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

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

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

#order_by ⇒ ModernTreasury::Models::LedgerEntryListParams::OrderBy^?

Order by ‘created_at` or `effective_at` in `asc` or `desc` order. For example, to order by `effective_at asc`, use `order_by%5Beffective_at%5D=asc`. Ordering by only one field at a time is supported.

Returns:

• (ModernTreasury::Models::LedgerEntryListParams::OrderBy, nil)

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

optional :order_by, -> { ModernTreasury::LedgerEntryListParams::OrderBy }

#per_page ⇒ Integer^?

Returns:

• (Integer, nil)

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

optional :per_page, Integer

#show_balances ⇒ Boolean^?

If true, response will include the balances attached to the ledger entry. If there is no balance available, null will be returned instead.

Returns:

• (Boolean, nil)

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

optional :show_balances, ModernTreasury::Internal::Type::Boolean

#show_deleted ⇒ Boolean^?

If true, response will include ledger entries that were deleted. When you update a ledger transaction to specify a new set of entries, the previous entries are deleted.

Returns:

• (Boolean, nil)

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

optional :show_deleted, ModernTreasury::Internal::Type::Boolean

#status ⇒ Array<Symbol, ModernTreasury::Models::LedgerEntryListParams::Status>^?

Get all ledger entries that match the status specified. One of ‘pending`, `posted`, or `archived`. For multiple statuses, use `status[]=pending&status=posted`.

Returns:

• (Array<Symbol, ModernTreasury::Models::LedgerEntryListParams::Status>, nil)

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

optional :status,
-> { ModernTreasury::Internal::Type::ArrayOf[enum: ModernTreasury::LedgerEntryListParams::Status] }

#updated_at ⇒ Hash{Symbol=>Time}^?

Use ‘gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by the posted at timestamp. For example, for all times after Jan 1 2000 12:00 UTC, use updated_at%5Bgt%5D=2000-01-01T12:00:00Z.

Returns:

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

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

optional :updated_at, ModernTreasury::Internal::Type::HashOf[Time]

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

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