Payroll

The Payroll application computes the payslips of employees: from the contractual data of the employee and the time actually worked, a set of salary rules produces the lines of the payslip (basic salary, allowances, social contributions, taxes, net salary, …).

The application is split over several modules:

hr_work_entry (community)

Generates the work entries of employees: what kind of time (worked, sick, holiday, overtime, …) was spent when. See Work entries.

hr_payroll (enterprise)

Payslips, pay runs, salary structures and rules, rule parameters, salary attachments and yearly declarations. It is generic: it does not compute any tax by itself.

l10n_xx_hr_payroll (enterprise)

The payroll localizations. They provide the salary structures, rules and parameters of a country, and the legal reports and declarations. See Writing a payroll localization.

The payroll builds on the employee versions: the wage, the working schedule and the salary structure type of an employee are fields of hr.version. Read Versions and contracts first if you are not familiar with them.

Note

In Odoo 20.0, there is no hr.contract model anymore (contractual data lives on hr.version) and work entries are no longer stored records (they are generated when needed).

Models overview

hr.payroll.structure.type, hr.payroll.structure

A structure type (e.g. Employee, Worker) groups the salary structures applicable to a kind of contract; one of them is its regular pay structure. A structure (e.g. Regular Pay, 13th Month) is an ordered set of salary rules.

hr.salary.rule, hr.salary.rule.category

A salary rule computes one line of the payslip, with Python code or simple formulas. Rules are grouped in categories (e.g. BASIC, GROSS, DED, NET) whose totals other rules can use.

hr.rule.parameter

Legal values that change over time (tax brackets, ceilings, rates), read by the rules.

hr.payslip

A payslip: an employee, a version, a structure and a period. It holds the worked days, the inputs and the computed lines.

hr.payslip.run

A pay run, i.e. a batch of payslips computed and validated together.

hr.salary.attachment

A recurring or one-time amount (garnishment, advance, child support) added to the payslips of an employee through a salary rule.

Computing a payslip

1. A payslip is created for an employee and a period. Its version and its structure (the regular pay structure of the version’s structure type, by default) are computed.

2. The work entries of the period are generated from the version (working schedule, time off, attendances…) and aggregated by work entry type into worked days lines (days, hours and amount). See Work entries.

3. Inputs are added: manual inputs, salary attachments, values set on the employee.

4. compute_sheet() builds the evaluation context of the rules (the localdict: employee, version, worked days, inputs, category totals, …) and evaluates the rules of the structure one after the other. Each rule whose condition is satisfied produces a payslip line; its total is added to its categories and made available to the next rules. See Payslips.

5. The payslip is validated, then marked as paid. With hr_payroll_account, the validation creates the journal entry of the payslip.

Example

Computing a payslip from the shell:

from datetime import date

employee = env['hr.employee'].search(
    [('version_id.contract_date_start', '!=', False)], limit=1,
)
payslip = env['hr.payslip'].create({
    'employee_id': employee.id,
    'date_from': date(2026, 10, 1),
    'date_to': date(2026, 10, 31),
})
payslip.struct_id.name  # 'Worker Pay', the regular pay structure of the version
payslip.compute_sheet()
payslip.line_ids.mapped(lambda line: (line.code, line.total))
# [('BASIC', 129.26), ('GROSS', 129.26), ('NET', 129.26)] with the generic demo data;
# a localization adds its contributions and taxes between GROSS and NET

• Work entries
• Payslips
• Pay runs and warnings
• Salary structures and rules
• Rule parameters
• Payroll data of versions
• Payslip adjustments
• Declarations
• Salary configurator
• Writing a payroll localization