diff --git a/account_banking_mandate/__init__.py b/account_banking_mandate/__init__.py new file mode 100644 index 000000000..2af74b3d2 --- /dev/null +++ b/account_banking_mandate/__init__.py @@ -0,0 +1,22 @@ +# -*- encoding: utf-8 -*- +############################################################################## +# +# Mandate module for openERP +# Copyright (C) 2014 Compassion CH (http://www.compassion.ch) +# @author: Cyril Sester +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +# +############################################################################## +from . import models diff --git a/account_banking_mandate/__openerp__.py b/account_banking_mandate/__openerp__.py new file mode 100644 index 000000000..a0ce99274 --- /dev/null +++ b/account_banking_mandate/__openerp__.py @@ -0,0 +1,57 @@ +# -*- encoding: utf-8 -*- +############################################################################## +# +# Mandate module for openERP +# Copyright (C) 2014 Compassion CH (http://www.compassion.ch) +# @author: Cyril Sester , +# Alexis de Lattre +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +# +############################################################################## +{ + 'name': 'Account Banking Mandate', + 'summary': 'Banking mandates', + 'version': '0.1', + 'license': 'AGPL-3', + 'author': 'Compassion CH', + 'website': 'http://www.compassion.ch', + 'contributors': ['Pedro M. Baeza '], + 'category': 'Banking addons', + 'depends': [ + 'account_payment', + ], + 'data': [ + 'views/account_banking_mandate_view.xml', + 'views/account_invoice_view.xml', + 'views/account_payment_view.xml', + 'views/res_partner_bank_view.xml', + 'data/mandate_reference_sequence.xml', + 'security/ir.model.access.csv', + ], + 'demo': [], + 'test': ['test/banking_mandate.yml'], + 'description': ''' + This module adds a generic model for banking mandates. + These mandates can be specialized to fit any banking mandates (such as + sepa or lsv). + + A banking mandate is attached to a bank account and represents an + authorization that the bank account owner gives to a company for a + specific operation (such as direct debit). + You can setup mandates from the accounting menu or directly from a bank + account. + ''', + 'installable': True, +} diff --git a/account_banking_mandate/data/mandate_reference_sequence.xml b/account_banking_mandate/data/mandate_reference_sequence.xml new file mode 100644 index 000000000..9a51db944 --- /dev/null +++ b/account_banking_mandate/data/mandate_reference_sequence.xml @@ -0,0 +1,20 @@ + + + + + + + DD Mandate Reference + account.banking.mandate + + + + DD Mandate Reference + account.banking.mandate + BM + + + + + + diff --git a/account_banking_mandate/models/__init__.py b/account_banking_mandate/models/__init__.py new file mode 100644 index 000000000..52a6f4616 --- /dev/null +++ b/account_banking_mandate/models/__init__.py @@ -0,0 +1,26 @@ +# -*- encoding: utf-8 -*- +############################################################################## +# +# Mandate module for openERP +# Copyright (C) 2014 Compassion CH (http://www.compassion.ch) +# @author: Cyril Sester , +# Alexis de Lattre +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +# +############################################################################## +from . import account_banking_mandate +from . import account_invoice +from . import res_partner_bank +from . import payment_line diff --git a/account_banking_mandate/models/account_banking_mandate.py b/account_banking_mandate/models/account_banking_mandate.py new file mode 100644 index 000000000..40d17601a --- /dev/null +++ b/account_banking_mandate/models/account_banking_mandate.py @@ -0,0 +1,154 @@ +# -*- encoding: utf-8 -*- +############################################################################## +# +# Mandate module for openERP +# Copyright (C) 2014 Compassion CH (http://www.compassion.ch) +# @author: Cyril Sester , +# Alexis de Lattre +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +# +############################################################################## + +from openerp import models, fields, exceptions, api, _ + + +class AccountBankingMandate(models.Model): + ''' The banking mandate is attached to a bank account and represents an + authorization that the bank account owner gives to a company for a + specific operation (such as direct debit) + ''' + _name = 'account.banking.mandate' + _description = "A generic banking mandate" + _rec_name = 'unique_mandate_reference' + _inherit = ['mail.thread'] + _order = 'signature_date desc' + _track = { + 'state': { + 'account_banking_mandate.mandate_valid': ( + lambda self, cr, uid, obj, ctx=None: obj['state'] == 'valid'), + 'account_banking_mandate.mandate_expired': ( + lambda self, cr, uid, obj, ctx=None: + obj['state'] == 'expired'), + 'account_banking_mandate.mandate_cancel': ( + lambda self, cr, uid, obj, ctx=None: obj['state'] == 'cancel'), + }, + } + + def _get_states(self): + return [('draft', 'Draft'), + ('valid', 'Valid'), + ('expired', 'Expired'), + ('cancel', 'Cancelled')] + + partner_bank_id = fields.Many2one( + comodel_name='res.partner.bank', string='Bank Account', + track_visibility='onchange') + partner_id = fields.Many2one( + comodel_name='res.partner', relation='partner_bank_id.partner_id', + string='Partner', readonly=True, store=True) + company_id = fields.Many2one( + comodel_name='res.company', string='Company', required=True, + default=lambda self: self.env['res.company']._company_default_get( + 'account.banking.mandate')) + unique_mandate_reference = fields.Char( + string='Unique Mandate Reference', track_visibility='always', + default='/') + signature_date = fields.Date(string='Date of Signature of the Mandate', + track_visibility='onchange') + scan = fields.Binary(string='Scan of the Mandate') + last_debit_date = fields.Date(string='Date of the Last Debit', + readonly=True) + state = fields.Selection( + _get_states, string='Status', default='draft', + help="Only valid mandates can be used in a payment line. A cancelled " + "mandate is a mandate that has been cancelled by the customer.") + payment_line_ids = fields.One2many( + comodel_name='payment.line', inverse_name='mandate_id', + string="Related Payment Lines") + + _sql_constraints = [( + 'mandate_ref_company_uniq', + 'unique(unique_mandate_reference, company_id)', + 'A Mandate with the same reference already exists for this company !')] + + @api.one + @api.constrains('signature_date', 'last_debit_date') + def _check_dates(self): + if (self.signature_date and + self.signature_date > fields.Date.context_today(self)): + raise exceptions.Warning( + _("The date of signature of mandate '%s' is in the future !") + % self.unique_mandate_reference) + if (self.signature_date and self.last_debit_date and + self.signature_date > self.last_debit_date): + raise exceptions.Warning( + _("The mandate '%s' can't have a date of last debit before " + "the date of signature.") % self.unique_mandate_reference) + + @api.one + @api.constrains('state', 'partner_bank_id') + def _check_valid_state(self): + if self.state == 'valid': + if not self.signature_date: + raise exceptions.Warning( + _("Cannot validate the mandate '%s' without a date of " + "signature.") % self.unique_mandate_reference) + if not self.partner_bank_id: + raise exceptions.Warning( + _("Cannot validate the mandate '%s' because it is not " + "attached to a bank account.") % + self.unique_mandate_reference) + + @api.model + def create(self, vals=None): + if vals.get('unique_mandate_reference', '/') == '/': + vals['unique_mandate_reference'] = \ + self.env['ir.sequence'].next_by_code('account.banking.mandate') + return super(AccountBankingMandate, self).create(vals) + + @api.one + @api.onchange('partner_bank_id') + def mandate_partner_bank_change(self): + self.partner_id = self.partner_bank_id.partner_id + + @api.multi + def validate(self): + for mandate in self: + if mandate.state != 'draft': + raise exceptions.Warning( + _('Mandate should be in draft state')) + self.write({'state': 'valid'}) + return True + + @api.multi + def cancel(self): + for mandate in self: + if mandate.state not in ('draft', 'valid'): + raise exceptions.Warning( + _('Mandate should be in draft or valid state')) + self.write({'state': 'cancel'}) + return True + + @api.multi + def back2draft(self): + """Allows to set the mandate back to the draft state. + This is for mandates cancelled by mistake. + """ + for mandate in self: + if mandate.state != 'cancel': + raise exceptions.Warning( + _('Mandate should be in cancel state')) + self.write({'state': 'draft'}) + return True diff --git a/account_banking_mandate/models/account_invoice.py b/account_banking_mandate/models/account_invoice.py new file mode 100644 index 000000000..e040c426f --- /dev/null +++ b/account_banking_mandate/models/account_invoice.py @@ -0,0 +1,33 @@ +# -*- encoding: utf-8 -*- +############################################################################## +# +# Mandate module for openERP +# Copyright (C) 2014 Compassion CH (http://www.compassion.ch) +# @author: Cyril Sester , +# Alexis de Lattre +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +# +############################################################################## + +from openerp import models, fields + + +class AccountInvoice(models.Model): + _inherit = 'account.invoice' + + mandate_id = fields.Many2one( + 'account.banking.mandate', string='Direct Debit Mandate', + domain=[('state', '=', 'valid')], readonly=True, + states={'draft': [('readonly', False)]}) diff --git a/account_banking_mandate/models/payment_line.py b/account_banking_mandate/models/payment_line.py new file mode 100644 index 000000000..4db3685b7 --- /dev/null +++ b/account_banking_mandate/models/payment_line.py @@ -0,0 +1,76 @@ +# -*- encoding: utf-8 -*- +############################################################################## +# +# Mandate module for openERP +# Copyright (C) 2014 Compassion CH (http://www.compassion.ch) +# @author: Cyril Sester , +# Alexis de Lattre +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +# +############################################################################## + +from openerp import models, fields, api, exceptions, _ + + +class PaymentLine(models.Model): + _inherit = 'payment.line' + + mandate_id = fields.Many2one( + comodel_name='account.banking.mandate', string='Direct Debit Mandate', + domain=[('state', '=', 'valid')]) + + @api.multi + def create(self, vals=None): + """If the customer invoice has a mandate, take it + otherwise, take the first valid mandate of the bank account + """ + if vals is None: + vals = {} + partner_bank_id = vals.get('bank_id') + move_line_id = vals.get('move_line_id') + if (self.env.context.get('search_payment_order_type') == 'debit' + and 'mandate_id' not in vals): + if move_line_id: + line = self.env['account.move.line'].browse(move_line_id) + if (line.invoice and line.invoice.type == 'out_invoice' + and line.invoice.mandate_id): + vals.update({ + 'mandate_id': line.invoice.mandate_id.id, + 'bank_id': line.invoice.mandate_id.partner_bank_id.id, + }) + if partner_bank_id and 'mandate_id' not in vals: + mandates = self.env['account.banking.mandate'].search( + [('partner_bank_id', '=', partner_bank_id), + ('state', '=', 'valid')]) + if mandates: + vals['mandate_id'] = mandates.id + return super(PaymentLine, self).create(vals) + + @api.one + @api.constrains('mandate_id', 'bank_id') + def _check_mandate_bank_link(self, cr, uid, ids): + if (self.mandate_id and self.bank_id + and self.mandate_id.partner_bank_id.id != + self.bank_id.id): + raise exceptions.Warning( + _("The payment line with reference '%s' has the bank account " + "'%s' which is not attached to the mandate '%s' (this " + "mandate is attached to the bank account '%s').") % + (self.name, + self.env['res.partner.bank'].name_get( + [self.bank_id.id])[0][1], + self.mandate_id.unique_mandate_reference, + self.env['res.partner.bank'].name_get( + [self.mandate_id.partner_bank_id.id])[0][1])) diff --git a/account_banking_mandate/models/res_partner_bank.py b/account_banking_mandate/models/res_partner_bank.py new file mode 100644 index 000000000..d3d40e481 --- /dev/null +++ b/account_banking_mandate/models/res_partner_bank.py @@ -0,0 +1,34 @@ +# -*- encoding: utf-8 -*- +############################################################################## +# +# Mandate module for openERP +# Copyright (C) 2014 Compassion CH (http://www.compassion.ch) +# @author: Cyril Sester , +# Alexis de Lattre +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +# +############################################################################## + +from openerp import models, fields + + +class ResPartnerBank(models.Model): + _inherit = 'res.partner.bank' + + mandate_ids = fields.One2many( + comodel_name='account.banking.mandate', inverse_name='partner_bank_id', + string='Direct Debit Mandates', + help='Banking mandates represents an authorization that the bank ' + 'account owner gives to a company for a specific operation') diff --git a/account_banking_mandate/security/ir.model.access.csv b/account_banking_mandate/security/ir.model.access.csv new file mode 100644 index 000000000..07f07a3da --- /dev/null +++ b/account_banking_mandate/security/ir.model.access.csv @@ -0,0 +1,3 @@ +"id","name","model_id:id","group_id:id","perm_read","perm_write","perm_create","perm_unlink" +"access_account_banking_mandate","Full access on account.banking.mandate","model_account_banking_mandate","account_payment.group_account_payment",1,1,1,1 +"access_account_banking_mandate_read","Read access on account.banking.mandate","model_account_banking_mandate","base.group_user",1,0,0,0 \ No newline at end of file diff --git a/account_banking_mandate/test/banking_mandate.yml b/account_banking_mandate/test/banking_mandate.yml new file mode 100644 index 000000000..b1f33f51c --- /dev/null +++ b/account_banking_mandate/test/banking_mandate.yml @@ -0,0 +1,36 @@ +- + In order to test mandate, I create a partner with a bank account. + Then, I create a mandate, validate it, cancel it and the set it back to draft + + I create a partner +- + !record {model: res.partner, id: mandate_partner, view: False}: + name: "Mandate test" +- + I create a partner bank account +- + !record {model: res.partner.bank, id: mandate_partner_bank, view: False}: + state: 'bank' + acc_number: '1234' + partner_id: mandate_partner +- + I create a mandate on 1st January +- + !record {model: account.banking.mandate, id: test_mandate, view: False}: + partner_bank_id: mandate_partner_bank + signature_date: "2014-01-01" + +- + I check that the state field is automatically set by default +- + !assert {model: account.banking.mandate, id: test_mandate}: + - state == 'draft' +- + I go through all states by clicking on buttons and check that cancel state is reached +- + !python {model: account.banking.mandate}: | + self.validate(cr, uid, [ref('test_mandate')]) + self.cancel(cr, uid, [ref('test_mandate')]) + mandate = self.browse(cr, uid, ref('test_mandate')) + assert mandate.state == 'cancel', 'Mandate is not in cancel state' + self.back2draft(cr, uid, [ref('test_mandate')]) diff --git a/account_banking_mandate/views/account_banking_mandate_view.xml b/account_banking_mandate/views/account_banking_mandate_view.xml new file mode 100644 index 000000000..d5edc6c17 --- /dev/null +++ b/account_banking_mandate/views/account_banking_mandate_view.xml @@ -0,0 +1,122 @@ + + + + + + view.mandate.form + account.banking.mandate + +
+
+
+ +
+

