Class: LucaDeal::Invoice

Inherits:
LucaRecord::Base
  • Object
show all
Defined in:
lib/luca_deal/invoice.rb

Direct Known Subclasses

NoInvoice

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(date = nil) ⇒ Invoice

Returns a new instance of Invoice.



18
19
20
 
# File 'lib/luca_deal/invoice.rb', line 18

def initialize(date = nil)
  @date = issue_date(date)
end

Class Method Details

.report(date, scan_years = 10, detail: false, due: false) ⇒ Object 



92
93
94
95
96
97
98
99
100
101
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
 
# File 'lib/luca_deal/invoice.rb', line 92

def self.report(date, scan_years = 10, detail: false, due: false)
  fy_end = Date.new(date.year, date.month, -1)
  customers = {}.tap do |h|
    Customer.all.each { |c| h[c['id']] = LucaSupport::Code.parse_current(c, fy_end) }
  end
  [].tap do |res|
    items = {}
    head = date.prev_year(scan_years)
    e = Enumerator.new do |yielder|
      while head <= date
        yielder << head
        head = head.next_month
      end
    end
    e.each do |d|
      asof(d.year, d.month).map do |invoice|
        if invoice['settled']
          next if !due
          settle_date = invoice['settled']['date'].class.name == "String" ? Date.parse(invoice['settled']['date']) : invoice['settled']['date']
          next if (settle_date && settle_date <= fy_end)
        end

        customer = invoice.dig('customer', 'id')
        items[customer] ||= { 'unsettled' => BigDecimal('0'), 'invoices' => [] }
        items[customer]['unsettled'] += (invoice.dig('subtotal', 0, 'items') + invoice.dig('subtotal', 0, 'tax')||0)
        items[customer]['invoices'] << invoice
      end
    end
    items.each do |k, item|
      row = {
        'id' => k,
        'customer' => customers.dig(k, 'name'),
        'unsettled' => LucaSupport::Code.readable(item['unsettled']),
      }
      if detail
        row['address'] = %Q(#{customers.dig(k, 'address')}#{customers.dig(k, 'address2')})
        row['invoices'] = item['invoices'].map{ |i| { 'id' => i['id'], 'issue' => i['issue_date'].to_s } }
      end
      res << row
    end
    res.sort! { |a, b| b['unsettled'] <=> a['unsettled'] }
  end
end

.settle(io, payment_terms = 1) ⇒ Object

JSON Format:

[
  {
    "journals" : [
      {
        "id": "2021A/U001",
        "header": "customer name",
        "diff": -20000
      }
    ]
  }
]



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
197
198
199
200
201
202
203
204
205
 
# File 'lib/luca_deal/invoice.rb', line 149

def self.settle(io, payment_terms = 1)
  customers = {}.tap do |h|
    Customer.all.each do |c|
      LucaSupport::Code.take_history(c, 'name').each do |name|
        h[name] = c
      end
    end
  end
  contracts = {}.tap do |h|
    Contract.all.each { |c| h[c['customer_id']] ||= []; h[c['customer_id']] << c }
  end
  JSON.parse(io).each do |d|
    next if d['journals'].nil?

    d['journals'].each do |j|
      next if j['diff'] >= 0

      if j['header'] == 'others'
        STDERR.puts "#{j['id']}: no customer header found. skip"
        next
      end

      ord = customers.map do |k, v|
        [v, LucaSupport::Code.match_score(j['header'], k, 2)]
      end
      customer = ord.max { |x, y| x[1] <=> y[1] }.dig(0, 'id')

      if customer
        contract = contracts[customer].length == 1 ? contracts.dig(customer, 0, 'id') : nil
        date = Date.parse(j['date'])
        invoices = term(date.prev_month(payment_terms).year, date.prev_month(payment_terms).month, date.year, date.month, contract)
        invoices.each do |invoice, _path|
          next if invoice['customer']['id'] != customer
          next if invoice['issue_date'] > date
          if Regexp.new("^LucaBook/#{j['id']}").match invoice.dig('settled', 'id')||''
            break
          end
          next if 0 >= [
              invoice.dig('subtotal', 0, 'items'),
              invoice.dig('subtotal', 0, 'tax'),
              invoice.dig('settled', 'amount')
            ].compact.sum

          invoice['settled'] = {
            'id' => "LucaBook/#{j['id']}",
            'date' => j['date'],
            'amount' => j['diff']
          }
          save(invoice)
          break
        end
      else
        STDERR.puts "#{j['id']}: no customer found"
      end
    end
  end
end

Instance Method Details

#compose_mail(dat, mode: nil, attachment: :html) ⇒ Object 



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/luca_deal/invoice.rb', line 65

def compose_mail(dat, mode: nil, attachment: :html)
  @company = set_company
  invoice_vars(dat)

  mail = Mail.new
  mail.to = dat.dig('customer', 'to') if mode.nil?
  mail.subject = LucaRecord::CONST.config.dig('invoice', 'mail_subject') || 'Your Invoice is available'
  if mode == :preview
    mail.cc = LucaRecord::CONST.config.dig('mail', 'preview') || LucaRecord::CONST.config.dig('mail', 'from')
    mail.subject = '[preview] ' + mail.subject
  end
  mail.text_part = Mail::Part.new(body: render_erb(search_template('invoice-mail.txt.erb')), charset: 'UTF-8')
  mail.attachments[attachment_name(dat, attachment)] = render_invoice(attachment)
  mail
end

#deliver_mail(attachment_type = nil, mode: nil) ⇒ Object 



22
23
24
25
26
27
28
29
30
31
 
# File 'lib/luca_deal/invoice.rb', line 22

def deliver_mail(attachment_type = nil, mode: nil)
  invoices = self.class.asof(@date.year, @date.month)
  raise "No invoice for #{@date.year}/#{@date.month}" if invoices.count.zero?

  invoices.each do |dat, path|
    next if has_status?(dat, 'mail_delivered')

    deliver_one(dat, path, mode: mode, attachment_type: attachment_type)
  end
end

#due_date(date) ⇒ Object

TODO: support due_date variation



403
404
405
406
 
# File 'lib/luca_deal/invoice.rb', line 403

def due_date(date)
  next_month = date.next_month
  Date.new(next_month.year, next_month.month, -1)
end

#export_json ⇒ Object 



304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/luca_deal/invoice.rb', line 304

def export_json
  labels = export_labels
  [].tap do |res|
    self.class.asof(@date.year, @date.month) do |dat|
      item = {}
      item['date'] = dat['issue_date']
      item['debit'] = []
      item['credit'] = []
      dat['subtotal'].map do |sub|
        if readable(sub['items']) != 0
          item['debit'] << { 'label' => labels[:debit][:items], 'amount' => readable(sub['items']) }
          item['credit'] << { 'label' => labels[:credit][:items], 'amount' => readable(sub['items']) }
        end
        if readable(sub['tax']) != 0
          item['debit'] << { 'label' => labels[:debit][:tax], 'amount' => readable(sub['tax']) }
          item['credit'] << { 'label' => labels[:credit][:tax], 'amount' => readable(sub['tax']) }
        end
      end
      item['x-customer'] = dat['customer']['name'] if dat.dig('customer', 'name')
      item['x-editor'] = 'LucaDeal'
      res << item
    end
    puts JSON.dump(res)
  end
end

#gen_invoice!(invoice) ⇒ Object 



392
393
394
395
 
# File 'lib/luca_deal/invoice.rb', line 392

def gen_invoice!(invoice)
  id = invoice.dig('contract_id')
  self.class.create(invoice, date: @date, codes: Array(id))
end

#get_customer(id) ⇒ Object 



365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/luca_deal/invoice.rb', line 365

def get_customer(id)
  {}.tap do |res|
    Customer.find(id) do |dat|
      customer = parse_current(dat)
      res['id'] = customer['id']
      res['name'] = customer.dig('name')
      res['address'] = customer.dig('address')
      res['address2'] = customer.dig('address2')
      res['to'] = customer.dig('contacts').map { |h| take_current(h, 'mail') }.compact
    end
  end
end

#get_products(products) ⇒ Object 



378
379
380
381
382
383
384
385
386
387
388
389
390
 
# File 'lib/luca_deal/invoice.rb', line 378

def get_products(products)
  return [] if products.nil?

  [].tap do |res|
    products.each do |product|
      Product.find(product['id'])['items'].each do |item|
        item['product_id'] = product['id']
        item['qty'] ||= 1
        res << item
      end
    end
  end
end

#invoice_object(contract) ⇒ Object 



347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/luca_deal/invoice.rb', line 347

def invoice_object(contract)
  {}.tap do |invoice|
    invoice['contract_id'] = contract['id']
    invoice['customer'] = get_customer(contract.dig('customer_id'))
    invoice['due_date'] = due_date(@date)
    invoice['issue_date'] = @date
    invoice['sales_fee'] = contract['sales_fee'] if contract.dig('sales_fee')
    invoice['items'] = get_products(contract['products'])
                         .concat(contract['items']&.map { |i| i['qty'] ||= 1; i } || [])
                         .compact
    invoice['items'].reject! do |item|
      item.dig('type') == 'initial' && subsequent_month?(contract.dig('terms', 'effective'))
    end
    invoice['subtotal'] = subtotal(invoice['items'])
                            .map { |k, v| v.tap { |dat| dat['rate'] = k } }
  end
end

#issue_date(date) ⇒ Object 



397
398
399
400
 
# File 'lib/luca_deal/invoice.rb', line 397

def issue_date(date)
  base =  date.nil? ? Date.today : Date.parse(date)
  Date.new(base.year, base.month, -1)
end

#monthly_invoice(target = 'monthly') ⇒ Object 



337
338
339
340
341
342
343
344
345
 
# File 'lib/luca_deal/invoice.rb', line 337

def monthly_invoice(target = 'monthly')
  Contract.new(@date.to_s).active do |contract|
    next if contract.dig('terms', 'billing_cycle') != target
    # TODO: provide another I/F for force re-issue if needed
    next if duplicated_contract? contract['id']

    gen_invoice!(invoice_object(contract))
  end
end

#preview_mail(attachment_type = nil) ⇒ Object 



33
34
35
36
37
38
39
40
 
# File 'lib/luca_deal/invoice.rb', line 33

def preview_mail(attachment_type = nil)
  invoices = self.class.asof(@date.year, @date.month)
  raise "No invoice for #{@date.year}/#{@date.month}" if invoices.count.zero?

  invoices.each do |dat, path|
    deliver_one(dat, path, mode: :preview, attachment_type: attachment_type)
  end
end

#print(id = nil, params = {}) ⇒ Object

Render HTML/PDF to files TODO: change output dir



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/luca_deal/invoice.rb', line 45

def print(id = nil, params = {})
  filetype = params[:output] || :html
  if id
    dat = self.class.find(id)
    @company = set_company
    invoice_vars(dat, params[:sample])
    File.open(attachment_name(dat, filetype), 'w') do |f|
      f.puts render_invoice(filetype)
    end
  else
    self.class.asof(@date.year, @date.month) do |dat, _|
      @company = set_company
      invoice_vars(dat, params[:sample])
      File.open(attachment_name(dat, filetype), 'w') do |f|
        f.puts render_invoice(filetype)
      end
    end
  end
end

#render_invoice(file_type = :html) ⇒ Object 



81
82
83
84
85
86
87
88
89
90
 
# File 'lib/luca_deal/invoice.rb', line 81

def render_invoice(file_type = :html)
  case file_type
  when :html
    render_erb(search_template('invoice.html.erb'))
  when :pdf
    erb2pdf(search_template('invoice.html.erb'))
  else
    raise 'This filetype is not supported.'
  end
end

#single_invoice(contract_id) ⇒ Object 



330
331
332
333
334
335
 
# File 'lib/luca_deal/invoice.rb', line 330

def single_invoice(contract_id)
  contract = Contract.find(contract_id)
  raise "Invoice already exists for #{contract_id}. exit" if duplicated_contract? contract['id']

  gen_invoice!(invoice_object(contract))
end

#stats(count = 1, mode: nil) ⇒ Object

Output seriarized invoice data to stdout. Returns previous N months on multiple count

Example YAML output

---
- records:
  - customer: Example Co.
    subtotal: 100000
    tax: 10000
    due: 2020-10-31
    issue_date: '2020-09-30'
  count: 1
  total: 100000
  tax: 10000



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/luca_deal/invoice.rb', line 222

def stats(count = 1, mode: nil)
  [].tap do |collection|
    scan_date = @date.next_month
    count.times do
      scan_date = scan_date.prev_month
      {}.tap do |stat|
        stat['records'] = self.class.asof(scan_date.year, scan_date.month).map do |invoice|
          amount = invoice['subtotal'].inject(0) { |sum, sub| sum + sub['items'] }
          tax = invoice['subtotal'].inject(0) { |sum, sub| sum + sub['tax'] }
          {
            'customer' => invoice.dig('customer', 'name'),
            'subtotal' => amount,
            'tax' => tax,
            'due' => invoice.dig('due_date'),
            'mail' => invoice.dig('status')&.select { |a| a.keys.include?('mail_delivered') }&.first,
          }.tap do |r|
            if mode == 'full'
              r['settled'] = invoice.dig('settled', 'amount')
              r['settle_date'] = invoice.dig('settled', 'date')
            end
          end
        end
        stat['issue_date'] = scan_date.to_s
        stat['count'] = stat['records'].count
        stat['total'] = stat['records'].inject(0) { |sum, rec| sum + rec.dig('subtotal') }
        stat['tax'] = stat['records'].inject(0) { |sum, rec| sum + rec.dig('tax') }
        collection << readable(stat)
      end
    end
  end
end

#stats_email(count = 3, mode: nil) ⇒ Object

send payment list to preview address or from address.



256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/luca_deal/invoice.rb', line 256

def stats_email(count = 3, mode: nil)
  {}.tap do |res|
    stats(count, mode: mode).each.with_index(1) do |stat, i|
      stat['records'].each do |record|
        res[record['customer']] ||= {}
        res[record['customer']]['customer_name'] ||= record['customer']
        res[record['customer']]["amount#{i}"] ||= record['subtotal'].to_s
        res[record['customer']]["tax#{i}"] ||= record['tax']
        next if mode != 'full' || ! record['settled']

        diff = ['subtotal', 'tax', 'settled'].map { |k| record[k] }.compact.sum
        mark = if diff == 0
                 '[S]'
               elsif diff > 0
                 '[P]'
               else
                 '[O]'
               end
        res[record['customer']]["amount#{i}"].insert(0, mark)
      end
      if i == 1
        @issue_date = stat['issue_date']
        @total_amount = stat['total']
        @total_tax = stat['tax']
        @total_count = stat['count']
      end
    end
    @invoices = res.values
  end
  @company = LucaRecord::CONST.config.dig('company', 'name')
  @legend = if mode == 'full'
              '[S] Settled, [P] Partially settled, [O] Overpaid'
            else
              ''
            end
  @unsettled = if mode == 'full'
                 self.class.report(@date)
               else
                 []
               end

  mail = Mail.new
  mail.to = LucaRecord::CONST.config.dig('mail', 'preview') || LucaRecord::CONST.config.dig('mail', 'from')
  mail.subject = 'Check monthly payment list'
  mail.html_part = Mail::Part.new(body: render_erb(search_template('monthly-payment-list.html.erb')), content_type: 'text/html; charset=UTF-8')
  LucaSupport::Mail.new(mail, LucaRecord::CONST.pjdir).deliver
end