Class: Invoice

Inherits:
ActiveRecord::Base
  • Object
show all
Defined in:
app/models/invoice.rb

Overview

Table Definition ###########################

create_table :invoices do |t|
  t.string     :invoice_number
  t.string     :description
  t.string     :message
  t.date       :invoice_date
  t.date       :due_date
  t.string     :external_identifier
  t.string     :external_id_source
  t.references :product
  t.references :invoice_type
  t.references :billing_account
  t.references :invoice_payment_strategy_type
  t.references :balance
  t.references :calculate_balance_strategy_type

  t.timestamps
end

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.apply_filters(filters, statement = nil) ⇒ ActiveRecord::Relation

Filter records

Parameters:

  • filters (Hash) —

    a hash of filters to be applied,

  • statement (ActiveRecord::Relation) (defaults to: nil) —

    the query being built

Returns:

  • (ActiveRecord::Relation) —

    the query being built



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'app/models/invoice.rb', line 68

def apply_filters(filters, statement=nil)
  if statement.nil?
    statement = self
  end

  unless filters[:status].blank?
    if filters[:status] == 'open'
      statement = statement.open
    end

    if filters[:status] == 'closed'
      statement = statement.closed
    end
  end

  statement
end

.closed ⇒ Object 



223
224
225
 
# File 'app/models/invoice.rb', line 223

def closed
  Invoice.with_current_status(['invoice_statuses_closed'])
end

.generate_from_order(order_txn, options = {}) ⇒ Object

generate an invoice from a order_txn options include message - Message to display on Invoice invoice_date - Date of Invoice due_date - Due date of Invoice taxation - context for taxation

{
  is_online_sale: true,
      origin_address: {
      state: "FL"
  },
      destination_address: {
      state: "FL"
  }
}



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'app/models/invoice.rb', line 102

def generate_from_order(order_txn, options={})
  ActiveRecord::Base.connection.transaction do
    invoice = Invoice.new

    # create invoice
    invoice.invoice_number = next_invoice_number
    invoice.description = "Invoice for #{order_txn.order_number.to_s}"
    invoice.message = options[:message]
    invoice.invoice_date = options[:invoice_date]
    invoice.due_date = options[:due_date]

    invoice.save

    invoice.current_status = 'invoice_statuses_open'

    # add customer relationship
    party = order_txn.find_party_by_role('order_roles_customer')
    invoice.add_party_with_role_type(party, RoleType.customer)

    dba_organization = options[:dba_organization] || order_txn.find_party_by_role(RoleType.iid('dba_org'))
    invoice.add_party_with_role_type(dba_organization, RoleType.dba_org)

    order_txn.order_line_items.each do |line_item|
      invoice_item = InvoiceItem.new

      invoice_item.invoice = invoice

      charged_item = line_item.product_instance || line_item.product_offer ||line_item.product_type

      invoice_item.item_description = charged_item.description
      invoice_item.quantity = line_item.quantity
      invoice_item.unit_price = line_item.sold_price
      invoice_item.amount = (line_item.quantity * line_item.sold_price)
      invoice_item.taxed = line_item.taxed?
      invoice_item.biz_txn_acct_root = charged_item.try(:biz_txn_acct_root)
      invoice_item.add_invoiced_record(charged_item)

      invoice.invoice_items << invoice_item

      invoice_item.save
    end

    # handles everything but shipping charge lines, multiple invoice items created from all iterations
    order_txn.all_charge_lines.select { |charge_line| charge_line.charge_type && charge_line.charge_type.internal_identifier != 'shipping' }.each do |charge_line|
      invoice_item = InvoiceItem.new

      invoice_item.invoice = invoice
      charged_item = charge_line.charged_item
      invoice_item.item_description = charge_line.description

      # set data based on charged item either a OrderTxn or OrderLineItem
      if charged_item.is_a?(OrderLineItem)
        invoice_item.quantity = charged_item.quantity
        invoice_item.unit_price = charged_item.sold_price
        invoice_item.amount = charged_item.sold_amount
        invoice_item.add_invoiced_record(charged_item.line_item_record)
        invoice_item.taxed = charged_item.taxed?
      elsif charged_item.is_a?(OrderTxn)
        invoice_item.quantity = 1
        invoice_item.unit_price = charge_line.money.amount
        invoice_item.amount = charge_line.money.amount
        invoice_item.add_invoiced_record(charge_line)
      end

      invoice.invoice_items << invoice_item

      invoice_item.save!
    end

    # handles shipping charge lines, one invoice item created from all iterations
    shipping_charges = order_txn.all_charge_lines.select { |charge_line| charge_line.charge_type && charge_line.charge_type.internal_identifier == 'shipping' }
    if shipping_charges.length > 0
      shipping_invoice_item = InvoiceItem.new
      shipping_charges.each do |charge_line|
        shipping_invoice_item.item_description = charge_line.description
        shipping_invoice_item.invoice = invoice
        shipping_invoice_item.quantity = 1
        shipping_invoice_item.amount = shipping_invoice_item.unit_price.nil? ? charge_line.money.amount : shipping_invoice_item.unit_price + charge_line.money.amount
        shipping_invoice_item.unit_price = shipping_invoice_item.unit_price.nil? ? charge_line.money.amount : shipping_invoice_item.unit_price + charge_line.money.amount
        shipping_invoice_item.taxed = charge_line.taxed?
        shipping_invoice_item.add_invoiced_record(charge_line)

        invoice.invoice_items << shipping_invoice_item
      end
      shipping_invoice_item.save
    end

    invoice.generated_by = order_txn

    # calculate taxes
    invoice.calculate_tax(options[:taxation])

    invoice
  end
