Salary Rule Variables

hr_salary_rule_variable · OCA/hr

    Repository
    OCA/hr · module folder · Try on Runboat
    Module version
    1.0
    Category
    Generic Modules/Human Resources
    Folder size
    0.03 MB
    License
    AGPL-3
    Application
    No
    Auto-installable
    No
    Website
    https://www.savoirfairelinux.com
    Last tracking update
    2026-08-07 07:17:50
    Authors
    Savoir-faire Linux, Odoo Community Association (OCA)
    Maintainers
    Savoir-faire Linux, Odoo Community Association (OCA)
    Committers
    Pedro M. Baeza, Stéphane Bidoul (ACSONE), Iryna Vushnevska
    Odoo dependencies
    odoo/odoo:
    - hr_payroll
    - hr_contract
    - base_action_rule
    - base
    - resource
    - mail
    - base_setup
    - web_kanban
    - web
    - bus
    - web_tour
    - hr
    - hr_holidays
    - calendar
    - web_calendar
    - product
    - decimal_precision
    - report
    Python dependencies
    None
    System dependencies
    None
    Required by
    None
    Description
    Salary Rule Variables
=====================
Salary rule variables are amounts or python expressions that change over
the years. This module allows to compute these variables and reference
them from salary rules.

The purpose of this module is to be able to adapt a complexe salary structures
(e.g. the canadian income tax structure) from one year to another without
going each time through the whole testing procedure.

Numbers change but the whole logic stays the same.

How to use it
-------------
In the python script of a salary rule, you may call it via the payslip
browsable object:
    variable = payslip.get_rule_variable(rule_id, payslip.date_from)

rule_id always refer to the current rule.

If you need more than one variable for a salary rule, use a python dict.

Contributors
------------
* David Dufresne <david.dufresne@savoirfairelinux.com>
* Pierre Lamarche <pierre.lamarche@savoirfairelinux.com>

    Code Analysis ⓘ

    Views touched (3)
    XML IDNameModelTypeStatus
    hr_salary_rule_variable_form hr.salary.rule.variable.form hr.salary.rule.variable form New
    hr_salary_rule_variable_list hr.salary.rule.variable.tree hr.salary.rule.variable tree New
    view_hr_salary_rule_variable_filter hr.salary.rule.variable.select hr.salary.rule.variable search New
    HTTP endpoints (0)

    No HTTP endpoints found for this module.

    Models touched (3)

    New fields (0)

    No new fields.

    Public methods (1)
    • get_rule_variable(self, cr, uid, ids, rule_id, date, localdict=False, context=None)
      Gets a salary rule variable related to a salary rule for a period of time This method is called from the salary rule: payslip.get_rule_variable(rule_id, payslip.date_from) By using the optional argument localdict, you can pass the value of salary rule already computed. Example: payslip.get_rule_variable(rule_id, payslip.date_from, GROSS) returns: fixed amount (a float) or a python object (most likely a dict)

    New fields (0)

    No new fields.

    Public methods (1)
    • compute_rule(self, cr, uid, rule_id, localdict, context=None)

    New fields (0)

    No new fields.

    Public methods (0)

    No public methods.

    Loading…

    Loading…

    Loading…