forked from NaN-tic/trytond-contract
-
Notifications
You must be signed in to change notification settings - Fork 0
/
contract.py
1382 lines (1189 loc) · 48.8 KB
/
contract.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
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
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
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
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
253
254
255
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
303
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
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# The COPYRIGHT file at the top level of this repository contains
# the full copyright notices and license terms.
import datetime, calendar
from dateutil.relativedelta import relativedelta
from dateutil.rrule import rrule, DAILY, WEEKLY, MONTHLY, YEARLY
from decimal import Decimal
from itertools import groupby
from sql import Column, Null, Literal
from sql.conditionals import Case
from sql.aggregate import Max, Min, Sum
from trytond import backend
from trytond.model import (Workflow, ModelSQL, ModelView, Model, fields,
sequence_ordered)
from trytond.pool import Pool, PoolMeta
from trytond.pyson import Eval, Bool, If
from trytond.transaction import Transaction
from trytond.tools import reduce_ids, grouped_slice
from trytond.wizard import Wizard, StateView, StateAction, Button
from trytond.modules.product import price_digits
from trytond.i18n import gettext
from trytond.exceptions import UserError
from trytond.modules.product import round_price
try:
from trytond.modules.analytic_account import AnalyticMixin
except ModuleNotFoundError:
AnalyticMixin = object
FREQS = [
(None, ''),
('daily', 'Daily'),
('weekly', 'Weekly'),
('monthly', 'Monthly'),
('yearly', 'Yearly'),
]
class RRuleMixin(Model):
freq = fields.Selection(FREQS, 'Frequency', sort=False)
interval = fields.Integer('Interval', domain=[
If(Bool(Eval('freq')),
[('interval', '>', 0)], [])
],
states={
'required': Bool(Eval('freq')),
}, depends=['freq'])
def rrule_values(self):
values = {}
mappings = {
'freq': {
'daily': DAILY,
'weekly': WEEKLY,
'monthly': MONTHLY,
'yearly': YEARLY,
},
}
for field in ('freq', 'interval'):
value = getattr(self, field)
if not value:
continue
if field in mappings:
if isinstance(mappings[field], str):
values[mappings[field]] = value
else:
value = mappings[field][value]
values[field] = value
return values
@property
def rrule(self):
'Returns rrule instance from current values'
values = self.rrule_values()
return rrule(**values)
class ContractService(ModelSQL, ModelView):
'Contract Service'
__name__ = 'contract.service'
name = fields.Char('Name', required=True)
product = fields.Many2One('product.product', 'Product', required=True,
domain=[
('type', '=', 'service'),
])
_STATES = {
'readonly': Eval('state') != 'draft',
}
_DEPENDS = ['state']
CONTRACT_STATES = [
('draft', 'Draft'),
('confirmed', 'Confirmed'),
('cancelled', 'Cancelled'),
('finished', 'Finished'),
]
def todatetime(date):
return datetime.datetime.combine(date, datetime.time(0, 0, 0))
class Contract(RRuleMixin, Workflow, ModelSQL, ModelView):
'Contract'
__name__ = 'contract'
company = fields.Many2One('company.company', 'Company', required=True,
states=_STATES, depends=_DEPENDS)
currency = fields.Many2One('currency.currency', 'Currency', required=True,
states=_STATES, depends=_DEPENDS)
party = fields.Many2One('party.party', 'Party', required=True,
context={
'company': Eval('company', -1),
},
states=_STATES, depends=_DEPENDS + ['company'])
number = fields.Char('Number', states=_STATES,
depends=_DEPENDS)
reference = fields.Char('Reference')
start_date = fields.Function(fields.Date('Start Date'),
'get_dates', searcher='search_dates')
end_date = fields.Function(fields.Date('End Date'),
'get_dates', searcher='search_dates')
start_period_date = fields.Date('Start Period Date', required=True,
states=_STATES, depends=_DEPENDS)
first_invoice_date = fields.Date('First Invoice Date', required=True,
states=_STATES, depends=_DEPENDS)
lines = fields.One2Many('contract.line', 'contract', 'Lines',
states={
'readonly': ~Eval('state').in_(['draft', 'confirmed']),
'required': Eval('state') == 'confirmed',
},
depends=['state'])
state = fields.Selection(CONTRACT_STATES, 'State',
required=True, readonly=True)
payment_term = fields.Many2One('account.invoice.payment_term',
'Payment Term')
months_renewal = fields.Integer('Months Renewal',
states={
'required': Bool(Eval('first_review_date')),
},
depends=['first_review_date'])
first_review_date = fields.Date('First Review Date',
help="Date on which the actions should be performed.",
states={
'required': Bool(Eval('months_renewal')),
},
depends=['months_renewal'])
reviews = fields.One2Many('contract.review', 'contract',
'Reviews', readonly=True, order=[
('review_date', 'ASC')
])
review_limit_date = fields.TimeDelta('Limit Date',
help="The deadline date on which the actions should be performed.",
states={
'required': Bool(Eval('first_review_date')),
},
depends=['first_review_date'])
review_alarm = fields.TimeDelta('Alarm Date',
help="The date when actions related to reviews should start to be managed.",
states={
'required': Bool(Eval('first_review_date')),
},
depends=['first_review_date'])
last_month_day_invoice = fields.Boolean('Last Month Day Invoice',
states={'invisible': ~Eval('freq').in_(['monthly',]),
'readonly': Eval('state')!='draft'},
depends=['freq', 'state'])
@classmethod
def __setup__(cls):
super(Contract, cls).__setup__()
for field_name in ('freq', 'interval'):
field = getattr(cls, field_name)
field.states = _STATES.copy()
field.states['required'] = True
field.depends.update(set(_DEPENDS))
cls._transitions |= set((
('draft', 'confirmed'),
('draft', 'cancelled'),
('confirmed', 'draft'),
('confirmed', 'cancelled'),
('confirmed', 'finished'),
('cancelled', 'draft'),
('finished', 'draft'),
))
cls._buttons.update({
'draft': {
'invisible': ~Eval('state').in_(['cancelled', 'finished',
'confirmed']),
'icon': 'tryton-clear',
},
'confirm': {
'invisible': Eval('state') != 'draft',
'icon': 'tryton-forward',
},
'finish': {
'invisible': Eval('state') != 'confirmed',
'icon': 'tryton-forward',
},
'cancel': {
'invisible': ~Eval('state').in_(['draft', 'confirmed']),
'icon': 'tryton-cancel',
},
})
@classmethod
def __register__(cls, module_name):
Line = Pool().get('contract.line')
handler = backend.TableHandler(cls, module_name)
first_invoice_date_exist = handler.column_exist('first_invoice_date')
if not handler.column_exist('number'):
handler.column_rename('reference', 'number')
super(Contract, cls).__register__(module_name)
table = cls.__table__()
line = Line.__table__()
line_handler = backend.TableHandler(Line, module_name)
cursor = Transaction().connection.cursor()
# Changed state field values
cursor.execute(*table.update(columns=[table.state],
values=['cancelled'], where=table.state == 'cancel'))
cursor.execute(*table.update(columns=[table.state],
values=['confirmed'], where=table.state == 'validated'))
# Move first_invoice_date field from line into contract
if (not first_invoice_date_exist
and line_handler.column_exist('first_invoice_date')):
query = table.update(
[table.first_invoice_date],
line.select(
Min(line.first_invoice_date),
where=table.id == line.contract,
group_by=line.contract))
cursor.execute(*query)
line_handler.drop_column('first_invoice_date')
def _get_rec_name(self, name):
rec_name = []
if self.number:
rec_name.append(self.number)
if self.party:
rec_name.append(self.party.rec_name)
return rec_name
def get_rec_name(self, name):
rec_name = self._get_rec_name(name)
return "/".join(rec_name)
@classmethod
def search_rec_name(cls, name, clause):
return ['OR',
('number',) + tuple(clause[1:]),
('party.name',) + tuple(clause[1:]),
]
@staticmethod
def default_company():
return Transaction().context.get('company')
@staticmethod
def default_currency():
Company = Pool().get('company.company')
if Transaction().context.get('company'):
company = Company(Transaction().context['company'])
return company.currency.id
@staticmethod
def default_state():
return 'draft'
@fields.depends('party')
def on_change_party(self):
self.payment_term = None
if self.party:
self.payment_term = self.party.customer_payment_term
@classmethod
def get_dates(cls, contracts, names):
pool = Pool()
ContractLine = pool.get('contract.line')
cursor = Transaction().connection.cursor()
line = ContractLine.__table__()
result = {}
contract_ids = [c.id for c in contracts]
for name in names:
if name not in ('start_date', 'end_date'):
raise Exception('Bad argument')
result[name] = dict((c, None) for c in contract_ids)
for sub_ids in grouped_slice(contract_ids):
where = reduce_ids(line.contract, sub_ids)
for name in names:
cursor.execute(*line.select(line.contract,
cls._compute_date_column(line, name),
where=where,
group_by=line.contract))
for contract, value in cursor.fetchall():
# SQlite returns unicode for dates
if isinstance(value, str):
value = datetime.date(*[int(x) for x in
value.split('-')])
result[name][contract] = value
return result
@staticmethod
def _compute_date_column(table, name):
func = Min if name == 'start_date' else Max
column = Column(table, name)
sum_ = Sum(Case((column == Null, Literal(1)), else_=Literal(0)))
# As fields can be null, return null if at least one of them is null
return Case((sum_ >= Literal(1), Null), else_=func(column))
@classmethod
def search_dates(cls, name, clause):
pool = Pool()
ContractLine = pool.get('contract.line')
line = ContractLine.__table__()
Operator = fields.SQL_OPERATORS[clause[1]]
query = line.select(line.contract, group_by=line.contract,
having=Operator(cls._compute_date_column(line, name),
clause[2]))
return [('id', 'in', query)]
@classmethod
def set_number(cls, contracts):
'Fill the number field with the contract sequence'
pool = Pool()
Config = pool.get('contract.configuration')
config = Config(1)
to_write = []
for contract in contracts:
if contract.number:
continue
number = config.contract_sequence.get()
to_write.extend(([contract], {
'number': number,
}))
if to_write:
cls.write(*to_write)
@classmethod
def copy(cls, contracts, default=None):
if default is None:
default = {}
else:
default = default.copy()
default.setdefault('number', None)
default.setdefault('end_date', None)
return super(Contract, cls).copy(contracts, default=default)
@classmethod
@ModelView.button
@Workflow.transition('draft')
def draft(cls, contracts):
Consumption = Pool().get('contract.consumption')
consumptions = Consumption.search([
('contract', 'in', [x.id for x in contracts]),
('contract_line.contract.company', '=',
Transaction().context.get('company')),
])
if consumptions:
raise UserError(gettext('contract.cannot_draft',
contract=consumptions[0].contract.rec_name))
@classmethod
@ModelView.button
@Workflow.transition('confirmed')
def confirm(cls, contracts):
cls.set_number(contracts)
for contract in contracts:
for line in contract.lines:
if not line.start_date:
raise UserError(gettext('contract.line_start_date_required',
line=line.rec_name,
contract=line.contract.rec_name))
@classmethod
@ModelView.button
@Workflow.transition('cancelled')
def cancel(cls, contracts):
pass
@classmethod
@ModelView.button
@Workflow.transition('finished')
def finish(cls, contracts):
for contract in contracts:
for line in contract.lines:
if not line.end_date:
raise UserError(gettext('contract.cannot_finish',
line=line.rec_name,
contract=line.contract.rec_name))
def rrule_values(self):
values = super(Contract, self).rrule_values()
values['dtstart'] = todatetime(self.start_period_date)
return values
def get_invoice_date(self, last_invoice_date, start_period_date):
last_invoice_date = todatetime(last_invoice_date)
start_period_date = todatetime(start_period_date)
if self.last_month_day_invoice and self.freq == 'monthly':
last_invoice_date = last_invoice_date.replace(day=28)
r = rrule(self.rrule._freq, interval=self.rrule._interval,
dtstart=last_invoice_date)
date = last_invoice_date
while date < start_period_date:
date = r.after(date)
if self.last_month_day_invoice and date.day == 28 and self.freq == 'monthly':
date = date.replace(day=calendar.monthrange(date.year,
date.month)[1])
return date.date()
def get_start_period_date(self, start_date):
r = rrule(self.rrule._freq, interval=self.rrule._interval,
dtstart=self.start_period_date)
date = r.before(todatetime(start_date), inc=True)
if date:
return date.date()
return self.start_period_date
def get_consumptions(self, limit_date=None):
pool = Pool()
Date = pool.get('ir.date')
if limit_date is None:
limit_date = Date.today()
consumptions = []
if not self.freq or not self.interval:
return consumptions
for line in self.lines:
line_limit_date = limit_date
if (line.end_date and line.last_consumption_date
and line.end_date <= line.last_consumption_date):
continue
if line.end_date and line.end_date < limit_date:
line_limit_date = line.end_date
start_period_date = self.get_start_period_date(line.start_date)
last_consumption_date = line.last_consumption_date
if last_consumption_date:
last_consumption_date = todatetime(line.last_consumption_date)
start = start_period_date
if last_consumption_date:
start = (last_consumption_date + relativedelta(days=+1)).date()
last_invoice_date = line.last_consumption_invoice_date
next_period = (self.rrule.after(todatetime(line_limit_date)) +
relativedelta(days=+1))
if line.end_date and next_period.date() < line.end_date:
next_period = todatetime(line.end_date)
rrule = self.rrule
for date in rrule.between(todatetime(start), next_period,
inc=True):
start_period = date.date()
last_invoice_date = (last_invoice_date
or line.contract.first_invoice_date)
invoice_date = self.get_invoice_date(last_invoice_date,
start_period)
if (start_period > line_limit_date):
break
end_period = rrule.after(date).date() - relativedelta(days=1)
start = start_period
if line.start_date > start:
start = line.start_date
end = end_period
if line.end_date and line.end_date <= end:
end = line.end_date
if not (end >= start):
continue
consumptions.append(line.get_consumption(start, end,
invoice_date, start_period, end_period))
last_invoice_date = invoice_date
return consumptions
@classmethod
def consume(cls, contracts, date=None):
'Consume the contracts until date'
ContractConsumption = Pool().get('contract.consumption')
to_create = []
for contract in contracts:
to_create += contract.get_consumptions(date)
return ContractConsumption.create([x._save_values for x in to_create])
@classmethod
def default_months_renewal(cls):
pool = Pool()
Config = pool.get('contract.configuration')
config = Config(1)
if config.default_months_renewal:
return config.default_months_renewal
@classmethod
def default_review_alarm(cls):
pool = Pool()
Config = pool.get('contract.configuration')
config = Config(1)
return config.default_review_alarm
@classmethod
def default_review_limit_date(cls):
pool = Pool()
Config = pool.get('contract.configuration')
config = Config(1)
return config.default_review_limit_date
@fields.depends('start_period_date', 'months_renewal')
def on_change_with_first_review_date(self, name=None):
if self.months_renewal and self.start_period_date:
return (self.start_period_date +
relativedelta(months=self.months_renewal))
@fields.depends('first_invoice_date', 'last_month_day_invoice')
def on_change_with_first_invoice_date(self, name=None):
if self.first_invoice_date and self.last_month_day_invoice:
return self.first_invoice_date.replace(day=calendar.monthrange(
self.first_invoice_date.year,
self.first_invoice_date.month)[1])
return self.first_invoice_date
@fields.depends('last_month_day_invoice', 'freq')
def on_change_freq(self):
if self.freq != 'monthly':
self.last_month_day_invoice = False
@fields.depends('first_invoice_date', 'freq', 'last_month_day_invoice')
def on_change_notify(self):
notifications = super().on_change_notify()
notifications.append(self._notify_first_invoice_date())
return notifications
def _notify_first_invoice_date(self):
if (self.freq == 'monthly' and not self.last_month_day_invoice
and self.first_invoice_date and self.first_invoice_date.day > 28):
return ('warning', gettext('contract.msg_warning_first_invoice_date'))
class ContractLine(sequence_ordered(), ModelSQL, ModelView):
'Contract Line'
__name__ = 'contract.line'
contract = fields.Many2One('contract', 'Contract', required=True,
ondelete='CASCADE')
contract_state = fields.Function(fields.Selection(CONTRACT_STATES,
'Contract State'), 'get_contract_state',
searcher='search_contract_state')
service = fields.Many2One('contract.service', 'Service', required=True,
states={
'readonly': Bool(Eval('has_consumptions')),
}, depends=['has_consumptions'])
start_date = fields.Date('Start Date',
states={
'readonly': Bool(Eval('has_consumptions')),
'required': Eval('contract_state') == 'confirmed',
},
domain=[
If(Bool(Eval('end_date')),
('start_date', '<=', Eval('end_date', None)),
()),
],
depends=['end_date', 'contract_state', 'has_consumptions'])
end_date = fields.Date('End Date',
states={
'required': Eval('contract_state') == 'finished',
},
domain=[
If(Bool(Eval('end_date')),
('end_date', '>=', Eval('start_date', None)),
()),
],
depends=['start_date', 'contract_state'])
description = fields.Text('Description', required=True)
unit_price = fields.Numeric('Unit Price', digits=price_digits,
required=True)
last_consumption_date = fields.Function(fields.Date(
'Last Consumption Date'), 'get_last_consumption_date',
searcher='search_last_consumption_dates')
last_consumption_invoice_date = fields.Function(fields.Date(
'Last Invoice Date'), 'get_last_consumption_date',
searcher='search_last_consumption_dates')
consumptions = fields.One2Many('contract.consumption', 'contract_line',
'Consumptions', readonly=True)
has_consumptions = fields.Function(fields.Boolean("Has Consumptions"),
'get_has_consumptions')
@classmethod
def __setup__(cls):
super(ContractLine, cls).__setup__()
cls._order.insert(0, ('contract', 'ASC'))
@classmethod
def __register__(cls, module_name):
table = backend.TableHandler(cls, module_name)
super(ContractLine, cls).__register__(module_name)
# start_date not null
table.not_null_action('start_date', 'remove')
def get_rec_name(self, name):
rec_name = self.contract.rec_name
if self.service:
rec_name = '%s (%s)' % (self.service.rec_name, rec_name)
return rec_name
@classmethod
def search_rec_name(cls, name, clause):
return ['OR',
('contract.rec_name',) + tuple(clause[1:]),
('service.rec_name',) + tuple(clause[1:]),
]
def get_contract_state(self, name):
return self.contract and self.contract.state or 'draft'
@classmethod
def search_contract_state(cls, name, clause):
return [
('contract.state',) + tuple(clause[1:]),
]
@fields.depends('service', '_parent_service.rec_name', 'unit_price', 'description')
def on_change_service(self):
if self.service:
if not self.unit_price:
self.unit_price = self.service.product.list_price
if not self.description:
self.description = self.service.product.rec_name
@classmethod
def get_last_consumption_date(cls, lines, name):
pool = Pool()
Consumption = pool.get('contract.consumption')
table = Consumption.__table__()
cursor = Transaction().connection.cursor()
if name == 'last_consumption_invoice_date':
consumption_date = table.invoice_date
else:
consumption_date = table.end_period_date
line_ids = [l.id for l in lines]
values = dict.fromkeys(line_ids, None)
cursor.execute(*table.select(table.contract_line,
Max(consumption_date),
where=reduce_ids(table.contract_line, line_ids),
group_by=table.contract_line))
values.update(dict(cursor.fetchall()))
if backend.name == 'sqlite':
for id, value in values.items():
if value is not None:
values[id] = datetime.date(*[int(x) for x in value.split('-', 2)])
return values
@classmethod
def get_last_consumption_invoice_date(cls, lines, name):
pool = Pool()
Consumption = pool.get('contract.consumption')
table = Consumption.__table__()
cursor = Transaction().connection.cursor()
line_ids = [l.id for l in lines]
values = dict.fromkeys(line_ids, None)
cursor.execute(*table.select(table.contract_line,
Max(table.invoice_date),
where=reduce_ids(table.contract_line, line_ids),
group_by=table.contract_line))
values.update(dict(cursor.fetchall()))
return values
@classmethod
def search_last_consumption_dates(cls, name, clause):
Consumption = Pool().get('contract.consumption')
consumption = Consumption.__table__()
res = {
'last_consumption_date': 'end_period_date',
'last_consumption_invoice_date': 'invoice_date',
}
Operator = fields.SQL_OPERATORS[clause[1]]
column = Column(consumption, res[clause[0]])
query = consumption.select(consumption.contract_line,
group_by=(consumption.contract_line),
having=Operator(Max(column), clause[2]))
return [('id', 'in', query)]
def get_consumption(self, start_date, end_date, invoice_date, start_period,
finish_period):
'Returns the consumption for date date'
pool = Pool()
Consumption = pool.get('contract.consumption')
consumption = Consumption()
consumption.contract_line = self
consumption.start_date = start_date
consumption.end_date = end_date
consumption.init_period_date = start_period
consumption.end_period_date = finish_period
consumption.invoice_date = invoice_date
return consumption
@classmethod
def get_has_consumptions(cls, lines, name):
res = dict((x.id, False) for x in lines)
for line in lines:
res[line.id] = True if line.consumptions else False
return res
@classmethod
def delete(cls, lines):
for line in lines:
if line.consumptions:
raise UserError(gettext('contract.cannot_delete',
line=line.rec_name,
contract=line.contract.rec_name))
super(ContractLine, cls).delete(lines)
@classmethod
def copy(cls, lines, default=None):
if default is None:
default = {}
default = default.copy()
default.setdefault('consumptions')
return super(ContractLine, cls).copy(lines, default=default)
class AnalyticContractLine(AnalyticMixin, metaclass=PoolMeta):
__name__ = 'contract.line'
class AnalyticAccountEntry(metaclass=PoolMeta):
__name__ = 'analytic.account.entry'
@classmethod
def _get_origin(cls):
origins = super()._get_origin()
origins.append('contract.line')
return origins
class ContractConsumption(ModelSQL, ModelView):
'Contract Consumption'
__name__ = 'contract.consumption'
contract_line = fields.Many2One('contract.line', 'Contract Line',
required=True)
init_period_date = fields.Date('Start Period Date', required=True,
domain=[
('init_period_date', '<=', Eval('end_period_date', None)),
],
depends=['end_period_date'])
end_period_date = fields.Date('Finish Period Date', required=True,
domain=[
('end_period_date', '>=', Eval('init_period_date', None)),
],
depends=['init_period_date'])
start_date = fields.Date('Start Date', required=True,
domain=[
('start_date', '<=', Eval('end_date', None)),
],
depends=['end_date'])
end_date = fields.Date('End Date', required=True,
domain=[
('end_date', '>=', Eval('start_date', None)),
],
depends=['start_date'])
invoice_date = fields.Date('Invoice Date', required=True)
invoice_lines = fields.One2Many('account.invoice.line', 'origin',
'Invoice Lines', readonly=True)
credit_lines = fields.Function(fields.One2Many('account.invoice.line',
None, 'Credit Lines',
states={
'invisible': ~Bool(Eval('credit_lines')),
}),
'get_credit_lines')
contract = fields.Function(fields.Many2One('contract',
'Contract'), 'get_contract', searcher='search_contract')
@classmethod
def __setup__(cls):
super(ContractConsumption, cls).__setup__()
cls._buttons.update({
'generate_invoice': {
'icon': 'tryton-forward',
},
})
def get_credit_lines(self, name):
pool = Pool()
InvoiceLine = pool.get('account.invoice.line')
return [x.id for x in InvoiceLine.search([
('origin.id', 'in', [l.id for l in self.invoice_lines],
'account.invoice.line')])]
def get_contract(self, name=None):
return self.contract_line.contract.id
@classmethod
def search_contract(cls, name, clause):
return [('contract_line.contract',) + tuple(clause[1:])]
def _get_start_end_date(self):
pool = Pool()
Lang = pool.get('ir.lang')
if self.contract.party.lang:
lang = self.contract.party.lang
else:
lang = Lang.get()
start = lang.strftime(self.start_date)
end = lang.strftime(self.end_date)
return start, end
def get_invoice_line(self):
pool = Pool()
InvoiceLine = pool.get('account.invoice.line')
AccountConfiguration = pool.get('account.configuration')
try:
AnalyticAccountEntry = pool.get('analytic.account.entry')
except KeyError:
AnalyticAccountEntry = None
account_config = AccountConfiguration(1)
if (self.invoice_lines and
not Transaction().context.get('force_reinvoice', False)):
return
invoice_line = InvoiceLine()
invoice_line.invoice_type = 'out'
invoice_line.type = 'line'
invoice_line.origin = self
invoice_line.company = self.contract_line.contract.company
invoice_line.currency = self.contract_line.contract.currency
invoice_line.sequence = self.contract_line.sequence
invoice_line.party = self.contract_line.contract.party
invoice_line.product = None
if self.contract_line.service:
invoice_line.product = self.contract_line.service.product
invoice_line.on_change_product()
if not invoice_line.account:
raise UserError(gettext(
'contract.missing_account_revenue',
contract_line=self.contract_line.rec_name,
product=invoice_line.product.rec_name))
start_date, end_date = self._get_start_end_date()
if self.end_period_date == self.init_period_date:
rate = Decimal(0)
else:
# Compute quantity based on dates
# We add 1 day to end_date and end_period date to correctly
# calculate periods. for example:
# (31-01-2015 - 01-01-2015) = 30 days + 1
rate = Decimal((self.end_date + datetime.timedelta(days=1)
- self.start_date).total_seconds() /
(self.end_period_date + datetime.timedelta(days=1) -
self.init_period_date).total_seconds())
invoice_line.quantity = 1
invoice_line.on_change_product()
# set unit_price from service in case on_change_product calculate price
# from the product or from party price list
unit_price = round_price(self.contract_line.unit_price * rate)
if hasattr(InvoiceLine, 'gross_unit_price'):
invoice_line.gross_unit_price = unit_price
invoice_line.update_prices()
else:
invoice_line.unit_price = unit_price
invoice_line.description = '[%(start)s - %(end)s] %(name)s' % {
'start': start_date,
'end': end_date,
'name': self.contract_line.description,
}
if invoice_line.product:
if not invoice_line.account:
raise UserError(gettext(
'contract.missing_account_revenue',
contract_line=self.contract_line.rec_name,
product=invoice_line.product.rec_name))
else:
for name in ['default_product_account_revenue',
'default_category_account_revenue']:
invoice_line.account = account_config.get_multivalue(name)
if invoice_line.account:
break
if not invoice_line.account:
raise UserError(gettext(
'contract.missing_account_revenue_property',
contract_line=self.contract_line.rec_name))
if AnalyticAccountEntry and hasattr(InvoiceLine, 'analytic_accounts'):
invoice_line.analytic_accounts = AnalyticAccountEntry.copy(
self.contract_line.analytic_accounts, default={
'origin': invoice_line.id})
return invoice_line
def get_amount_to_invoice(self):
pool = Pool()
Uom = pool.get('product.uom')
ModelData = pool.get('ir.model.data')
uom = Uom(ModelData.get_id('product', 'uom_unit'))
quantity = ((self.end_date - self.start_date).total_seconds() /
(self.end_period_date - self.init_period_date).total_seconds())
if self.contract_line and self.contract_line.service and \
self.contract_line.service.product:
uom = self.contract_line.service.product.default_uom
qty = uom.round(quantity)
return Decimal(str(qty)) * self.contract_line.unit_price
@classmethod
def _group_invoice_key(cls, line):
'''
The key to group invoice_lines by Invoice
line is a tuple of consumption id and invoice line
'''
consumption, invoice_line = line
grouping = [
('party', invoice_line.party),
('company', invoice_line.company),
('currency', invoice_line.currency),
('type', invoice_line.invoice_type),
('invoice_date', consumption.invoice_date),
]
# We need to add the payment_term id instead of payment_term object to
# be able to search consumptions without payment_term
if consumption.contract.payment_term:
grouping.append(('payment_term', consumption.contract.payment_term.id))
else:
grouping.append(('payment_term', -1),)
if invoice_line.party.contract_grouping_method is None:
grouping.append(('contract', consumption.contract_line.contract))
return grouping
@classmethod
def _get_invoice(cls, keys, lines):
pool = Pool()
Invoice = pool.get('account.invoice')
Config = pool.get('contract.configuration')
config = Config(1)
journal = config.journal
if not journal:
raise UserError(gettext('contract.missing_journal'))
values = {}
for key, value in keys:
if key in Invoice._fields:
values[key] = value
values['invoice_address'] = values['party'].address_get('invoice')
invoice = Invoice(**values)
invoice.on_change_party()
invoice.journal = journal
invoice.payment_term = values['payment_term']
invoice._update_account()
if values.get('contract'):
contract = values['contract']
invoice.reference = contract.reference
elif lines:
# consumption, invoice_line = line
references = set()
for line in lines:
reference = line[0].contract_line.contract.reference