+ +

+
+ + + + + + + + + + + + +
+ + +
+
+ + + + + view.mandate.tree + account.banking.mandate + + + + + + + + + + + + + + view.mandate.search + account.banking.mandate + + + + + + + + + + + + + Banking Mandates + account.banking.mandate + form + tree,form + +

+ Click to create a new Banking Mandate. +

+ A Banking Mandate is a document signed by your customer that gives you the autorization to do one or several operations on his bank account. +

+ + + + + + + + Mandate Validated + account.banking.mandate + + Banking Mandate Validated + + + + Mandate Expired + account.banking.mandate + + Banking Mandate has Expired + + + + Mandate Cancelled + account.banking.mandate + + Banking Mandate Cancelled + + + diff --git a/account_banking_mandate/views/account_invoice_view.xml b/account_banking_mandate/views/account_invoice_view.xml new file mode 100644 index 000000000..a21e83857 --- /dev/null +++ b/account_banking_mandate/views/account_invoice_view.xml @@ -0,0 +1,22 @@ + + + + + + + add.mandate.on.customer.invoice.form + account.invoice + + + + + + + + + + diff --git a/account_banking_mandate/views/account_payment_view.xml b/account_banking_mandate/views/account_payment_view.xml new file mode 100644 index 000000000..39ec86953 --- /dev/null +++ b/account_banking_mandate/views/account_payment_view.xml @@ -0,0 +1,26 @@ + + + + + + + mandate.payment.order.form + payment.order + + + + + + + + + + + + + + diff --git a/account_banking_mandate/views/res_partner_bank_view.xml b/account_banking_mandate/views/res_partner_bank_view.xml new file mode 100644 index 000000000..572fa766e --- /dev/null +++ b/account_banking_mandate/views/res_partner_bank_view.xml @@ -0,0 +1,48 @@ + + + + + + + mandate.res.partner.bank.form + res.partner.bank + + + + + + + + + + + + mandate.res.partner.bank.tree + res.partner.bank + + + + + + + + + + + mandate.partner.form + res.partner + + + + + + + + + +