end

.hold ⇒ Object 



227
228
229
 
# File 'app/models/invoice.rb', line 227

def hold
  Invoice.with_current_status(['invoice_statuses_hold'])
end

.next_invoice_number ⇒ Object 



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'app/models/invoice.rb', line 198

def next_invoice_number
  max_id = maximum('id')

  current_invoice = where(Invoice.arel_table[:invoice_number].matches("%#{max_id}%")).first

  if current_invoice
    while current_invoice
      max_id = max_id + 1
      current_invoice = where(Invoice.arel_table[:invoice_number].matches("%#{max_id}%")).first
    end
  else
    if max_id
      max_id = max_id + 1
    else
      max_id = 1
    end
  end

  "Inv-#{max_id}"
end

.open ⇒ Object 



219
220
221
 
# File 'app/models/invoice.rb', line 219

def open
  Invoice.with_current_status(['invoice_statuses_open'])
end

.sent ⇒ Object 



231
232
233
 
# File 'app/models/invoice.rb', line 231

def sent
  Invoice.with_current_status(['invoice_statuses_sent'])
end

Instance Method Details

#add_party_with_role_type(party, role_type) ⇒ Object 



377
378
379
380
 
# File 'app/models/invoice.rb', line 377

def add_party_with_role_type(party, role_type)
  self.invoice_party_roles << InvoicePartyRole.create(:party => party, :role_type => convert_role_type(role_type))
  self.save
end

#balance ⇒ Object Also known as: payment_due 



289
290
291
292
293
294
295
296
297
298
299
 
# File 'app/models/invoice.rb', line 289

def balance
  if items.empty?
    if self.balance_record
      self.balance_record.amount
    else
      0
    end
  else
    self.items.all.sum(&:total_amount).round(2)
  end
end

#balance=(amount, currency = Currency.usd) ⇒ Object 



303
304
305
306
307
308
309
310
 
# File 'app/models/invoice.rb', line 303

def balance=(amount, currency=Currency.usd)
  if self.balance_record
    self.balance_record.amount = amount
  else
    self.balance_record = Money.create(:amount => amount, :currency => currency)
  end
  self.balance_record.save
end

#calculate_balance ⇒ Object 



330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'app/models/invoice.rb', line 330

def calculate_balance
  unless self.calculate_balance_strategy_type.nil?
    case self.calculate_balance_strategy_type.internal_identifier
      when 'invoice_items_and_payments'
        (self.items.all.sum(&:total_amount) - self.total_payments).round(2)
      when 'payable_balances_and_payments'
        (self.payable_balances.all.sum(&:balance).amount - self.total_payments).round(2)
      when 'payments'
        (self.balance - self.total_payments).round(2)
      else
        self.balance
    end
  else
    unless self.balance.nil?
      if has_invoice_items?
        (self.balance - self.total_payments).round(2)
      else
        self.balance.round(2)
      end
    end
  end
end

#calculate_tax(ctx = {}) ⇒ Object

calculates tax for each line item and save to sales_tax



317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'app/models/invoice.rb', line 317

def calculate_tax(ctx={})
  tax = 0

  self.invoice_items.each do |line_item|
    tax += line_item.calculate_tax(ctx)
  end

  self.sales_tax = tax
  self.save

  tax
end

#dba_organization ⇒ Object 



394
395
396
 
# File 'app/models/invoice.rb', line 394

def dba_organization
  find_parties_by_role_type('dba_org').first
end

#find_parties_by_role_type(role_type) ⇒ Object 



382
383
384
 
# File 'app/models/invoice.rb', line 382

def find_parties_by_role_type(role_type)
  self.invoice_party_roles.where('role_type_id = ?', convert_role_type(role_type).id).all.collect(&:party)
end

#find_party_by_role_type(role_type) ⇒ Object 



386
387
388
389
390
391
392
 
# File 'app/models/invoice.rb', line 386

def find_party_by_role_type(role_type)
  parties = find_parties_by_role_type(role_type)

  unless parties.empty?
    parties.first
  end
end

#get_payment_applications(status = :all) ⇒ Object 



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'app/models/invoice.rb', line 246

def get_payment_applications(status=:all)
  selected_payment_applications = case status.to_sym
                                    when :pending
                                      self.payment_applications.pending
                                    when :successful
                                      self.payment_applications.successful
                                    when :all
                                      self.payment_applications
                                  end

  unless self.items.empty?
    unless self.items.collect { |item| item.get_payment_applications(status) }.empty?
      selected_payment_applications = (selected_payment_applications | self.items.collect { |item| item.get_payment_applications(status) }).flatten!
    end
  end

  selected_payment_applications
end

#has_invoice_items? ⇒ Boolean

Returns:

  • (Boolean) 


236
237
238
 
# File 'app/models/invoice.rb', line 236

def has_invoice_items?
  !self.items.empty?
end

#has_payments?(status = :all) ⇒ Boolean

Returns:

  • (Boolean) 


240
241
242
243
244
 
# File 'app/models/invoice.rb', line 240

def has_payments?(status=:all)
  selected_payment_applications = self.get_payment_applications(status)

  !(selected_payment_applications.nil? or selected_payment_applications.empty?)
end

#sub_total ⇒ Object 



265
266
267
268
269
270
271
272
273
274
275
 
# File 'app/models/invoice.rb', line 265

def sub_total
  if items.empty?
    if self.balance_record
      self.balance_record.amount
    else
      0
    end
  else
    self.items.all.sum(&:sub_total).round(2)
  end
end

#to_data_hash ⇒ Object 



398
399
400
 
# File 'app/models/invoice.rb', line 398

def to_data_hash
  to_hash(only: [:id, :created_at, :updated_at, :description, :invoice_number, :invoice_date, :due_date])
end

#total_amount ⇒ Object 



277
278
279
280
281
282
283
284
285
286
287
 
# File 'app/models/invoice.rb', line 277

def total_amount
  if items.empty?
    if self.balance_record
      self.balance_record.amount
    else
      0
    end
  else
    self.items.all.sum(&:total_amount).round(2)
  end
end

#total_payments ⇒ Object 



312
313
314
 
# File 'app/models/invoice.rb', line 312

def total_payments
  self.get_payment_applications(:successful).sum { |item| item.money.amount }
end

#transactions ⇒ Object 



353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'app/models/invoice.rb', line 353

def transactions
  transactions = []

  self.items.each do |item|
    transactions << {
        :date => item.created_at,
        :description => item.item_description,
        :quantity => item.quantity,
        :amount => item.amount
    }
  end

  self.get_payment_applications(:successful).each do |item|
    transactions << {
        :date => item.financial_txn.payments.last.created_at,
        :description => item.financial_txn.description,
        :quantity => 1,
        :amount => (0 - item.financial_txn.money.amount)
    }
  end

  transactions.sort_by { |item| [item[:date]] }
end