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 _amount(self, cr, uid, ids, field_name, arg, context=None):
  41         res= {}
  42         for expense in self.browse(cr, uid, ids, context=context):
  43             total = 0.0
  44             for line in expense.line_ids:
  45                 total += line.unit_amount * line.unit_quantity
  46             res[expense.id] = total
  47         return res
  48
  49     def _get_currency(self, cr, uid, context=None):
  50         user = self.pool.get('res.users').browse(cr, uid, [uid], context=context)[0]
  51         return user.company_id.currency_id.id
  52
  53     _name = "hr.expense.expense"
  54     _inherit = ['mail.thread']
  55     _description = "Expense"
  56     _order = "id desc"
  57     _track = {
  58         'state': {
  59             'hr_expense.mt_expense_approved': lambda self, cr, uid, obj, ctx=None: obj['state'] == 'accepted',
  60             'hr_expense.mt_expense_refused': lambda self, cr, uid, obj, ctx=None: obj['state'] == 'cancelled',
  61             'hr_expense.mt_expense_confirmed': lambda self, cr, uid, obj, ctx=None: obj['state'] == 'confirm',
  62         },
  63     }
  64
  65     _columns = {
  66         'name': fields.char('Description', size=128, required=True, readonly=True, states={'draft':[('readonly',False)], 'confirm':[('readonly',False)]}),
  67         'id': fields.integer('Sheet ID', readonly=True),
  68         'date': fields.date('Date', select=True, readonly=True, states={'draft':[('readonly',False)], 'confirm':[('readonly',False)]}),
  69         'journal_id': fields.many2one('account.journal', 'Force Journal', help = "The journal used when the expense is done."),
  70         'employee_id': fields.many2one('hr.employee', "Employee", required=True, readonly=True, states={'draft':[('readonly',False)], 'confirm':[('readonly',False)]}),
  71         'user_id': fields.many2one('res.users', 'User', required=True),
  72         '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."),
  73         '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."),
  74         'user_valid': fields.many2one('res.users', 'Validation By', readonly=True, states={'draft':[('readonly',False)], 'confirm':[('readonly',False)]}),
  75         'account_move_id': fields.many2one('account.move', 'Ledger Posting'),
  76         'line_ids': fields.one2many('hr.expense.line', 'expense_id', 'Expense Lines', readonly=True, states={'draft':[('readonly',False)]} ),
  77         'note': fields.text('Note'),
  78         'amount': fields.function(_amount, string='Total Amount', digits_compute=dp.get_precision('Account')),
  79         'voucher_id': fields.many2one('account.voucher', "Employee's Receipt"),
  80         'currency_id': fields.many2one('res.currency', 'Currency', required=True, readonly=True, states={'draft':[('readonly',False)], 'confirm':[('readonly',False)]}),
  81         'department_id':fields.many2one('hr.department','Department', readonly=True, states={'draft':[('readonly',False)], 'confirm':[('readonly',False)]}),
  82         'company_id': fields.many2one('res.company', 'Company', required=True),
  83         'state': fields.selection([
  84             ('draft', 'New'),
  85             ('cancelled', 'Refused'),
  86             ('confirm', 'Waiting Approval'),
  87             ('accepted', 'Approved'),
  88             ('done', 'Waiting Payment'),
  89             ('paid', 'Paid'),
  90             ],
  91             'Status', readonly=True, track_visibility='onchange',
  92             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\'.\
  93             \nIf the admin accepts it, the status is \'Accepted\'.\n If the accounting entries are made for the expense request, the status is \'Waiting Payment\'.'),
  94
  95     }
  96     _defaults = {
  97         'company_id': lambda s, cr, uid, c: s.pool.get('res.company')._company_default_get(cr, uid, 'hr.employee', context=c),
  98         'date': fields.date.context_today,
  99         'state': 'draft',
 100         'employee_id': _employee_get,
 101         'user_id': lambda cr, uid, id, c={}: id,
 102         'currency_id': _get_currency,
 103     }
 104
 105     def copy(self, cr, uid, id, default=None, context=None):
 106         if default is None:
 107             default = {}
 108         default.update(
 109             account_move_id=False,
 110             voucher_id=False,
 111             date_confirm=False,
 112             date_valid=False,
 113             user_valid=False)
 114         return super(hr_expense_expense, self).copy(cr, uid, id, default=default, context=context)
 115
 116     def unlink(self, cr, uid, ids, context=None):
 117         for rec in self.browse(cr, uid, ids, context=context):
 118             if rec.state != 'draft':
 119                 raise osv.except_osv(_('Warning!'),_('You can only delete draft expenses!'))
 120         return super(hr_expense_expense, self).unlink(cr, uid, ids, context)
 121
 122     def onchange_currency_id(self, cr, uid, ids, currency_id=False, company_id=False, context=None):
 123         res =  {'value': {'journal_id': False}}
 124         journal_ids = self.pool.get('account.journal').search(cr, uid, [('type','=','purchase'), ('currency','=',currency_id), ('company_id', '=', company_id)], context=context)
 125         if journal_ids:
 126             res['value']['journal_id'] = journal_ids[0]
 127         return res
 128
 129     def onchange_employee_id(self, cr, uid, ids, employee_id, context=None):
 130         emp_obj = self.pool.get('hr.employee')
 131         department_id = False
 132         company_id = False
 133         if employee_id:
 134             employee = emp_obj.browse(cr, uid, employee_id, context=context)
 135             department_id = employee.department_id.id
 136             company_id = employee.company_id.id
 137         return {'value': {'department_id': department_id, 'company_id': company_id}}
 138
 139     def expense_confirm(self, cr, uid, ids, context=None):
 140         for expense in self.browse(cr, uid, ids):
 141             if expense.employee_id and expense.employee_id.parent_id.user_id:
 142                 self.message_subscribe_users(cr, uid, [expense.id], user_ids=[expense.employee_id.parent_id.user_id.id])
 143         return self.write(cr, uid, ids, {'state': 'confirm', 'date_confirm': time.strftime('%Y-%m-%d')}, context=context)
 144
 145     def expense_accept(self, cr, uid, ids, context=None):
 146         return self.write(cr, uid, ids, {'state': 'accepted', 'date_valid': time.strftime('%Y-%m-%d'), 'user_valid': uid}, context=context)
 147
 148     def expense_canceled(self, cr, uid, ids, context=None):
 149         return self.write(cr, uid, ids, {'state': 'cancelled'}, context=context)
 150
 151     def account_move_get(self, cr, uid, expense_id, context=None):
 152         '''
 153         This method prepare the creation of the account move related to the given expense.
 154
 155         :param expense_id: Id of voucher for which we are creating account_move.
 156         :return: mapping between fieldname and value of account move to create
 157         :rtype: dict
 158         '''
 159         journal_obj = self.pool.get('account.journal')
 160         expense = self.browse(cr, uid, expense_id, context=context)
 161         company_id = expense.company_id.id
 162         date = expense.date_confirm
 163         ref = expense.name
 164         journal_id = False
 165         if expense.journal_id:
 166             journal_id = expense.journal_id.id
 167         else:
 168             journal_id = journal_obj.search(cr, uid, [('type', '=', 'purchase'), ('company_id', '=', company_id)])
 169             if not journal_id:
 170                 raise osv.except_osv(_('Error!'), _("No expense journal found. Please make sure you have a journal with type 'purchase' configured."))
 171             journal_id = journal_id[0]
 172         return self.pool.get('account.move').account_move_prepare(cr, uid, journal_id, date=date, ref=ref, company_id=company_id, context=context)
 173
 174     def line_get_convert(self, cr, uid, x, part, date, context=None):
 175         partner_id  = self.pool.get('res.partner')._find_accounting_partner(part).id
 176         return {
 177             'date_maturity': x.get('date_maturity', False),
 178             'partner_id': partner_id,
 179             'name': x['name'][:64],
 180             'date': date,
 181             'debit': x['price']>0 and x['price'],
 182             'credit': x['price']<0 and -x['price'],
 183             'account_id': x['account_id'],
 184             'analytic_lines': x.get('analytic_lines', False),
 185             'amount_currency': x['price']>0 and abs(x.get('amount_currency', False)) or -abs(x.get('amount_currency', False)),
 186             'currency_id': x.get('currency_id', False),
 187             'tax_code_id': x.get('tax_code_id', False),
 188             'tax_amount': x.get('tax_amount', False),
 189             'ref': x.get('ref', False),
 190             'quantity': x.get('quantity',1.00),
 191             'product_id': x.get('product_id', False),
 192             'product_uom_id': x.get('uos_id', False),
 193             'analytic_account_id': x.get('account_analytic_id', False),
 194         }
 195
 196     def compute_expense_totals(self, cr, uid, exp, company_currency, ref, account_move_lines, context=None):
 197         '''
 198         internal method used for computation of total amount of an expense in the company currency and
 199         in the expense currency, given the account_move_lines that will be created. It also do some small
 200         transformations at these account_move_lines (for multi-currency purposes)
 201
 202         :param account_move_lines: list of dict
 203         :rtype: tuple of 3 elements (a, b ,c)
 204             a: total in company currency
 205             b: total in hr.expense currency
 206             c: account_move_lines potentially modified
 207         '''
 208         cur_obj = self.pool.get('res.currency')
 209         if context is None:
 210             context={}
 211         context.update({'date': exp.date_confirm or time.strftime('%Y-%m-%d')})
 212         total = 0.0
 213         total_currency = 0.0
 214         for i in account_move_lines:
 215             if exp.currency_id.id != company_currency:
 216                 i['currency_id'] = exp.currency_id.id
 217                 i['amount_currency'] = i['price']
 218                 i['price'] = cur_obj.compute(cr, uid, exp.currency_id.id,
 219                         company_currency, i['price'],
 220                         context=context)
 221             else:
 222                 i['amount_currency'] = False
 223                 i['currency_id'] = False
 224             total -= i['price']
 225             total_currency -= i['amount_currency'] or i['price']
 226         return total, total_currency, account_move_lines
 227
 228
 229     def action_receipt_create(self, cr, uid, ids, context=None):
 230         '''
 231         main function that is called when trying to create the accounting entries related to an expense
 232         '''
 233         move_obj = self.pool.get('account.move')
 234         for exp in self.browse(cr, uid, ids, context=context):
 235             if not exp.employee_id.address_home_id:
 236                 raise osv.except_osv(_('Error!'), _('The employee must have a home address.'))
 237             if not exp.employee_id.address_home_id.property_account_payable.id:
 238                 raise osv.except_osv(_('Error!'), _('The employee must have a payable account set on his home address.'))
 239             company_currency = exp.company_id.currency_id.id
 240             diff_currency_p = exp.currency_id.id <> company_currency
 241
 242             #create the move that will contain the accounting entries
 243             move_id = move_obj.create(cr, uid, self.account_move_get(cr, uid, exp.id, context=context), context=context)
 244
 245             #one account.move.line per expense line (+taxes..)
 246             eml = self.move_line_get(cr, uid, exp.id, context=context)
 247
 248             #create one more move line, a counterline for the total on payable account
 249             total, total_currency, eml = self.compute_expense_totals(cr, uid, exp, company_currency, exp.name, eml, context=context)
 250             acc = exp.employee_id.address_home_id.property_account_payable.id
 251             eml.append({
 252                     'type': 'dest',
 253                     'name': '/',
 254                     'price': total,
 255                     'account_id': acc,
 256                     'date_maturity': exp.date_confirm,
 257                     'amount_currency': diff_currency_p and total_currency or False,
 258                     'currency_id': diff_currency_p and exp.currency_id.id or False,
 259                     'ref': exp.name
 260                     })
 261
 262             #convert eml into an osv-valid format
 263             lines = map(lambda x:(0,0,self.line_get_convert(cr, uid, x, exp.employee_id.address_home_id, exp.date_confirm, context=context)), eml)
 264             journal_id = move_obj.browse(cr, uid, move_id, context).journal_id
 265             # post the journal entry if 'Skip 'Draft' State for Manual Entries' is checked
 266             if journal_id.entry_posted:
 267                 move_obj.button_validate(cr, uid, [move_id], context)
 268             move_obj.write(cr, uid, [move_id], {'line_id': lines}, context=context)
 269             self.write(cr, uid, ids, {'account_move_id': move_id, 'state': 'done'}, context=context)
 270         return True
 271
 272     def move_line_get(self, cr, uid, expense_id, context=None):
 273         res = []
 274         tax_obj = self.pool.get('account.tax')
 275         cur_obj = self.pool.get('res.currency')
 276         if context is None:
 277             context = {}
 278         exp = self.browse(cr, uid, expense_id, context=context)
 279         company_currency = exp.company_id.currency_id.id
 280
 281         for line in exp.line_ids:
 282             mres = self.move_line_get_item(cr, uid, line, context)
 283             if not mres:
 284                 continue
 285             res.append(mres)
 286
 287             #Calculate tax according to default tax on product
 288             taxes = []
 289             #Taken from product_id_onchange in account.invoice
 290             if line.product_id:
 291                 fposition_id = False
 292                 fpos_obj = self.pool.get('account.fiscal.position')
 293                 fpos = fposition_id and fpos_obj.browse(cr, uid, fposition_id, context=context) or False
 294                 product = line.product_id
 295                 taxes = product.supplier_taxes_id
 296                 #If taxes are not related to the product, maybe they are in the account
 297                 if not taxes:
 298                     a = product.property_account_expense.id #Why is not there a check here?
 299                     if not a:
 300                         a = product.categ_id.property_account_expense_categ.id
 301                     a = fpos_obj.map_account(cr, uid, fpos, a)
 302                     taxes = a and self.pool.get('account.account').browse(cr, uid, a, context=context).tax_ids or False
 303             if not taxes:
 304                 continue
 305             tax_l = []
 306             #Calculating tax on the line and creating move?
 307             for tax in tax_obj.compute_all(cr, uid, taxes,
 308                     line.unit_amount ,
 309                     line.unit_quantity, line.product_id,
 310                     exp.user_id.partner_id)['taxes']:
 311                 tax_code_id = tax['base_code_id']
 312                 if not tax_code_id:
 313                     continue
 314                 res[-1]['tax_code_id'] = tax_code_id
 315                 ##
 316                 is_price_include = tax_obj.read(cr,uid,tax['id'],['price_include'],context)['price_include']
 317                 if is_price_include:
 318                     ## We need to deduce the price for the tax
 319                     res[-1]['price'] = res[-1]['price']  - (tax['amount'] * tax['base_sign'] or 0.0)
 320                     # tax amount countains base amount without the tax
 321                     tax_amount = (line.total_amount - tax['amount']) * tax['base_sign']
 322                 else:
 323                     tax_amount = line.total_amount * tax['base_sign']
 324                 res[-1]['tax_amount'] = cur_obj.compute(cr, uid, exp.currency_id.id, company_currency, tax_amount, context={'date': exp.date_confirm})
 325                 assoc_tax = {
 326                              'type':'tax',
 327                              'name':tax['name'],
 328                              'price_unit': tax['price_unit'],
 329                              'quantity': 1,
 330                              'price':  tax['amount'] * tax['base_sign'] or 0.0,
 331                              'account_id': tax['account_collected_id'] or mres['account_id'],
 332                              'tax_code_id': tax['tax_code_id'],
 333                              'tax_amount': tax['amount'] * tax['base_sign'],
 334                              }
 335                 tax_l.append(assoc_tax)
 336             res += tax_l
 337         return res
 338
 339     def move_line_get_item(self, cr, uid, line, context=None):
 340         company = line.expense_id.company_id
 341         property_obj = self.pool.get('ir.property')
 342         if line.product_id:
 343             acc = line.product_id.property_account_expense
 344             if not acc:
 345                 acc = line.product_id.categ_id.property_account_expense_categ
 346             if not acc:
 347                 raise osv.except_osv(_('Error!'), _('No purchase account found for the product %s (or for his category), please configure one.') % (line.product_id.name))
 348         else:
 349             acc = property_obj.get(cr, uid, 'property_account_expense_categ', 'product.category', context={'force_company': company.id})
 350             if not acc:
 351                 raise osv.except_osv(_('Error!'), _('Please configure Default Expense account for Product purchase: `property_account_expense_categ`.'))
 352         return {
 353             'type':'src',
 354             'name': line.name.split('\n')[0][:64],
 355             'price_unit':line.unit_amount,
 356             'quantity':line.unit_quantity,
 357             'price':line.total_amount,
 358             'account_id':acc.id,
 359             'product_id':line.product_id.id,
 360             'uos_id':line.uom_id.id,
 361             'account_analytic_id':line.analytic_account.id,
 362         }
 363
 364     def action_view_receipt(self, cr, uid, ids, context=None):
 365         '''
 366         This function returns an action that display existing account.move of given expense ids.
 367         '''
 368         assert len(ids) == 1, 'This option should only be used for a single id at a time'
 369         expense = self.browse(cr, uid, ids[0], context=context)
 370         assert expense.account_move_id
 371         try:
 372             dummy, view_id = self.pool.get('ir.model.data').get_object_reference(cr, uid, 'account', 'view_move_form')
 373         except ValueError, e:
 374             view_id = False
 375         result = {
 376             'name': _('Expense Account Move'),
 377             'view_type': 'form',
 378             'view_mode': 'form',
 379             'view_id': view_id,
 380             'res_model': 'account.move',
 381             'type': 'ir.actions.act_window',
 382             'nodestroy': True,
 383             'target': 'current',
 384             'res_id': expense.account_move_id.id,
 385         }
 386         return result
 387
 388 hr_expense_expense()
 389
 390 class product_product(osv.osv):
 391     _inherit = "product.product"
 392     _columns = {
 393         'hr_expense_ok': fields.boolean('Can be Expensed', help="Specify if the product can be selected in an HR expense line."),
 394     }
 395
 396 product_product()
 397
 398 class hr_expense_line(osv.osv):
 399     _name = "hr.expense.line"
 400     _description = "Expense Line"
 401
 402     def _amount(self, cr, uid, ids, field_name, arg, context=None):
 403         if not ids:
 404             return {}
 405         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),))
 406         res = dict(cr.fetchall())
 407         return res
 408
 409     def _get_uom_id(self, cr, uid, context=None):
 410         result = self.pool.get('ir.model.data').get_object_reference(cr, uid, 'product', 'product_uom_unit')
 411         return result and result[1] or False
 412
 413     _columns = {
 414         'name': fields.char('Expense Note', size=128, required=True),
 415         'date_value': fields.date('Date', required=True),
 416         'expense_id': fields.many2one('hr.expense.expense', 'Expense', ondelete='cascade', select=True),
 417         'total_amount': fields.function(_amount, string='Total', digits_compute=dp.get_precision('Account')),
 418         'unit_amount': fields.float('Unit Price', digits_compute=dp.get_precision('Product Price')),
 419         'unit_quantity': fields.float('Quantities', digits_compute= dp.get_precision('Product Unit of Measure')),
 420         'product_id': fields.many2one('product.product', 'Product', domain=[('hr_expense_ok','=',True)]),
 421         'uom_id': fields.many2one('product.uom', 'Unit of Measure', required=True),
 422         'description': fields.text('Description'),
 423         'analytic_account': fields.many2one('account.analytic.account','Analytic account'),
 424         'ref': fields.char('Reference', size=32),
 425         'sequence': fields.integer('Sequence', select=True, help="Gives the sequence order when displaying a list of expense lines."),
 426         }
 427     _defaults = {
 428         'unit_quantity': 1,
 429         'date_value': lambda *a: time.strftime('%Y-%m-%d'),
 430         'uom_id': _get_uom_id,
 431     }
 432     _order = "sequence, date_value desc"
 433
 434     def onchange_product_id(self, cr, uid, ids, product_id, context=None):
 435         res = {}
 436         if product_id:
 437             product = self.pool.get('product.product').browse(cr, uid, product_id, context=context)
 438             res['name'] = product.name
 439             amount_unit = product.price_get('standard_price')[product.id]
 440             res['unit_amount'] = amount_unit
 441             res['uom_id'] = product.uom_id.id
 442         return {'value': res}
 443
 444     def onchange_uom(self, cr, uid, ids, product_id, uom_id, context=None):
 445         res = {'value':{}}
 446         if not uom_id or not product_id:
 447             return res
 448         product = self.pool.get('product.product').browse(cr, uid, product_id, context=context)
 449         uom = self.pool.get('product.uom').browse(cr, uid, uom_id, context=context)
 450         if uom.category_id.id != product.uom_id.category_id.id:
 451             res['warning'] = {'title': _('Warning'), 'message': _('Selected Unit of Measure does not belong to the same category as the product Unit of Measure')}
 452             res['value'].update({'uom_id': product.uom_id.id})
 453         return res
 454
 455 hr_expense_line()
 456
 457 class account_move_line(osv.osv):
 458     _inherit = "account.move.line"
 459
 460     def reconcile(self, cr, uid, ids, type='auto', writeoff_acc_id=False, writeoff_period_id=False, writeoff_journal_id=False, context=None):
 461         res = super(account_move_line, self).reconcile(cr, uid, ids, type=type, writeoff_acc_id=writeoff_acc_id, writeoff_period_id=writeoff_period_id, writeoff_journal_id=writeoff_journal_id, context=context)
 462         #when making a full reconciliation of account move lines 'ids', we may need to recompute the state of some hr.expense
 463         account_move_ids = [aml.move_id.id for aml in self.browse(cr, uid, ids, context=context)]
 464         expense_obj = self.pool.get('hr.expense.expense')
 465         currency_obj = self.pool.get('res.currency')
 466         if account_move_ids:
 467             expense_ids = expense_obj.search(cr, uid, [('account_move_id', 'in', account_move_ids)], context=context)
 468             for expense in expense_obj.browse(cr, uid, expense_ids, context=context):
 469                 if expense.state == 'done':
 470                     #making the postulate it has to be set paid, then trying to invalidate it
 471                     new_status_is_paid = True
 472                     for aml in expense.account_move_id.line_id:
 473                         if aml.account_id.type == 'payable' and not currency_obj.is_zero(cr, uid, expense.company_id.currency_id, aml.amount_residual):
 474                             new_status_is_paid = False
 475                     if new_status_is_paid:
 476                         expense_obj.write(cr, uid, [expense.id], {'state': 'paid'}, context=context)
 477         return res
 478
 479 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: