Class: LunchMoney::Calls::Transactions

Inherits:
Base
  • Object
show all
Defined in:
lib/lunchmoney/calls/transactions.rb

Overview

https://lunchmoney.dev/#transactions

Constant Summary

Constants inherited from Base

Base::BASE_URL

Instance Attribute Summary

Attributes inherited from Base

#api_key

Instance Method Summary collapse

Methods inherited from Base

#initialize

Constructor Details

This class inherits a constructor from LunchMoney::Calls::Base

Instance Method Details

#create_transaction_group(date:, payee:, transactions:, category_id: nil, notes: nil, tags: nil) ⇒ Integer, LunchMoney::Errors

Parameters:

  • date (String)
  • payee (String)
  • transactions (Array<Integer, String>)
  • category_id (Integer, nil) (defaults to: nil)
  • notes (String, nil) (defaults to: nil)
  • tags (Array<Integer, String>, nil) (defaults to: nil)

Returns:



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/lunchmoney/calls/transactions.rb', line 180

def create_transaction_group(date:, payee:, transactions:, category_id: nil, notes: nil, tags: nil)
  params = clean_params({
    date:,
    payee:,
    transactions:,
    category_id:,
    notes:,
    tags:,
  })
  response = post("transactions/group", params)

  handle_api_response(response) do |body|
    body
  end
end

#delete_transaction_group(transaction_id) ⇒ Hash{Symbol => Array<Integer>}, LunchMoney::Errors

Parameters:

  • transaction_id (String, Integer)

Returns:



202
203
204
205
206
207
208
 
# File 'lib/lunchmoney/calls/transactions.rb', line 202

def delete_transaction_group(transaction_id)
  response = delete("transactions/group/#{transaction_id}")

  handle_api_response(response) do |body|
    body
  end
end

#insert_transactions(transactions, apply_rules: nil, skip_duplicates: nil, check_for_recurring: nil, debit_as_negative: nil, skip_balance_update: nil) ⇒ Hash{Symbol => Array<Integer>}, LunchMoney::Errors

Parameters:

  • transactions (Array<LunchMoney::Objects::UpdateTransaction>)
  • apply_rules (Boolean, nil) (defaults to: nil)
  • skip_duplicates (Boolean, nil) (defaults to: nil)
  • check_for_recurring (Boolean, nil) (defaults to: nil)
  • debit_as_negative (Boolean, nil) (defaults to: nil)
  • skip_balance_update (Boolean, nil) (defaults to: nil)

Returns:



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/lunchmoney/calls/transactions.rb', line 100

def insert_transactions(transactions, apply_rules: nil, skip_duplicates: nil,
  check_for_recurring: nil, debit_as_negative: nil, skip_balance_update: nil)
  params = clean_params({
    transactions: transactions.map(&:serialize),
    apply_rules:,
    skip_duplicates:,
    check_for_recurring:,
    debit_as_negative:,
    skip_balance_update:,
  })
  response = post("transactions", params)

  handle_api_response(response) do |body|
    body
  end
end

#transaction(transaction_id, debit_as_negative: nil) ⇒ LunchMoney::Objects::Transaction, LunchMoney::Errors

Parameters:

  • transaction_id (Integer)
  • debit_as_negative (Boolean, nil) (defaults to: nil)

Returns:



81
82
83
84
85
86
87
88
 
# File 'lib/lunchmoney/calls/transactions.rb', line 81

def transaction(transaction_id, debit_as_negative: nil)
  params = clean_params({ debit_as_negative: })
  response = get("transactions/#{transaction_id}", query_params: params)

  handle_api_response(response) do |body|
    LunchMoney::Objects::Transaction.new(**body)
  end
end

#transaction_group(transaction_id) ⇒ LunchMoney::Objects::Transaction, LunchMoney::Errors

Parameters:

  • transaction_id (Integer)

Returns:



162
163
164
165
166
167
168
 
# File 'lib/lunchmoney/calls/transactions.rb', line 162

def transaction_group(transaction_id)
  response = get("transactions/group", query_params: { transaction_id: })

  handle_api_response(response) do |body|
    LunchMoney::Objects::Transaction.new(**body)
  end
end

#transactions(tag_id: nil, recurring_id: nil, plaid_account_id: nil, category_id: nil, asset_id: nil, is_group: nil, status: nil, start_date: nil, end_date: nil, debit_as_negative: nil, pending: nil, offset: nil, limit: nil) ⇒ Array<LunchMoney::Objects::Transaction>, LunchMoney::Errors

Parameters:

  • tag_id (Integer, nil) (defaults to: nil)
  • recurring_id (Integer, nil) (defaults to: nil)
  • plaid_account_id (Integer, nil) (defaults to: nil)
  • category_id (Integer, nil) (defaults to: nil)
  • asset_id (Integer, nil) (defaults to: nil)
  • is_group (Boolean, nil) (defaults to: nil)
  • status (String, nil) (defaults to: nil)
  • start_date (String, nil) (defaults to: nil)
  • end_date (String, nil) (defaults to: nil)
  • debit_as_negative (Boolean, nil) (defaults to: nil)
  • pending (Boolean, nil) (defaults to: nil)
  • offset (Integer, nil) (defaults to: nil)
  • limit (Integer, nil) (defaults to: nil)

Returns:



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/lunchmoney/calls/transactions.rb', line 30

def transactions(
  tag_id: nil,
  recurring_id: nil,
  plaid_account_id: nil,
  category_id: nil,
  asset_id: nil,
  is_group: nil,
  status: nil,
  start_date: nil,
  end_date: nil,
  debit_as_negative: nil,
  pending: nil,
  offset: nil,
  limit: nil
)
  params = clean_params({
    tag_id:,
    recurring_id:,
    plaid_account_id:,
    category_id:,
    asset_id:,
    is_group:,
    status:,
    start_date:,
    end_date:,
    debit_as_negative:,
    pending:,
    offset:,
    limit:,
  })
  response = get("transactions", query_params: params)

  handle_api_response(response) do |body|
    body[:transactions].map do |transaction|
      transaction[:tags].map! { |tag| LunchMoney::Objects::TagBase.new(**tag) }

      transaction[:children]&.map! do |child_transaction|
        LunchMoney::Objects::ChildTransaction.new(**child_transaction)
      end

      LunchMoney::Objects::Transaction.new(**transaction)
    end
  end
end

#unsplit_transaction(parent_ids, remove_parents: false) ⇒ Array<Integer>, LunchMoney::Errors

Parameters:

  • parent_ids (Array<Integer>)
  • remove_parents (Boolean, nil) (defaults to: false)

Returns:



152
153
154
155
156
157
158
159
 
# File 'lib/lunchmoney/calls/transactions.rb', line 152

def unsplit_transaction(parent_ids, remove_parents: false)
  params = { parent_ids:, remove_parents: }
  response = post("transactions/unsplit", params)

  handle_api_response(response) do |body|
    body
  end
end

#update_transaction(transaction_id, transaction: nil, split: nil, debit_as_negative: nil, skip_balance_update: nil) ⇒ Hash, LunchMoney::Errors

Parameters:

Returns:

Raises:



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/lunchmoney/calls/transactions.rb', line 126

def update_transaction(transaction_id, transaction: nil, split: nil,
  debit_as_negative: nil, skip_balance_update: nil)
  raise(
    LunchMoney::MissingArgument,
    "Either a transaction or split must be provided",
  ) if transaction.nil? && split.nil?

  params = clean_params({
    transaction: transaction&.serialize,
    split: split&.map!(&:serialize),
    debit_as_negative:,
    skip_balance_update:,
  })
  response = put("transactions/#{transaction_id}", params)

  handle_api_response(response) do |body|
    body
  end
end