Skip to main content

Employee Benefit

Project description

License: AGPL-3

Employee Benefit

This module implements employee benefits in order to produce payslips.

Employee benefits can be computed automatically at a specific point in a payroll structure. They can also be computed using the button on the payslip form, in the ‘Employee Benefits’ tab.

Also, they can be added manually on a payslip.

If a benefit has 2 different rates in the same payslip period, the 2 rates will be weighted by the fraction of the payslip over which they apply.


Setting employee benefits

Go to Human Resources -> Configuration -> Payroll -> Employee Benefit Categories Create your own employee benefit. Select the salary rules over which the benefit will be summed. Add as many different rates as needed.

On the contract of an employee, add employee benefits. Select the category of benefit, the rate and dates between which the benefit will be activated.

Setting the payroll structure

In a salary rule of your payroll structure, you may call


This allows compute the employee benefits at a specific point in the payroll structure.

Whithin a salary rule, you may sum of benefits for a list of category codes:

  • Employee contribution:
    result = rule.sum_benefits(payslip, codes=[‘A1’, ‘B2’])
  • Employer contribution:
    result = rule.sum_benefits(payslip, codes=[‘C3’], employer=True)

The parameter codes is the list of benefit categories to include. To sum over the benefits related to the current salary rule:

  • Employee contribution:
    result = rule.sum_benefits(payslip)
  • Employer contribution:
    result = rule.sum_benefits(payslip, employer=True)

If the salary rule is related to no benefit categories, the method will sum all benefit categories.

Bug Tracker

Bugs are tracked on GitHub Issues. In case of trouble, please check there if your issue has already been reported. If you spotted it first, help us smashing it by providing a detailed and welcomed feedback here.



Odoo Community Association

This module is maintained by the OCA.

OCA, or the Odoo Community Association, is a nonprofit organization whose mission is to support the collaborative development of Odoo features and promote its widespread use.

To contribute to this module, please visit

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Built Distribution

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page