0b6f5b7feacd02155cbd79c08752f5e3772397ca
[odoo/odoo.git] / addons / account_asset / account_asset.py
1 # -*- encoding: utf-8 -*-
2 ##############################################################################
3 #
4 #    OpenERP, Open Source Management Solution
5 #    Copyright (C) 2004-2010 Tiny SPRL (<http://tiny.be>).
6 #
7 #    This program is free software: you can redistribute it and/or modify
8 #    it under the terms of the GNU Affero General Public License as
9 #    published by the Free Software Foundation, either version 3 of the
10 #    License, or (at your option) any later version.
11 #
12 #    This program is distributed in the hope that it will be useful,
13 #    but WITHOUT ANY WARRANTY; without even the implied warranty of
14 #    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15 #    GNU Affero General Public License for more details.
16 #
17 #    You should have received a copy of the GNU Affero General Public License
18 #    along with this program.  If not, see <http://www.gnu.org/licenses/>.
19 #
20 ##############################################################################
21
22 import time
23 from datetime import datetime
24 from dateutil.relativedelta import relativedelta
25
26 from osv import osv, fields
27 import decimal_precision as dp
28
29 class account_asset_category(osv.osv):
30     _name = 'account.asset.category'
31     _description = 'Asset category'
32
33     _columns = {
34         'name': fields.char('Name', size=64, required=True, select=1),
35         'note': fields.text('Note'),
36         'account_analytic_id': fields.many2one('account.analytic.account', 'Analytic account'),
37         'account_asset_id': fields.many2one('account.account', 'Asset Account', required=True),
38         'account_depreciation_id': fields.many2one('account.account', 'Depreciation Account', required=True),
39         'account_expense_depreciation_id': fields.many2one('account.account', 'Depr. Expense Account', required=True),
40         'journal_id': fields.many2one('account.journal', 'Journal', required=True),
41         'company_id': fields.many2one('res.company', 'Company', required=True),
42         'method': fields.selection([('linear','Linear'),('degressive','Degressive')], 'Computation Method', required=True, help="Choose the method to use to compute the amount of depreciation lines.\n"\
43             "  * Linear: Calculated on basis of: Gross Value / Number of Depreciations\n" \
44             "  * Degressive: Calculated on basis of: Remaining Value * Degressive Factor"),
45         'method_number': fields.integer('Number of Depreciations'),
46         'method_period': fields.integer('Period Length', help="State here the time between 2 depreciations, in months", required=True),
47         'method_progress_factor': fields.float('Degressive Factor'),
48         'method_time': fields.selection([('number','Number of Depreciations'),('end','Ending Date')], 'Time Method', required=True,
49                                   help="Choose the method to use to compute the dates and number of depreciation lines.\n"\
50                                        "  * Number of Depreciations: Fix the number of depreciation lines and the time between 2 depreciations.\n" \
51                                        "  * Ending Date: Choose the time between 2 depreciations and the date the depreciations won't go beyond."),
52         'method_end': fields.date('Ending date'),
53         'prorata':fields.boolean('Prorata Temporis', help='Indicates that the first depreciation entry for this asset have to be done from the purchase date instead of the first January'),
54         'open_asset': fields.boolean('Skip Draft State', help="Check this if you want to automatically confirm the assets of this category when created by invoices."),
55     }
56
57     _defaults = {
58         'company_id': lambda self, cr, uid, context: self.pool.get('res.company')._company_default_get(cr, uid, 'account.asset.category', context=context),
59         'method': 'linear',
60         'method_number': 5,
61         'method_time': 'number',
62         'method_period': 12,
63         'method_progress_factor': 0.3,
64     }
65
66     def onchange_account_asset(self, cr, uid, ids, account_asset_id, context=None):
67         res = {'value':{}}
68         if account_asset_id:
69            res['value'] = {'account_depreciation_id': account_asset_id}
70         return res
71
72 account_asset_category()
73
74 class account_asset_asset(osv.osv):
75     _name = 'account.asset.asset'
76     _description = 'Asset'
77
78     def _get_period(self, cr, uid, context={}):
79         periods = self.pool.get('account.period').find(cr, uid)
80         if periods:
81             return periods[0]
82         else:
83             return False
84
85     def _get_last_depreciation_date(self, cr, uid, ids, context=None):
86         """
87         @param id: ids of a account.asset.asset objects
88         @return: Returns a dictionary of the effective dates of the last depreciation entry made for given asset ids. If there isn't any, return the purchase date of this asset
89         """
90         cr.execute("""
91             SELECT a.id as id, COALESCE(MAX(l.date),a.purchase_date) AS date
92             FROM account_asset_asset a
93             LEFT JOIN account_move_line l ON (l.asset_id = a.id)
94             WHERE a.id IN %s
95             GROUP BY a.id, a.purchase_date """, (tuple(ids),))
96         return dict(cr.fetchall())
97
98     def _compute_board_amount(self, cr, uid, asset, i, residual_amount, amount_to_depr, undone_dotation_number, posted_depreciation_line_ids, total_days, depreciation_date, context=None):
99         #by default amount = 0
100         amount = 0
101         if i == undone_dotation_number:
102             amount = residual_amount
103         else:
104             if asset.method == 'linear':
105                 amount = amount_to_depr / (undone_dotation_number - len(posted_depreciation_line_ids))
106                 if asset.prorata:
107                     amount = amount_to_depr / asset.method_number
108                     days = total_days - float(depreciation_date.strftime('%j'))
109                     if i == 1:
110                         amount = (amount_to_depr / asset.method_number) / total_days * days
111                     elif i == undone_dotation_number:
112                         amount = (amount_to_depr / asset.method_number) / total_days * (total_days - days)
113             elif asset.method == 'degressive':
114                 amount = residual_amount * asset.method_progress_factor
115                 if asset.prorata:
116                     days = total_days - float(depreciation_date.strftime('%j'))
117                     if i == 1:
118                         amount = (residual_amount * asset.method_progress_factor) / total_days * days
119                     elif i == undone_dotation_number:
120                         amount = (residual_amount * asset.method_progress_factor) / total_days * (total_days - days)
121         return amount
122
123     def _compute_board_undone_dotation_nb(self, cr, uid, asset, depreciation_date, total_days, context=None):
124         undone_dotation_number = asset.method_number
125         if asset.method_time == 'end':
126             end_date = datetime.strptime(asset.method_end, '%Y-%m-%d')
127             undone_dotation_number = 0
128             while depreciation_date <= end_date:
129                 depreciation_date = (datetime(depreciation_date.year, depreciation_date.month, depreciation_date.day) + relativedelta(months=+asset.method_period))
130                 undone_dotation_number += 1
131         if asset.prorata:
132             undone_dotation_number += 1
133         return undone_dotation_number
134
135     def compute_depreciation_board(self, cr, uid, ids, context=None):
136         depreciation_lin_obj = self.pool.get('account.asset.depreciation.line')
137         for asset in self.browse(cr, uid, ids, context=context):
138             if asset.value_residual == 0.0:
139                 continue
140             posted_depreciation_line_ids = depreciation_lin_obj.search(cr, uid, [('asset_id', '=', asset.id), ('move_check', '=', True)])
141             old_depreciation_line_ids = depreciation_lin_obj.search(cr, uid, [('asset_id', '=', asset.id), ('move_id', '=', False)])
142             if old_depreciation_line_ids:
143                 depreciation_lin_obj.unlink(cr, uid, old_depreciation_line_ids, context=context)
144
145             amount_to_depr = residual_amount = asset.value_residual
146             if asset.prorata:
147                 depreciation_date = datetime.strptime(self._get_last_depreciation_date(cr, uid, [asset.id], context)[asset.id], '%Y-%m-%d')
148             else:
149                 # depreciation_date = 1st January of purchase year
150                 purchase_date = datetime.strptime(asset.purchase_date, '%Y-%m-%d')
151                 depreciation_date = datetime(purchase_date.year, 1, 1)
152             day = depreciation_date.day
153             month = depreciation_date.month
154             year = depreciation_date.year
155             total_days = (year % 4) and 365 or 366
156
157             undone_dotation_number = self._compute_board_undone_dotation_nb(cr, uid, asset, depreciation_date, total_days, context=context)
158             for x in range(len(posted_depreciation_line_ids), undone_dotation_number):
159                 i = x + 1
160                 amount = self._compute_board_amount(cr, uid, asset, i, residual_amount, amount_to_depr, undone_dotation_number, posted_depreciation_line_ids, total_days, depreciation_date, context=context)
161                 residual_amount -= amount
162                 vals = {
163                      'amount': amount,
164                      'asset_id': asset.id,
165                      'sequence': i,
166                      'name': str(asset.id) +'/' + str(i),
167                      'remaining_value': residual_amount,
168                      'depreciated_value': (asset.purchase_value - asset.salvage_value) - (residual_amount + amount),
169                      'depreciation_date': depreciation_date.strftime('%Y-%m-%d'),
170                 }
171                 depreciation_lin_obj.create(cr, uid, vals, context=context)
172                 # Considering Depr. Period as months
173                 depreciation_date = (datetime(year, month, day) + relativedelta(months=+asset.method_period))
174                 day = depreciation_date.day
175                 month = depreciation_date.month
176                 year = depreciation_date.year
177         return True
178
179     def validate(self, cr, uid, ids, context={}):
180         return self.write(cr, uid, ids, {
181             'state':'open'
182         }, context)
183
184     def set_to_close(self, cr, uid, ids, context=None):
185         return self.write(cr, uid, ids, {'state': 'close'}, context=context)
186
187     def set_to_draft(self, cr, uid, ids, context=None):
188         return self.write(cr, uid, ids, {'state': 'draft'}, context=context)
189
190     def _amount_residual(self, cr, uid, ids, name, args, context=None):
191         cr.execute("""SELECT
192                 l.asset_id as id, round(SUM(abs(l.debit-l.credit))) AS amount
193             FROM
194                 account_move_line l
195             WHERE
196                 l.asset_id IN %s GROUP BY l.asset_id """, (tuple(ids),))
197         res=dict(cr.fetchall())
198         for asset in self.browse(cr, uid, ids, context):
199             res[asset.id] = asset.purchase_value - res.get(asset.id, 0.0) - asset.salvage_value
200         for id in ids:
201             res.setdefault(id, 0.0)
202         return res
203
204     def onchange_company_id(self, cr, uid, ids, company_id=False, context=None):
205         val = {}
206         if company_id:
207             company = self.pool.get('res.company').browse(cr, uid, company_id, context=context)
208             if company.currency_id.company_id and company.currency_id.company_id.id != company_id:
209                 val['currency_id'] = False
210             else:
211                 val['currency_id'] = company.currency_id.id
212         return {'value': val}
213
214     _columns = {
215         'account_move_line_ids': fields.one2many('account.move.line', 'asset_id', 'Entries', readonly=True, states={'draft':[('readonly',False)]}),
216         'name': fields.char('Asset', size=64, required=True, readonly=True, states={'draft':[('readonly',False)]}),
217         'code': fields.char('Reference', size=32, readonly=True, states={'draft':[('readonly',False)]}),
218         'purchase_value': fields.float('Gross value ', required=True, readonly=True, states={'draft':[('readonly',False)]}),
219         'currency_id': fields.many2one('res.currency','Currency',required=True, readonly=True, states={'draft':[('readonly',False)]}),
220         'company_id': fields.many2one('res.company', 'Company', required=True, readonly=True, states={'draft':[('readonly',False)]}),
221         'note': fields.text('Note'),
222         'category_id': fields.many2one('account.asset.category', 'Asset category', required=True, change_default=True, readonly=True, states={'draft':[('readonly',False)]}),
223         'parent_id': fields.many2one('account.asset.asset', 'Parent Asset', readonly=True, states={'draft':[('readonly',False)]}),
224         'child_ids': fields.one2many('account.asset.asset', 'parent_id', 'Children Assets'),
225         'purchase_date': fields.date('Purchase Date', required=True, readonly=True, states={'draft':[('readonly',False)]}),
226         'state': fields.selection([('draft','Draft'),('open','Running'),('close','Close')], 'State', required=True,
227                                   help="When an asset is created, the state is 'Draft'.\n" \
228                                        "If the asset is confirmed, the state goes in 'Running' and the depreciation lines can be posted in the accounting.\n" \
229                                        "You can manually close an asset when the depreciation is over. If the last line of depreciation is posted, the asset automatically goes in that state."),
230         'active': fields.boolean('Active'),
231         'partner_id': fields.many2one('res.partner', 'Partner', readonly=True, states={'draft':[('readonly',False)]}),
232         'method': fields.selection([('linear','Linear'),('degressive','Degressive')], 'Computation Method', required=True, readonly=True, states={'draft':[('readonly',False)]}, help="Choose the method to use to compute the amount of depreciation lines.\n"\
233             "  * Linear: Calculated on basis of: Gross Value / Number of Depreciations\n" \
234             "  * Degressive: Calculated on basis of: Remaining Value * Degressive Factor"),
235         'method_number': fields.integer('Number of Depreciations', readonly=True, states={'draft':[('readonly',False)]}, help="Calculates Depreciation within specified interval"),
236         'method_period': fields.integer('Period Length', required=True, readonly=True, states={'draft':[('readonly',False)]}, help="State here the time during 2 depreciations, in months"),
237         'method_end': fields.date('Ending Date', readonly=True, states={'draft':[('readonly',False)]}),
238         'method_progress_factor': fields.float('Degressive Factor', readonly=True, states={'draft':[('readonly',False)]}),
239         'value_residual': fields.function(_amount_residual, method=True, digits_compute=dp.get_precision('Account'), string='Residual Value'),
240         'method_time': fields.selection([('number','Number of Depreciations'),('end','Ending Date')], 'Time Method', required=True, readonly=True, states={'draft':[('readonly',False)]},
241                                   help="Choose the method to use to compute the dates and number of depreciation lines.\n"\
242                                        "  * Number of Depreciations: Fix the number of depreciation lines and the time between 2 depreciations.\n" \
243                                        "  * Ending Date: Choose the time between 2 depreciations and the date the depreciations won't go beyond."),
244         'prorata':fields.boolean('Prorata Temporis', readonly=True, states={'draft':[('readonly',False)]}, help='Indicates that the first depreciation entry for this asset have to be done from the purchase date instead of the first January'),
245         'history_ids': fields.one2many('account.asset.history', 'asset_id', 'History', readonly=True),
246         'depreciation_line_ids': fields.one2many('account.asset.depreciation.line', 'asset_id', 'Depreciation Lines', readonly=True, states={'draft':[('readonly',False)],'open':[('readonly',False)]}),
247         'salvage_value': fields.float('Salvage Value', digits_compute=dp.get_precision('Account'), help="It is the amount you plan to have that you cannot depreciate.", readonly=True, states={'draft':[('readonly',False)]}),
248     }
249     _defaults = {
250         'code': lambda obj, cr, uid, context: obj.pool.get('ir.sequence').get(cr, uid, 'account.asset.code'),
251         'purchase_date': lambda obj, cr, uid, context: time.strftime('%Y-%m-%d'),
252         'active': True,
253         'state': 'draft',
254         'method': 'linear',
255         'method_number': 5,
256         'method_time': 'number',
257         'method_period': 12,
258         'method_progress_factor': 0.3,
259         'currency_id': lambda self,cr,uid,c: self.pool.get('res.users').browse(cr, uid, uid, c).company_id.currency_id.id,
260         'company_id': lambda self, cr, uid, context: self.pool.get('res.company')._company_default_get(cr, uid, 'account.asset.asset',context=context),
261     }
262
263     def _check_recursion(self, cr, uid, ids, context=None, parent=None):
264         return super(account_asset_asset, self)._check_recursion(cr, uid, ids, context=context, parent=parent)
265
266     def _check_prorata(self, cr, uid, ids, context=None):
267         for asset in self.browse(cr, uid, ids, context=context):
268             if asset.prorata and asset.method_time != 'number':
269                 return False
270         return True
271
272     _constraints = [
273         (_check_recursion, 'Error ! You can not create recursive assets.', ['parent_id']),
274         (_check_prorata, 'Prorata temporis can be applied only for time method "number of depreciations".', ['prorata']),
275     ]
276
277     def onchange_category_id(self, cr, uid, ids, category_id, context=None):
278         res = {'value':{}}
279         asset_categ_obj = self.pool.get('account.asset.category')
280         if category_id:
281             category_obj = asset_categ_obj.browse(cr, uid, category_id, context=context)
282             res['value'] = {
283                             'method': category_obj.method,
284                             'method_number': category_obj.method_number,
285                             'method_time': category_obj.method_time,
286                             'method_period': category_obj.method_period,
287                             'method_progress_factor': category_obj.method_progress_factor,
288                             'method_end': category_obj.method_end,
289                             'prorata': category_obj.prorata,
290             }
291         return res
292
293     def onchange_method_time(self, cr, uid, ids, method_time='number', context=None):
294         res = {'value': {}}
295         if method_time != 'number':
296             res['value'] = {'prorata': False}
297         return res
298
299     def copy(self, cr, uid, id, default=None, context=None):
300         if default is None:
301             default = {}
302         if context is None:
303             context = {}
304         default.update({'depreciation_line_ids': [], 'state': 'draft'})
305         return super(account_asset_asset, self).copy(cr, uid, id, default, context=context)
306
307     def _compute_entries(self, cr, uid, ids, period_id, context={}):
308         result = []
309         period_obj = self.pool.get('account.period')
310         depreciation_obj = self.pool.get('account.asset.depreciation.line')
311         period = period_obj.browse(cr, uid, period_id, context=context)
312         depreciation_ids = depreciation_obj.search(cr, uid, [('asset_id', 'in', ids), ('depreciation_date', '<', period.date_stop), ('depreciation_date', '>', period.date_start), ('move_check', '=', False)], context=context)
313         return depreciation_obj.create_move(cr, uid, depreciation_ids, context=context)
314
315     def create(self, cr, uid, vals, context=None):
316         asset_id = super(account_asset_asset, self).create(cr, uid, vals, context=context)
317         self.compute_depreciation_board(cr, uid, [asset_id], context=context)
318         return asset_id
319
320 account_asset_asset()
321
322 class account_asset_depreciation_line(osv.osv):
323     _name = 'account.asset.depreciation.line'
324     _description = 'Asset depreciation line'
325
326     def _get_move_check(self, cr, uid, ids, name, args, context=None):
327         res = {}
328         for line in self.browse(cr, uid, ids, context=context):
329             res[line.id] = bool(line.move_id)
330         return res
331
332     _columns = {
333         'name': fields.char('Depreciation Name', size=64, required=True, select=1),
334         'sequence': fields.integer('Sequence of the depreciation', required=True),
335         'asset_id': fields.many2one('account.asset.asset', 'Asset', required=True),
336         'parent_state': fields.related('asset_id', 'state', type='char', string='State of Asset'),
337         'amount': fields.float('Depreciation Amount', required=True),
338         'remaining_value': fields.float('Amount to Depreciate', required=True),
339         'depreciated_value': fields.float('Amount Already Depreciated', required=True),
340         'depreciation_date': fields.char('Depreciation Date', size=64, select=1),
341         'move_id': fields.many2one('account.move', 'Depreciation Entry'),
342         'move_check': fields.function(_get_move_check, method=True, type='boolean', string='Posted', store=True)
343     }
344
345     def create_move(self, cr, uid, ids, context=None):
346         can_close = False
347         if context is None:
348             context = {}
349         asset_obj = self.pool.get('account.asset.asset')
350         period_obj = self.pool.get('account.period')
351         move_obj = self.pool.get('account.move')
352         move_line_obj = self.pool.get('account.move.line')
353         currency_obj = self.pool.get('res.currency')
354         created_move_ids = []
355         for line in self.browse(cr, uid, ids, context=context):
356             if currency_obj.is_zero(cr, uid, line.asset_id.currency_id, line.remaining_value):
357                 can_close = True
358             depreciation_date = line.asset_id.prorata and line.asset_id.purchase_date or time.strftime('%Y-%m-%d')
359             period_ids = period_obj.find(cr, uid, depreciation_date, context=context)
360             company_currency = line.asset_id.company_id.currency_id.id
361             current_currency = line.asset_id.currency_id.id
362             context.update({'date': depreciation_date})
363             amount = currency_obj.compute(cr, uid, current_currency, company_currency, line.amount, context=context)
364             sign = line.asset_id.category_id.journal_id.type = 'purchase' and 1 or -1
365             asset_name = line.asset_id.name
366             reference = line.name
367             move_vals = {
368                 'name': asset_name,
369                 'date': depreciation_date,
370                 'ref': reference,
371                 'period_id': period_ids and period_ids[0] or False,
372                 'journal_id': line.asset_id.category_id.journal_id.id,
373                 }
374             move_id = move_obj.create(cr, uid, move_vals, context=context)
375             journal_id = line.asset_id.category_id.journal_id.id
376             partner_id = line.asset_id.partner_id.id
377             move_line_obj.create(cr, uid, {
378                 'name': asset_name,
379                 'ref': reference,
380                 'move_id': move_id,
381                 'account_id': line.asset_id.category_id.account_depreciation_id.id,
382                 'debit': 0.0,
383                 'credit': amount,
384                 'period_id': period_ids and period_ids[0] or False,
385                 'journal_id': journal_id,
386                 'partner_id': partner_id,
387                 'currency_id': company_currency <> current_currency and  current_currency or False,
388                 'amount_currency': company_currency <> current_currency and - sign * line.amount or 0.0,
389                 'date': depreciation_date,
390             })
391             move_line_obj.create(cr, uid, {
392                 'name': asset_name,
393                 'ref': reference,
394                 'move_id': move_id,
395                 'account_id': line.asset_id.category_id.account_expense_depreciation_id.id,
396                 'credit': 0.0,
397                 'debit': amount,
398                 'period_id': period_ids and period_ids[0] or False,
399                 'journal_id': journal_id,
400                 'partner_id': partner_id,
401                 'currency_id': company_currency <> current_currency and  current_currency or False,
402                 'amount_currency': company_currency <> current_currency and sign * line.amount or 0.0,
403                 'analytic_account_id': line.asset_id.category_id.account_analytic_id.id,
404                 'date': depreciation_date,
405                 'asset_id': line.asset_id.id
406             })
407             self.write(cr, uid, line.id, {'move_id': move_id}, context=context)
408             created_move_ids.append(move_id)
409             if can_close:
410                 asset_obj.write(cr, uid, [line.asset_id.id], {'state': 'close'}, context=context)
411         return created_move_ids
412
413 account_asset_depreciation_line()
414
415 class account_move_line(osv.osv):
416     _inherit = 'account.move.line'
417     _columns = {
418         'asset_id': fields.many2one('account.asset.asset', 'Asset'),
419         'entry_ids': fields.one2many('account.move.line', 'asset_id', 'Entries', readonly=True, states={'draft':[('readonly',False)]}),
420
421     }
422 account_move_line()
423
424 class account_asset_history(osv.osv):
425     _name = 'account.asset.history'
426     _description = 'Asset history'
427     _columns = {
428         'name': fields.char('History name', size=64, select=1),
429         'user_id': fields.many2one('res.users', 'User', required=True),
430         'date': fields.date('Date', required=True),
431         'asset_id': fields.many2one('account.asset.asset', 'Asset', required=True),
432         'method_time': fields.selection([('number','Number of Depreciations'),('end','Ending Date')], 'Time Method', required=True,
433                                   help="The method to use to compute the dates and number of depreciation lines.\n"\
434                                        "Number of Depreciations: Fix the number of depreciation lines and the time between 2 depreciations.\n" \
435                                        "Ending Date: Choose the time between 2 depreciations and the date the depreciations won't go beyond."),
436         'method_number': fields.integer('Number of Depreciations'),
437         'method_period': fields.integer('Period Length', help="Time in month between two depreciations"),
438         'method_end': fields.date('Ending date'),
439         'note': fields.text('Note'),
440     }
441     _order = 'date desc'
442     _defaults = {
443         'date': lambda *args: time.strftime('%Y-%m-%d'),
444         'user_id': lambda self, cr, uid, ctx: uid
445     }
446
447 account_asset_history()
448
449 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: