We need to be able to change an expense report before submitting it, for this we add a new step in the expense process (a draft state for the expense sheets). Task #41700 Closes #24806
726 lines
38 KiB
Python
726 lines
38 KiB
Python
# -*- coding: utf-8 -*-
|
|
# Part of Odoo. See LICENSE file for full copyright and licensing details.
|
|
|
|
import re
|
|
|
|
from odoo import api, fields, models, _
|
|
from odoo.exceptions import UserError, ValidationError
|
|
from odoo.tools import email_split, float_is_zero
|
|
|
|
from odoo.addons import decimal_precision as dp
|
|
|
|
|
|
class HrExpense(models.Model):
|
|
|
|
_name = "hr.expense"
|
|
_inherit = ['mail.thread', 'mail.activity.mixin']
|
|
_description = "Expense"
|
|
_order = "date desc, id desc"
|
|
|
|
@api.model
|
|
def _default_employee_id(self):
|
|
return self.env['hr.employee'].search([('user_id', '=', self.env.uid)], limit=1)
|
|
|
|
@api.model
|
|
def _default_product_uom_id(self):
|
|
return self.env['uom.uom'].search([], limit=1, order='id')
|
|
|
|
@api.model
|
|
def _default_account_id(self):
|
|
return self.env['ir.property'].get('property_account_expense_categ_id', 'product.category')
|
|
|
|
@api.model
|
|
def _get_employee_id_domain(self):
|
|
res = [(1, '=', 0)]
|
|
|
|
if self.user_has_groups('hr_expense.group_hr_expense_manager') or self.user_has_groups('account.group_account_user'):
|
|
res = [(1, '=', 1)]
|
|
elif self.user_has_groups('hr_expense.group_hr_expense_user') and self.env.user.employee_ids:
|
|
employee = self.env.user.employee_ids[0]
|
|
res = ['|', '|', ('department_id.manager_id.id', '=', employee.id),
|
|
('parent_id.id', '=', employee.id), ('expense_manager_id.id', '=', employee.id)]
|
|
elif self.env.user.employee_ids:
|
|
employee = self.env.user.employee_ids[0]
|
|
res = [('id', '=', employee.id)]
|
|
|
|
return res
|
|
|
|
name = fields.Char('Description', readonly=True, required=True, states={'draft': [('readonly', False)], 'reported': [('readonly', False)], 'refused': [('readonly', False)]})
|
|
date = fields.Date(readonly=True, states={'draft': [('readonly', False)], 'reported': [('readonly', False)], 'refused': [('readonly', False)]}, default=fields.Date.context_today, string="Date")
|
|
employee_id = fields.Many2one('hr.employee', string="Employee", required=True, readonly=True, states={'draft': [('readonly', False)], 'reported': [('readonly', False)], 'refused': [('readonly', False)]}, default=_default_employee_id, domain=lambda self: self._get_employee_id_domain)
|
|
product_id = fields.Many2one('product.product', string='Product', readonly=True, states={'draft': [('readonly', False)], 'reported': [('readonly', False)], 'refused': [('readonly', False)]}, domain=[('can_be_expensed', '=', True)], required=True)
|
|
product_uom_id = fields.Many2one('uom.uom', string='Unit of Measure', required=True, readonly=True, states={'draft': [('readonly', False)], 'refused': [('readonly', False)]}, default=_default_product_uom_id)
|
|
unit_amount = fields.Float("Unit Price", readonly=True, required=True, states={'draft': [('readonly', False)], 'reported': [('readonly', False)], 'refused': [('readonly', False)]}, digits=dp.get_precision('Product Price'))
|
|
quantity = fields.Float(required=True, readonly=True, states={'draft': [('readonly', False)], 'reported': [('readonly', False)], 'refused': [('readonly', False)]}, digits=dp.get_precision('Product Unit of Measure'), default=1)
|
|
tax_ids = fields.Many2many('account.tax', 'expense_tax', 'expense_id', 'tax_id', string='Taxes', states={'done': [('readonly', True)], 'post': [('readonly', True)]})
|
|
untaxed_amount = fields.Float("Subtotal", store=True, compute='_compute_amount', digits=dp.get_precision('Account'))
|
|
total_amount = fields.Monetary("Total", compute='_compute_amount', store=True, currency_field='currency_id', digits=dp.get_precision('Account'))
|
|
total_amount_company = fields.Monetary("Total (Company Currency)", compute='_compute_total_amount_company', store=True, currency_field='company_currency_id', digits=dp.get_precision('Account'))
|
|
company_id = fields.Many2one('res.company', string='Company', readonly=True, states={'draft': [('readonly', False)], 'refused': [('readonly', False)]}, default=lambda self: self.env.user.company_id)
|
|
currency_id = fields.Many2one('res.currency', string='Currency', readonly=True, states={'draft': [('readonly', False)], 'refused': [('readonly', False)]}, default=lambda self: self.env.user.company_id.currency_id)
|
|
company_currency_id = fields.Many2one('res.currency', string="Report Company Currency", related='sheet_id.currency_id', store=True)
|
|
analytic_account_id = fields.Many2one('account.analytic.account', string='Analytic Account', states={'post': [('readonly', True)], 'done': [('readonly', True)]}, oldname='analytic_account')
|
|
analytic_tag_ids = fields.Many2many('account.analytic.tag', string='Analytic Tags', states={'post': [('readonly', True)], 'done': [('readonly', True)]})
|
|
account_id = fields.Many2one('account.account', string='Account', states={'post': [('readonly', True)], 'done': [('readonly', True)]}, default=_default_account_id, help="An expense account is expected")
|
|
description = fields.Text('Notes...', readonly=True, states={'draft': [('readonly', False)], 'reported': [('readonly', False)], 'refused': [('readonly', False)]})
|
|
payment_mode = fields.Selection([
|
|
("own_account", "Employee (to reimburse)"),
|
|
("company_account", "Company")
|
|
], default='own_account', states={'done': [('readonly', True)], 'post': [('readonly', True)], 'submitted': [('readonly', True)]}, string="Paid By")
|
|
attachment_number = fields.Integer('Number of Attachments', compute='_compute_attachment_number')
|
|
state = fields.Selection([
|
|
('draft', 'To Submit'),
|
|
('reported', 'Submitted'),
|
|
('approved', 'Approved'),
|
|
('done', 'Paid'),
|
|
('refused', 'Refused')
|
|
], compute='_compute_state', string='Status', copy=False, index=True, readonly=True, store=True, help="Status of the expense.")
|
|
sheet_id = fields.Many2one('hr.expense.sheet', string="Expense Report", readonly=True, copy=False)
|
|
reference = fields.Char("Bill Reference")
|
|
is_refused = fields.Boolean("Explicitely Refused by manager or acccountant", readonly=True, copy=False)
|
|
|
|
@api.depends('sheet_id', 'sheet_id.account_move_id', 'sheet_id.state')
|
|
def _compute_state(self):
|
|
for expense in self:
|
|
if not expense.sheet_id or expense.sheet_id.state == 'draft':
|
|
expense.state = "draft"
|
|
elif expense.sheet_id.state == "cancel":
|
|
expense.state = "refused"
|
|
elif expense.sheet_id.state == "approve" or expense.sheet_id.state == "post":
|
|
expense.state = "approved"
|
|
elif not expense.sheet_id.account_move_id:
|
|
expense.state = "reported"
|
|
else:
|
|
expense.state = "done"
|
|
|
|
@api.depends('quantity', 'unit_amount', 'tax_ids', 'currency_id')
|
|
def _compute_amount(self):
|
|
for expense in self:
|
|
expense.untaxed_amount = expense.unit_amount * expense.quantity
|
|
taxes = expense.tax_ids.compute_all(expense.unit_amount, expense.currency_id, expense.quantity, expense.product_id, expense.employee_id.user_id.partner_id)
|
|
expense.total_amount = taxes.get('total_included')
|
|
|
|
@api.depends('date', 'total_amount', 'company_currency_id')
|
|
def _compute_total_amount_company(self):
|
|
for expense in self:
|
|
amount = 0
|
|
if expense.company_currency_id:
|
|
date_expense = expense.date
|
|
amount = expense.currency_id._convert(
|
|
expense.total_amount, expense.company_currency_id,
|
|
expense.company_id, date_expense or fields.Date.today())
|
|
expense.total_amount_company = amount
|
|
|
|
@api.multi
|
|
def _compute_attachment_number(self):
|
|
attachment_data = self.env['ir.attachment'].read_group([('res_model', '=', 'hr.expense'), ('res_id', 'in', self.ids)], ['res_id'], ['res_id'])
|
|
attachment = dict((data['res_id'], data['res_id_count']) for data in attachment_data)
|
|
for expense in self:
|
|
expense.attachment_number = attachment.get(expense.id, 0)
|
|
|
|
@api.onchange('product_id')
|
|
def _onchange_product_id(self):
|
|
if self.product_id:
|
|
if not self.name:
|
|
self.name = self.product_id.display_name or ''
|
|
self.unit_amount = self.product_id.price_compute('standard_price')[self.product_id.id]
|
|
self.product_uom_id = self.product_id.uom_id
|
|
self.tax_ids = self.product_id.supplier_taxes_id
|
|
account = self.product_id.product_tmpl_id._get_product_accounts()['expense']
|
|
if account:
|
|
self.account_id = account
|
|
|
|
@api.onchange('product_uom_id')
|
|
def _onchange_product_uom_id(self):
|
|
if self.product_id and self.product_uom_id.category_id != self.product_id.uom_id.category_id:
|
|
raise UserError(_('Selected Unit of Measure does not belong to the same category as the product Unit of Measure.'))
|
|
|
|
# ----------------------------------------
|
|
# ORM Overrides
|
|
# ----------------------------------------
|
|
|
|
@api.multi
|
|
def unlink(self):
|
|
for expense in self:
|
|
if expense.state in ['done', 'approved']:
|
|
raise UserError(_('You cannot delete a posted or approved expense.'))
|
|
return super(HrExpense, self).unlink()
|
|
|
|
@api.model
|
|
def get_empty_list_help(self, help_message):
|
|
if help_message:
|
|
use_mailgateway = self.env['ir.config_parameter'].sudo().get_param('hr_expense.use_mailgateway')
|
|
alias_record = use_mailgateway and self.env.ref('hr_expense.mail_alias_expense') or False
|
|
if alias_record and alias_record.alias_domain and alias_record.alias_name:
|
|
link = "<a id='o_mail_test' href='mailto:%(email)s?subject=Lunch%%20with%%20customer%%3A%%20%%2412.32'>%(email)s</a>" % {
|
|
'email': '%s@%s' % (alias_record.alias_name, alias_record.alias_domain)
|
|
}
|
|
return '<p class="oe_view_nocontent_smiling_face">%s</p><p>%s</p>' % (
|
|
_('Add a new expense,'),
|
|
_('or send receipts by email to %s.') % (link),)
|
|
return super(HrExpense, self).get_empty_list_help(help_message)
|
|
|
|
# ----------------------------------------
|
|
# Actions
|
|
# ----------------------------------------
|
|
|
|
@api.multi
|
|
def action_view_sheet(self):
|
|
self.ensure_one()
|
|
return {
|
|
'type': 'ir.actions.act_window',
|
|
'view_mode': 'form',
|
|
'res_model': 'hr.expense.sheet',
|
|
'target': 'current',
|
|
'res_id': self.sheet_id.id
|
|
}
|
|
|
|
@api.multi
|
|
def action_submit_expenses(self):
|
|
if any(expense.state != 'draft' or expense.sheet_id for expense in self):
|
|
raise UserError(_("You cannot report twice the same line!"))
|
|
if len(self.mapped('employee_id')) != 1:
|
|
raise UserError(_("You cannot report expenses for different employees in the same report."))
|
|
return {
|
|
'name': _('New Expense Report'),
|
|
'type': 'ir.actions.act_window',
|
|
'view_mode': 'form',
|
|
'res_model': 'hr.expense.sheet',
|
|
'target': 'current',
|
|
'context': {
|
|
'default_expense_line_ids': [line.id for line in self],
|
|
'default_employee_id': self[0].employee_id.id,
|
|
'default_name': self[0].name if len(self.ids) == 1 else ''
|
|
}
|
|
}
|
|
|
|
@api.multi
|
|
def action_get_attachment_view(self):
|
|
self.ensure_one()
|
|
res = self.env['ir.actions.act_window'].for_xml_id('base', 'action_attachment')
|
|
res['domain'] = [('res_model', '=', 'hr.expense'), ('res_id', 'in', self.ids)]
|
|
res['context'] = {'default_res_model': 'hr.expense', 'default_res_id': self.id}
|
|
return res
|
|
|
|
# ----------------------------------------
|
|
# Business
|
|
# ----------------------------------------
|
|
|
|
@api.multi
|
|
def _get_account_move_by_sheet(self):
|
|
""" Return a mapping between the expense sheet of current expense and its account move
|
|
:returns dict where key is a sheet id, and value is an account move record
|
|
"""
|
|
move_grouped_by_sheet = {}
|
|
for expense in self:
|
|
# create the move that will contain the accounting entries
|
|
account_date = expense.sheet_id.accounting_date or expense.date
|
|
if expense.sheet_id.id not in move_grouped_by_sheet:
|
|
journal = expense.sheet_id.bank_journal_id if expense.payment_mode == 'company_account' else expense.sheet_id.journal_id
|
|
move = self.env['account.move'].create({
|
|
'journal_id': journal.id,
|
|
'company_id': self.env.user.company_id.id,
|
|
'date': account_date,
|
|
'ref': expense.sheet_id.name,
|
|
# force the name to the default value, to avoid an eventual 'default_name' in the context
|
|
# to set it to '' which cause no number to be given to the account.move when posted.
|
|
'name': '/',
|
|
})
|
|
move_grouped_by_sheet[expense.sheet_id.id] = move
|
|
else:
|
|
move = move_grouped_by_sheet[expense.sheet_id.id]
|
|
return move_grouped_by_sheet
|
|
|
|
@api.multi
|
|
def _get_expense_account_source(self):
|
|
self.ensure_one()
|
|
if self.account_id:
|
|
account = self.account_id
|
|
elif self.product_id:
|
|
account = self.product_id.product_tmpl_id._get_product_accounts()['expense']
|
|
if not account:
|
|
raise UserError(
|
|
_("No Expense account found for the product %s (or for its category), please configure one.") % (self.product_id.name))
|
|
else:
|
|
account = self.env['ir.property'].with_context(force_company=self.company_id.id).get('property_account_expense_categ_id', 'product.category')
|
|
if not account:
|
|
raise UserError(_('Please configure Default Expense account for Product expense: `property_account_expense_categ_id`.'))
|
|
return account
|
|
|
|
@api.multi
|
|
def _get_expense_account_destination(self):
|
|
self.ensure_one()
|
|
account_dest = self.env['account.account']
|
|
if self.payment_mode == 'company_account':
|
|
if not self.sheet_id.bank_journal_id.default_credit_account_id:
|
|
raise UserError(_("No credit account found for the %s journal, please configure one.") % (self.sheet_id.bank_journal_id.name))
|
|
account_dest = self.sheet_id.bank_journal_id.default_credit_account_id.id
|
|
else:
|
|
if not self.employee_id.address_home_id:
|
|
raise UserError(_("No Home Address found for the employee %s, please configure one.") % (self.employee_id.name))
|
|
account_dest = self.employee_id.address_home_id.property_account_payable_id.id
|
|
return account_dest
|
|
|
|
@api.multi
|
|
def _get_account_move_line_values(self):
|
|
move_line_values_by_expense = {}
|
|
for expense in self:
|
|
move_line_name = expense.employee_id.name + ': ' + expense.name.split('\n')[0][:64]
|
|
account_src = expense._get_expense_account_source()
|
|
account_dst = expense._get_expense_account_destination()
|
|
account_date = expense.sheet_id.accounting_date or expense.date or fields.Date.context_today(expense)
|
|
|
|
company_currency = expense.company_id.currency_id
|
|
different_currency = expense.currency_id != company_currency
|
|
|
|
move_line_values = []
|
|
taxes = expense.tax_ids.with_context(round=True).compute_all(expense.unit_amount, expense.currency_id, expense.quantity, expense.product_id)
|
|
total_amount = 0.0
|
|
total_amount_currency = 0.0
|
|
partner_id = expense.employee_id.address_home_id.commercial_partner_id.id
|
|
|
|
# source move line
|
|
amount_currency = expense.total_amount if different_currency else False
|
|
move_line_src = {
|
|
'name': move_line_name,
|
|
'quantity': expense.quantity or 1,
|
|
'debit': taxes['total_excluded'] > 0 and taxes['total_excluded'],
|
|
'credit': taxes['total_excluded'] < 0 and -taxes['total_excluded'],
|
|
'amount_currency': taxes['total_excluded'] > 0 and abs(amount_currency) or -abs(amount_currency),
|
|
'account_id': account_src.id,
|
|
'product_id': expense.product_id.id,
|
|
'product_uom_id': expense.product_uom_id.id,
|
|
'analytic_account_id': expense.analytic_account_id.id,
|
|
'analytic_tag_ids': [(6, 0, expense.analytic_tag_ids.ids)],
|
|
'expense_id': expense.id,
|
|
'partner_id': partner_id,
|
|
'tax_ids': [(6, 0, expense.tax_ids.ids)],
|
|
'currency_id': expense.currency_id.id if different_currency else False,
|
|
}
|
|
move_line_values.append(move_line_src)
|
|
total_amount -= move_line_src['debit']
|
|
total_amount_currency -= move_line_src['amount_currency'] or move_line_src['debit']
|
|
|
|
# taxes move lines
|
|
for tax in taxes['taxes']:
|
|
price = expense.currency_id._convert(
|
|
tax['amount'], company_currency, expense.company_id, account_date)
|
|
amount_currency = price if different_currency else False
|
|
move_line_tax_values = {
|
|
'name': tax['name'],
|
|
'quantity': 1,
|
|
'debit': price > 0 and price,
|
|
'credit': price < 0 and -price,
|
|
'amount_currency': price > 0 and abs(amount_currency) or -abs(amount_currency),
|
|
'account_id': tax['account_id'] or move_line_src['account_id'],
|
|
'tax_line_id': tax['id'],
|
|
'expense_id': expense.id,
|
|
'partner_id': partner_id,
|
|
'currency_id': expense.currency_id if different_currency else False,
|
|
}
|
|
total_amount -= price
|
|
total_amount_currency -= move_line_tax_values['amount_currency'] or price
|
|
move_line_values.append(move_line_tax_values)
|
|
|
|
# destination move line
|
|
move_line_dst = {
|
|
'name': move_line_name,
|
|
'debit': total_amount > 0 and total_amount,
|
|
'credit': total_amount < 0 and -total_amount,
|
|
'account_id': account_dst,
|
|
'date_maturity': account_date,
|
|
'amount_currency': total_amount > 0 and abs(amount_currency) or -abs(amount_currency),
|
|
'currency_id': expense.currency_id.id if different_currency else False,
|
|
'expense_id': expense.id,
|
|
'partner_id': partner_id,
|
|
}
|
|
move_line_values.append(move_line_dst)
|
|
|
|
move_line_values_by_expense[expense.id] = move_line_values
|
|
return move_line_values_by_expense
|
|
|
|
@api.multi
|
|
def action_move_create(self):
|
|
'''
|
|
main function that is called when trying to create the accounting entries related to an expense
|
|
'''
|
|
move_group_by_sheet = self._get_account_move_by_sheet()
|
|
|
|
move_line_values_by_expense = self._get_account_move_line_values()
|
|
|
|
for expense in self:
|
|
company_currency = expense.company_id.currency_id
|
|
different_currency = expense.currency_id != company_currency
|
|
|
|
# get the account move of the related sheet
|
|
move = move_group_by_sheet[expense.sheet_id.id]
|
|
|
|
# get move line values
|
|
move_line_values = move_line_values_by_expense.get(expense.id)
|
|
move_line_dst = move_line_values[-1]
|
|
total_amount = abs(move_line_dst['debit'])
|
|
total_amount_currency = move_line_dst['amount_currency']
|
|
|
|
# create one more move line, a counterline for the total on payable account
|
|
if expense.payment_mode == 'company_account':
|
|
if not expense.sheet_id.bank_journal_id.default_credit_account_id:
|
|
raise UserError(_("No credit account found for the %s journal, please configure one.") % (expense.sheet_id.bank_journal_id.name))
|
|
journal = expense.sheet_id.bank_journal_id
|
|
# create payment
|
|
payment_methods = journal.outbound_payment_method_ids if total_amount < 0 else journal.inbound_payment_method_ids
|
|
journal_currency = journal.currency_id or journal.company_id.currency_id
|
|
payment = self.env['account.payment'].create({
|
|
'payment_method_id': payment_methods and payment_methods[0].id or False,
|
|
'payment_type': 'outbound' if total_amount < 0 else 'inbound',
|
|
'partner_id': expense.employee_id.address_home_id.commercial_partner_id.id,
|
|
'partner_type': 'supplier',
|
|
'journal_id': journal.id,
|
|
'payment_date': expense.date,
|
|
'state': 'reconciled',
|
|
'currency_id': expense.currency_id.id if different_currency else journal_currency.id,
|
|
'amount': abs(total_amount_currency) if different_currency else abs(total_amount),
|
|
'name': expense.name,
|
|
})
|
|
move_line_dst['payment_id'] = payment.id
|
|
|
|
# link move lines to move, and move to expense sheet
|
|
move.with_context(dont_create_taxes=True).write({
|
|
'line_ids': [(0, 0, line) for line in move_line_values]
|
|
})
|
|
expense.sheet_id.write({'account_move_id': move.id})
|
|
|
|
if expense.payment_mode == 'company_account':
|
|
expense.sheet_id.paid_expense_sheets()
|
|
|
|
# post the moves
|
|
for move in move_group_by_sheet.values():
|
|
move.post()
|
|
|
|
return move_group_by_sheet
|
|
|
|
@api.multi
|
|
def refuse_expense(self, reason):
|
|
self.write({'is_refused': True})
|
|
self.sheet_id.write({'state': 'cancel'})
|
|
self.sheet_id.message_post_with_view('hr_expense.hr_expense_template_refuse_reason',
|
|
values={'reason': reason, 'is_sheet': False, 'name': self.name})
|
|
|
|
# ----------------------------------------
|
|
# Mail Thread
|
|
# ----------------------------------------
|
|
|
|
@api.model
|
|
def message_new(self, msg_dict, custom_values=None):
|
|
if custom_values is None:
|
|
custom_values = {}
|
|
|
|
email_address = email_split(msg_dict.get('email_from', False))[0]
|
|
|
|
employee = self.env['hr.employee'].search([
|
|
'|',
|
|
('work_email', 'ilike', email_address),
|
|
('user_id.email', 'ilike', email_address)
|
|
], limit=1)
|
|
|
|
expense_description = msg_dict.get('subject', '')
|
|
|
|
# Match the first occurence of '[]' in the string and extract the content inside it
|
|
# Example: '[foo] bar (baz)' becomes 'foo'. This is potentially the product code
|
|
# of the product to encode on the expense. If not, take the default product instead
|
|
# which is 'Fixed Cost'
|
|
default_product = self.env.ref('hr_expense.product_product_fixed_cost')
|
|
pattern = '\[([^)]*)\]'
|
|
product_code = re.search(pattern, expense_description)
|
|
if product_code is None:
|
|
product = default_product
|
|
else:
|
|
expense_description = expense_description.replace(product_code.group(), '')
|
|
products = self.env['product.product'].search([('default_code', 'ilike', product_code.group(1))]) or default_product
|
|
product = products.filtered(lambda p: p.default_code == product_code.group(1)) or products[0]
|
|
account = product.product_tmpl_id._get_product_accounts()['expense']
|
|
|
|
pattern = '[-+]?(\d+(\.\d*)?|\.\d+)([eE][-+]?\d+)?'
|
|
# Match the last occurence of a float in the string
|
|
# Example: '[foo] 50.3 bar 34.5' becomes '34.5'. This is potentially the price
|
|
# to encode on the expense. If not, take 1.0 instead
|
|
expense_price = re.findall(pattern, expense_description)
|
|
# TODO: International formatting
|
|
if not expense_price:
|
|
price = 1.0
|
|
else:
|
|
price = expense_price[-1][0]
|
|
expense_description = expense_description.replace(price, '')
|
|
try:
|
|
price = float(price)
|
|
except ValueError:
|
|
price = 1.0
|
|
|
|
custom_values.update({
|
|
'name': expense_description.strip(),
|
|
'employee_id': employee.id,
|
|
'product_id': product.id,
|
|
'product_uom_id': product.uom_id.id,
|
|
'quantity': 1,
|
|
'unit_amount': price,
|
|
'company_id': employee.company_id.id,
|
|
})
|
|
if account:
|
|
custom_values['account_id'] = account.id
|
|
return super(HrExpense, self).message_new(msg_dict, custom_values)
|
|
|
|
|
|
class HrExpenseSheet(models.Model):
|
|
"""
|
|
Here are the rights associated with the expense flow
|
|
|
|
Action Group Restriction
|
|
=================================================================================
|
|
Submit Employee Only his own
|
|
Officer If he is expense manager of the employee, manager of the employee
|
|
or the employee is in the department managed by the officer
|
|
Manager Always
|
|
Approve Officer Not his own and he is expense manager of the employee, manager of the employee
|
|
or the employee is in the department managed by the officer
|
|
Manager Always
|
|
Post Anybody State = approve and journal_id defined
|
|
Done Anybody State = approve and journal_id defined
|
|
Cancel Officer Not his own and he is expense manager of the employee, manager of the employee
|
|
or the employee is in the department managed by the officer
|
|
Manager Always
|
|
=================================================================================
|
|
"""
|
|
_name = "hr.expense.sheet"
|
|
_inherit = ['mail.thread', 'mail.activity.mixin']
|
|
_description = "Expense Report"
|
|
_order = "accounting_date desc, id desc"
|
|
|
|
@api.model
|
|
def _default_journal_id(self):
|
|
journal = self.env.ref('hr_expense.hr_expense_account_journal', raise_if_not_found=False)
|
|
if not journal:
|
|
journal = self.env['account.journal'].search([('type', '=', 'purchase')], limit=1)
|
|
return journal.id
|
|
|
|
@api.model
|
|
def _default_bank_journal_id(self):
|
|
return self.env['account.journal'].search([('type', 'in', ['cash', 'bank'])], limit=1)
|
|
|
|
name = fields.Char('Expense Report Summary', required=True)
|
|
expense_line_ids = fields.One2many('hr.expense', 'sheet_id', string='Expense Lines', states={'approve': [('readonly', True)], 'done': [('readonly', True)], 'post': [('readonly', True)]}, copy=False)
|
|
state = fields.Selection([
|
|
('draft', 'Draft'),
|
|
('submit', 'Submitted'),
|
|
('approve', 'Approved'),
|
|
('post', 'Posted'),
|
|
('done', 'Paid'),
|
|
('cancel', 'Refused')
|
|
], string='Status', index=True, readonly=True, track_visibility='onchange', copy=False, default='draft', required=True, help='Expense Report State')
|
|
employee_id = fields.Many2one('hr.employee', string="Employee", required=True, readonly=True, states={'draft': [('readonly', False)]}, default=lambda self: self.env['hr.employee'].search([('user_id', '=', self.env.uid)], limit=1))
|
|
address_id = fields.Many2one('res.partner', string="Employee Home Address")
|
|
payment_mode = fields.Selection([("own_account", "Employee (to reimburse)"), ("company_account", "Company")], related='expense_line_ids.payment_mode', default='own_account', readonly=True, string="Paid By")
|
|
user_id = fields.Many2one('res.users', 'Manager', readonly=True, copy=False, states={'draft': [('readonly', False)]}, track_visibility='onchange', oldname='responsible_id')
|
|
total_amount = fields.Monetary('Total Amount', currency_field='currency_id', compute='_compute_amount', store=True, digits=dp.get_precision('Account'))
|
|
company_id = fields.Many2one('res.company', string='Company', readonly=True, states={'draft': [('readonly', False)]}, default=lambda self: self.env.user.company_id)
|
|
currency_id = fields.Many2one('res.currency', string='Currency', readonly=True, states={'draft': [('readonly', False)]}, default=lambda self: self.env.user.company_id.currency_id)
|
|
attachment_number = fields.Integer(compute='_compute_attachment_number', string='Number of Attachments')
|
|
journal_id = fields.Many2one('account.journal', string='Expense Journal', states={'done': [('readonly', True)], 'post': [('readonly', True)]}, default=_default_journal_id, help="The journal used when the expense is done.")
|
|
bank_journal_id = fields.Many2one('account.journal', string='Bank Journal', states={'done': [('readonly', True)], 'post': [('readonly', True)]}, default=_default_bank_journal_id, help="The payment method used when the expense is paid by the company.")
|
|
accounting_date = fields.Date("Date")
|
|
account_move_id = fields.Many2one('account.move', string='Journal Entry', ondelete='restrict', copy=False)
|
|
department_id = fields.Many2one('hr.department', string='Department', states={'post': [('readonly', True)], 'done': [('readonly', True)]})
|
|
is_multiple_currency = fields.Boolean("Handle lines with different currencies", compute='_compute_is_multiple_currency')
|
|
can_reset = fields.Boolean('Can Reset', compute='_compute_can_reset')
|
|
|
|
@api.depends('expense_line_ids.total_amount_company')
|
|
def _compute_amount(self):
|
|
for sheet in self:
|
|
sheet.total_amount = sum(sheet.expense_line_ids.mapped('total_amount_company'))
|
|
|
|
@api.multi
|
|
def _compute_attachment_number(self):
|
|
for sheet in self:
|
|
sheet.attachment_number = sum(sheet.expense_line_ids.mapped('attachment_number'))
|
|
|
|
@api.depends('expense_line_ids.currency_id')
|
|
def _compute_is_multiple_currency(self):
|
|
for sheet in self:
|
|
sheet.is_multiple_currency = len(sheet.expense_line_ids.mapped('currency_id')) > 1
|
|
|
|
@api.multi
|
|
def _compute_can_reset(self):
|
|
is_expense_user = self.user_has_groups('hr_expense.group_hr_expense_user')
|
|
for sheet in self:
|
|
sheet.can_reset = is_expense_user if is_expense_user else sheet.employee_id.user_id == self.env.user
|
|
|
|
@api.onchange('employee_id')
|
|
def _onchange_employee_id(self):
|
|
self.address_id = self.employee_id.sudo().address_home_id
|
|
self.department_id = self.employee_id.department_id
|
|
self.user_id = self.employee_id.expense_manager_id or self.employee_id.parent_id.user_id
|
|
|
|
@api.multi
|
|
@api.constrains('expense_line_ids')
|
|
def _check_payment_mode(self):
|
|
for sheet in self:
|
|
expense_lines = sheet.mapped('expense_line_ids')
|
|
if expense_lines and any(expense.payment_mode != expense_lines[0].payment_mode for expense in expense_lines):
|
|
raise ValidationError(_("Expenses must be paid by the same entity (Company or employee)."))
|
|
|
|
@api.constrains('expense_line_ids', 'employee_id')
|
|
def _check_employee(self):
|
|
for sheet in self:
|
|
employee_ids = sheet.expense_line_ids.mapped('employee_id')
|
|
if len(employee_ids) > 1 or (len(employee_ids) == 1 and employee_ids != sheet.employee_id):
|
|
raise ValidationError(_('You cannot add expenses of another employee.'))
|
|
|
|
@api.model
|
|
def create(self, vals):
|
|
sheet = super(HrExpenseSheet, self.with_context(mail_create_nosubscribe=True)).create(vals)
|
|
sheet.activity_update()
|
|
return sheet
|
|
|
|
@api.multi
|
|
def unlink(self):
|
|
for expense in self:
|
|
if expense.state in ['post', 'done']:
|
|
raise UserError(_('You cannot delete a posted or paid expense.'))
|
|
super(HrExpenseSheet, self).unlink()
|
|
|
|
# --------------------------------------------
|
|
# Mail Thread
|
|
# --------------------------------------------
|
|
|
|
@api.multi
|
|
def _track_subtype(self, init_values):
|
|
self.ensure_one()
|
|
if 'state' in init_values and self.state == 'approve':
|
|
return 'hr_expense.mt_expense_approved'
|
|
elif 'state' in init_values and self.state == 'cancel':
|
|
return 'hr_expense.mt_expense_refused'
|
|
elif 'state' in init_values and self.state == 'done':
|
|
return 'hr_expense.mt_expense_paid'
|
|
return super(HrExpenseSheet, self)._track_subtype(init_values)
|
|
|
|
def _message_auto_subscribe_followers(self, updated_values, subtype_ids):
|
|
res = super(HrExpenseSheet, self)._message_auto_subscribe_followers(updated_values, subtype_ids)
|
|
if updated_values.get('employee_id'):
|
|
employee = self.env['hr.employee'].browse(updated_values['employee_id'])
|
|
if employee.user_id:
|
|
res.append((employee.user_id.partner_id.id, subtype_ids, False))
|
|
return res
|
|
|
|
# --------------------------------------------
|
|
# Actions
|
|
# --------------------------------------------
|
|
|
|
@api.multi
|
|
def action_sheet_move_create(self):
|
|
if any(sheet.state != 'approve' for sheet in self):
|
|
raise UserError(_("You can only generate accounting entry for approved expense(s)."))
|
|
|
|
if any(not sheet.journal_id for sheet in self):
|
|
raise UserError(_("Expenses must have an expense journal specified to generate accounting entries."))
|
|
|
|
expense_line_ids = self.mapped('expense_line_ids')\
|
|
.filtered(lambda r: not float_is_zero(r.total_amount, precision_rounding=(r.currency_id or self.env.user.company_id.currency_id).rounding))
|
|
res = expense_line_ids.action_move_create()
|
|
|
|
if not self.accounting_date:
|
|
self.accounting_date = self.account_move_id.date
|
|
|
|
if self.payment_mode == 'own_account' and expense_line_ids:
|
|
self.write({'state': 'post'})
|
|
else:
|
|
self.write({'state': 'done'})
|
|
self.activity_update()
|
|
return res
|
|
|
|
@api.multi
|
|
def action_get_attachment_view(self):
|
|
res = self.env['ir.actions.act_window'].for_xml_id('base', 'action_attachment')
|
|
res['domain'] = [('res_model', '=', 'hr.expense'), ('res_id', 'in', self.expense_line_ids.ids)]
|
|
res['context'] = {
|
|
'default_res_model': 'hr.expense.sheet',
|
|
'default_res_id': self.id,
|
|
'create': False,
|
|
'edit': False,
|
|
}
|
|
return res
|
|
|
|
# --------------------------------------------
|
|
# Business
|
|
# --------------------------------------------
|
|
|
|
@api.multi
|
|
def set_to_paid(self):
|
|
self.write({'state': 'done'})
|
|
|
|
@api.multi
|
|
def action_submit_sheet(self):
|
|
self.write({'state': 'submit'})
|
|
|
|
@api.multi
|
|
def approve_expense_sheets(self):
|
|
if not self.user_has_groups('hr_expense.group_hr_expense_user'):
|
|
raise UserError(_("Only Managers and HR Officers can approve expenses"))
|
|
elif not self.user_has_groups('hr_expense.group_hr_expense_manager'):
|
|
current_managers = self.employee_id.parent_id.user_id | self.employee_id.department_id.manager_id.user_id
|
|
|
|
if self.employee_id.user_id == self.env.user:
|
|
raise UserError(_("You cannot approve your own expenses"))
|
|
|
|
if not self.env.user in current_managers:
|
|
raise UserError(_("You can only approve your department expenses"))
|
|
|
|
responsible_id = self.user_id.id or self.env.user.id
|
|
self.write({'state': 'approve', 'user_id': responsible_id})
|
|
self.activity_update()
|
|
|
|
@api.multi
|
|
def paid_expense_sheets(self):
|
|
self.write({'state': 'done'})
|
|
|
|
@api.multi
|
|
def refuse_sheet(self, reason):
|
|
if not self.user_has_groups('hr_expense.group_hr_expense_user'):
|
|
raise UserError(_("Only Managers and HR Officers can approve expenses"))
|
|
elif not self.user_has_groups('hr_expense.group_hr_expense_manager'):
|
|
current_managers = self.employee_id.parent_id.user_id | self.employee_id.department_id.manager_id.user_id
|
|
|
|
if self.employee_id.user_id == self.env.user:
|
|
raise UserError(_("You cannot refuse your own expenses"))
|
|
|
|
if not self.env.user in current_managers:
|
|
raise UserError(_("You can only refuse your department expenses"))
|
|
|
|
self.write({'state': 'cancel'})
|
|
for sheet in self:
|
|
sheet.message_post_with_view('hr_expense.hr_expense_template_refuse_reason', values={'reason': reason, 'is_sheet': True, 'name': self.name})
|
|
self.activity_update()
|
|
|
|
@api.multi
|
|
def reset_expense_sheets(self):
|
|
if not self.can_reset:
|
|
raise UserError(_("Only HR Officers or the concerned employee can reset to draft."))
|
|
self.mapped('expense_line_ids').write({'is_refused': False})
|
|
self.write({'state': 'draft'})
|
|
self.activity_update()
|
|
return True
|
|
|
|
def _get_responsible_for_approval(self):
|
|
if self.user_id:
|
|
return self.user_id
|
|
elif self.employee_id.parent_id.user_id:
|
|
return self.employee_id.parent_id.user_id
|
|
elif self.employee_id.department_id.manager_id.user_id:
|
|
return self.employee_id.department_id.manager_id.user_id
|
|
return self.env.user
|
|
|
|
def activity_update(self):
|
|
for expense_report in self.filtered(lambda hol: hol.state == 'submit'):
|
|
self.activity_schedule(
|
|
'hr_expense.mail_act_expense_approval', fields.Date.today(),
|
|
user_id=expense_report._get_responsible_for_approval().id)
|
|
self.filtered(lambda hol: hol.state == 'approve').activity_feedback(['hr_expense.mail_act_expense_approval'])
|
|
self.filtered(lambda hol: hol.state == 'cancel').activity_unlink(['hr_expense.mail_act_expense_approval'])
|