Class: ModernTreasury::Resources::LedgerEntries

Inherits:
Object
  • Object
show all
Defined in:
lib/modern_treasury/resources/ledger_entries.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ LedgerEntries

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of LedgerEntries.

Parameters:



129
130
131
 
# File 'lib/modern_treasury/resources/ledger_entries.rb', line 129

def initialize(client:)
  @client = client
end

Instance Method Details

#list(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: {}) ⇒ ModernTreasury::Internal::Page<ModernTreasury::Models::LedgerEntry>

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

Get a list of all ledger entries.

Parameters:

  • id (Array<String>) —

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

  • after_cursor (String, nil)
  • 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 ‘

  • direction (Symbol, ModernTreasury::Models::TransactionDirection) —

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

  • effective_at (Hash{Symbol=>Time}) —

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

  • effective_date (Hash{Symbol=>Date}) —

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

  • ledger_account_category_id (String) —

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

  • ledger_account_id (String)
  • ledger_account_lock_version (Hash{Symbol=>Integer}) —

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

  • 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

  • order_by (ModernTreasury::Models::LedgerEntryListParams::OrderBy) —

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

  • per_page (Integer)
  • show_balances (Boolean) —

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

  • show_deleted (Boolean) —

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

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

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

  • updated_at (Hash{Symbol=>Time}) —

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

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

Returns:

See Also:



114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/modern_treasury/resources/ledger_entries.rb', line 114

def list(params = {})
  parsed, options = ModernTreasury::LedgerEntryListParams.dump_request(params)
  @client.request(
    method: :get,
    path: "api/ledger_entries",
    query: parsed,
    page: ModernTreasury::Internal::Page,
    model: ModernTreasury::LedgerEntry,
    options: options
  )
end

#retrieve(id, show_balances: nil, request_options: {}) ⇒ ModernTreasury::Models::LedgerEntry

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

Get details on a single ledger entry.

Parameters:

  • id (String) —

    id

  • show_balances (Boolean) —

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

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

Returns:

See Also:



22
23
24
25
26
27
28
29
30
31
 
# File 'lib/modern_treasury/resources/ledger_entries.rb', line 22

def retrieve(id, params = {})
  parsed, options = ModernTreasury::LedgerEntryRetrieveParams.dump_request(params)
  @client.request(
    method: :get,
    path: ["api/ledger_entries/%1$s", id],
    query: parsed,
    model: ModernTreasury::LedgerEntry,
    options: options
  )
end

#update(id, metadata: nil, request_options: {}) ⇒ ModernTreasury::Models::LedgerEntry

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

Update the details of a ledger entry.

Parameters:

  • id (String) —

    id

  • metadata (Hash{Symbol=>String}) —

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

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

Returns:

See Also:



49
50
51
52
53
54
55
56
57
58
 
# File 'lib/modern_treasury/resources/ledger_entries.rb', line 49

def update(id, params = {})
  parsed, options = ModernTreasury::LedgerEntryUpdateParams.dump_request(params)
  @client.request(
    method: :patch,
    path: ["api/ledger_entries/%1$s", id],
    body: parsed,
    model: ModernTreasury::LedgerEntry,
    options: options
  )
end