addons/hr_expense/hr_expense.py

   1 # -*- coding: 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
  24 from openerp import netsvc
  25 from openerp.osv import fields, osv
  26 from openerp.tools.translate import _
  27
  28 import openerp.addons.decimal_precision as dp
  29
  30 def _employee_get(obj, cr, uid, context=None):
  31     if context is None:
  32         context = {}
  33     ids = obj.pool.get('hr.employee').search(cr, uid, [('user_id', '=', uid)], context=context)
  34     if ids:
  35         return ids[0]
  36     return False
  37
  38 class hr_expense_expense(osv.osv):
  39
  40     def copy(self, cr, uid, id, default=None, context=None):
  41         if context is None:
  42             context = {}
  43         if not default: default = {}
  44         default.update({'voucher_id': False, 'date_confirm': False, 'date_valid': False, 'user_valid': False})
  45         return super(hr_expense_expense, self).copy(cr, uid, id, default, context=context)
  46
  47     def _amount(self, cr, uid, ids, field_name, arg, context=None):
  48         res= {}
  49         for expense in self.browse(cr, uid, ids, context=context):
  50             total = 0.0
  51             for line in expense.line_ids:
  52                 total += line.unit_amount * line.unit_quantity
  53             res[expense.id] = total
  54         return res
  55
  56     def _get_currency(self, cr, uid, context=None):
  57         user = self.pool.get('res.users').browse(cr, uid, [uid], context=context)[0]
  58         if user.company_id:
  59             return user.company_id.currency_id.id
  60         else:
  61             return self.pool.get('res.currency').search(cr, uid, [('rate','=',1.0)], context=context)[0]
  62
  63     _name = "hr.expense.expense"
  64     _inherit = ['mail.thread']
  65     _description = "Expense"
  66     _order = "id desc"
  67     _track = {
  68         'state': {
  69             'hr_expense.mt_expense_approved': lambda self, cr, uid, obj, ctx=None: obj['state'] == 'accepted',
  70             'hr_expense.mt_expense_refused': lambda self, cr, uid, obj, ctx=None: obj['state'] == 'cancelled',
  71             'hr_expense.mt_expense_confirmed': lambda self, cr, uid, obj, ctx=None: obj['state'] == 'confirm',
  72         },
  73     }
  74
  75     _columns = {
  76         'name': fields.char('Description', size=128, required=True, readonly=True, states={'draft':[('readonly',False)], 'confirm':[('readonly',False)]}),
  77         'id': fields.integer('Sheet ID', readonly=True),
  78         'date': fields.date('Date', select=True, readonly=True, states={'draft':[('readonly',False)], 'confirm':[('readonly',False)]}),
  79         'journal_id': fields.many2one('account.journal', 'Force Journal', help = "The journal used when the expense is done."),
  80         'employee_id': fields.many2one('hr.employee', "Employee", required=True, readonly=True, states={'draft':[('readonly',False)], 'confirm':[('readonly',False)]}),
  81         'user_id': fields.many2one('res.users', 'User', required=True),
  82         'date_confirm': fields.date('Confirmation Date', select=True, help="Date of the confirmation of the sheet expense. It's filled when the button Confirm is pressed."),
  83         'date_valid': fields.date('Validation Date', select=True, help="Date of the acceptation of the sheet expense. It's filled when the button Accept is pressed."),
  84         'user_valid': fields.many2one('res.users', 'Validation By', readonly=True, states={'draft':[('readonly',False)], 'confirm':[('readonly',False)]}),
  85         'account_move_id': fields.many2one('account.move', 'Ledger Posting'),
  86         'line_ids': fields.one2many('hr.expense.line', 'expense_id', 'Expense Lines', readonly=True, states={'draft':[('readonly',False)]} ),
  87         'note': fields.text('Note'),
  88         'amount': fields.function(_amount, string='Total Amount', digits_compute=dp.get_precision('Account')),
  89         'voucher_id': fields.many2one('account.voucher', "Employee's Receipt"),
  90         'currency_id': fields.many2one('res.currency', 'Currency', required=True, readonly=True, states={'draft':[('readonly',False)], 'confirm':[('readonly',False)]}),
  91         'department_id':fields.many2one('hr.department','Department', readonly=True, states={'draft':[('readonly',False)], 'confirm':[('readonly',False)]}),
  92         'company_id': fields.many2one('res.company', 'Company', required=True),
  93         'state': fields.selection([
  94             ('draft', 'New'),
  95             ('cancelled', 'Refused'),
  96             ('confirm', 'Waiting Approval'),
  97             ('accepted', 'Approved'),
  98             ('done', 'Done'),
  99             ],
 100             'Status', readonly=True, track_visibility='onchange',
 101             help='When the expense request is created the status is \'Draft\'.\n It is confirmed by the user and request is sent to admin, the status is \'Waiting Confirmation\'.\
 102             \nIf the admin accepts it, the status is \'Accepted\'.\n If a receipt is made for the expense request, the status is \'Done\'.'),
 103     }
 104     _defaults = {
 105         'company_id': lambda s, cr, uid, c: s.pool.get('res.company')._company_default_get(cr, uid, 'hr.employee', context=c),
 106         'date': fields.date.context_today,
 107         'state': 'draft',
 108         'employee_id': _employee_get,
 109         'user_id': lambda cr, uid, id, c={}: id,
 110         'currency_id': _get_currency,
 111     }
 112
 113     def unlink(self, cr, uid, ids, context=None):
 114         for rec in self.browse(cr, uid, ids, context=context):
 115             if rec.state != 'draft':
 116                 raise osv.except_osv(_('Warning!'),_('You can only delete draft expenses!'))
 117         return super(hr_expense_expense, self).unlink(cr, uid, ids, context)
 118
 119     def onchange_currency_id(self, cr, uid, ids, currency_id=False, company_id=False, context=None):
 120         res =  {'value': {'journal_id': False}}
 121         journal_ids = self.pool.get('account.journal').search(cr, uid, [('type','=','purchase'), ('currency','=',currency_id), ('company_id', '=', company_id)], context=context)
 122         if journal_ids:
 123             res['value']['journal_id'] = journal_ids[0]
 124         return res
 125
 126     def onchange_employee_id(self, cr, uid, ids, employee_id, context=None):
 127         emp_obj = self.pool.get('hr.employee')
 128         department_id = False
 129         company_id = False
 130         if employee_id:
 131             employee = emp_obj.browse(cr, uid, employee_id, context=context)
 132             department_id = employee.department_id.id
 133             company_id = employee.company_id.id
 134         return {'value': {'department_id': department_id, 'company_id': company_id}}
 135
 136     def expense_confirm(self, cr, uid, ids, context=None):
 137         for expense in self.browse(cr, uid, ids):
 138             if expense.employee_id and expense.employee_id.parent_id.user_id:
 139                 self.message_subscribe_users(cr, uid, [expense.id], user_ids=[expense.employee_id.parent_id.user_id.id])
 140         return self.write(cr, uid, ids, {'state': 'confirm', 'date_confirm': time.strftime('%Y-%m-%d')}, context=context)
 141
 142     def expense_accept(self, cr, uid, ids, context=None):
 143         return self.write(cr, uid, ids, {'state': 'accepted', 'date_valid': time.strftime('%Y-%m-%d'), 'user_valid': uid}, context=context)
 144
 145     def expense_canceled(self, cr, uid, ids, context=None):
 146         return self.write(cr, uid, ids, {'state': 'cancelled'}, context=context)
 147
 148     def action_receipt_create(self, cr, uid, ids, context=None):
 149         property_obj = self.pool.get('ir.property')
 150         sequence_obj = self.pool.get('ir.sequence')
 151         analytic_journal_obj = self.pool.get('account.analytic.journal')
 152         account_journal = self.pool.get('account.journal')
 153         voucher_obj = self.pool.get('account.voucher')
 154         currency_obj = self.pool.get('res.currency')
 155         wkf_service = netsvc.LocalService("workflow")
 156         if context is None:
 157             context = {}
 158         for exp in self.browse(cr, uid, ids, context=context):
 159             company_id = exp.company_id.id
 160             lines = []
 161             total = 0.0
 162             ctx = context.copy()
 163             ctx.update({'date': exp.date})
 164             journal = False
 165             if exp.journal_id:
 166                 journal = exp.journal_id
 167             else:
 168                 journal_id = voucher_obj._get_journal(cr, uid, context={'type': 'purchase', 'company_id': company_id})
 169                 if journal_id:
 170                     journal = account_journal.browse(cr, uid, journal_id, context=context)
 171             if not journal:
 172                raise osv.except_osv(_('Error!'), _("No expense journal found. Please make sure you have a journal with type 'purchase' configured."))
 173             for line in exp.line_ids:
 174                 if line.product_id:
 175                     acc = line.product_id.property_account_expense
 176                     if not acc:
 177                         acc = line.product_id.categ_id.property_account_expense_categ
 178                 else:
 179                     acc = property_obj.get(cr, uid, 'property_account_expense_categ', 'product.category', context={'force_company': company_id})
 180                     if not acc:
 181                         raise osv.except_osv(_('Error!'), _('Please configure Default Expense account for Product purchase: `property_account_expense_categ`.'))
 182                 total_amount = line.total_amount
 183                 if journal.currency:
 184                     if exp.currency_id != journal.currency:
 185                         total_amount = currency_obj.compute(cr, uid, exp.currency_id.id, journal.currency.id, total_amount, context=ctx)
 186                 elif exp.currency_id != exp.company_id.currency_id:
 187                     total_amount = currency_obj.compute(cr, uid, exp.currency_id.id, exp.company_id.currency_id.id, total_amount, context=ctx)
 188                 lines.append((0, False, {
 189                     'name': line.name,
 190                     'account_id': acc.id,
 191                     'account_analytic_id': line.analytic_account.id,
 192                     'amount': total_amount,
 193                     'type': 'dr'
 194                 }))
 195                 total += total_amount
 196             if not exp.employee_id.address_home_id:
 197                 raise osv.except_osv(_('Error!'), _('The employee must have a home address.'))
 198             acc = exp.employee_id.address_home_id.property_account_payable.id
 199             voucher = {
 200                 'name': exp.name or '/',
 201                 'reference': sequence_obj.get(cr, uid, 'hr.expense.invoice'),
 202                 'account_id': acc,
 203                 'type': 'purchase',
 204                 'partner_id': exp.employee_id.address_home_id.id,
 205                 'company_id': company_id,
 206                 'line_ids': lines,
 207                 'amount': total,
 208                 'journal_id': journal.id,
 209             }
 210             if journal and not journal.analytic_journal_id:
 211                 analytic_journal_ids = analytic_journal_obj.search(cr, uid, [('type','=','purchase')], context=context)
 212                 if analytic_journal_ids:
 213                     account_journal.write(cr, uid, [journal.id], {'analytic_journal_id': analytic_journal_ids[0]}, context=context)
 214             voucher_id = voucher_obj.create(cr, uid, voucher, context=context)
 215             wkf_service.trg_validate(uid, 'account.voucher', voucher_id, 'proforma_voucher', cr)
 216             self.write(cr, uid, [exp.id], {'voucher_id': voucher_id, 'state': 'done'}, context=context)
 217         return True
 218
 219     def action_view_receipt(self, cr, uid, ids, context=None):
 220         '''
 221         This function returns an action that display existing receipt of given expense ids.
 222         '''
 223         assert len(ids) == 1, 'This option should only be used for a single id at a time'
 224         voucher_id = self.browse(cr, uid, ids[0], context=context).voucher_id.id
 225         res = self.pool.get('ir.model.data').get_object_reference(cr, uid, 'account_voucher', 'view_purchase_receipt_form')
 226         result = {
 227             'name': _('Expense Receipt'),
 228             'view_type': 'form',
 229             'view_mode': 'form',
 230             'view_id': res and res[1] or False,
 231             'res_model': 'account.voucher',
 232             'type': 'ir.actions.act_window',
 233             'nodestroy': True,
 234             'target': 'current',
 235             'res_id': voucher_id,
 236         }
 237         return result
 238
 239 hr_expense_expense()
 240
 241 class product_product(osv.osv):
 242     _inherit = "product.product"
 243     _columns = {
 244         'hr_expense_ok': fields.boolean('Can be Expensed', help="Specify if the product can be selected in an HR expense line."),
 245     }
 246
 247 product_product()
 248
 249 class hr_expense_line(osv.osv):
 250     _name = "hr.expense.line"
 251     _description = "Expense Line"
 252
 253     def _amount(self, cr, uid, ids, field_name, arg, context=None):
 254         if not ids:
 255             return {}
 256         cr.execute("SELECT l.id,COALESCE(SUM(l.unit_amount*l.unit_quantity),0) AS amount FROM hr_expense_line l WHERE id IN %s GROUP BY l.id ",(tuple(ids),))
 257         res = dict(cr.fetchall())
 258         return res
 259
 260     def _get_uom_id(self, cr, uid, context=None):
 261         result = self.pool.get('ir.model.data').get_object_reference(cr, uid, 'product', 'product_uom_unit')
 262         return result and result[1] or False
 263
 264     _columns = {
 265         'name': fields.char('Expense Note', size=128, required=True),
 266         'date_value': fields.date('Date', required=True),
 267         'expense_id': fields.many2one('hr.expense.expense', 'Expense', ondelete='cascade', select=True),
 268         'total_amount': fields.function(_amount, string='Total', digits_compute=dp.get_precision('Account')),
 269         'unit_amount': fields.float('Unit Price', digits_compute=dp.get_precision('Product Price')),
 270         'unit_quantity': fields.float('Quantities', digits_compute= dp.get_precision('Product Unit of Measure')),
 271         'product_id': fields.many2one('product.product', 'Product', domain=[('hr_expense_ok','=',True)]),
 272         'uom_id': fields.many2one('product.uom', 'Unit of Measure', required=True),
 273         'description': fields.text('Description'),
 274         'analytic_account': fields.many2one('account.analytic.account','Analytic account'),
 275         'ref': fields.char('Reference', size=32),
 276         'sequence': fields.integer('Sequence', select=True, help="Gives the sequence order when displaying a list of expense lines."),
 277         }
 278     _defaults = {
 279         'unit_quantity': 1,
 280         'date_value': lambda *a: time.strftime('%Y-%m-%d'),
 281         'uom_id': _get_uom_id,
 282     }
 283     _order = "sequence, date_value desc"
 284
 285     def onchange_product_id(self, cr, uid, ids, product_id, context=None):
 286         res = {}
 287         if product_id:
 288             product = self.pool.get('product.product').browse(cr, uid, product_id, context=context)
 289             res['name'] = product.name
 290             amount_unit = product.price_get('standard_price')[product.id]
 291             res['unit_amount'] = amount_unit
 292             res['uom_id'] = product.uom_id.id
 293         return {'value': res}
 294
 295     def onchange_uom(self, cr, uid, ids, product_id, uom_id, context=None):
 296         res = {'value':{}}
 297         if not uom_id or not product_id:
 298             return res
 299         product = self.pool.get('product.product').browse(cr, uid, product_id, context=context)
 300         uom = self.pool.get('product.uom').browse(cr, uid, uom_id, context=context)
 301         if uom.category_id.id != product.uom_id.category_id.id:
 302             res['warning'] = {'title': _('Warning'), 'message': _('Selected Unit of Measure does not belong to the same category as the product Unit of Measure')}
 303             res['value'].update({'uom_id': product.uom_id.id})
 304         return res
 305
 306 hr_expense_line()
 307
 308 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: