Payroll

• resource_calendar_id Many2one
  help="Employee's working schedule." required=True
• schedule_pay Selection
  default='monthly' help='Defines the frequency of the wage payment.' index=True string='Scheduled Pay' args: [('monthly', 'Monthly'), ('quarterly', 'Quarterly'), ('semi-annually', 'Semi-annually'), ('annually', 'Annually'), ('weekly', 'Weekly'), ('bi-weekly', 'Bi-weekly'), ('bi-monthly', 'Bi-monthly')]
• struct_id Many2one → hr.payroll.structure
  string='Salary Structure' args: 'hr.payroll.structure'

• get_all_structures(self)
  @api.multi
  @return: the structures linked to the given contracts, ordered by hierachy (parent=False first, then first level children and so on) and without duplicata
• get_attribute(self, code, attribute)
  @api.multi
• set_attribute_value(self, code, active)
  @api.multi

• code Char
  required=True args: 'Code'
• default_value Float
  args: 'Default value for this advantage'
• lower_bound Float
  help='Lower bound authorized by the employer for this advantage' args: 'Lower Bound'
• name Char
  required=True args: 'Name'
• upper_bound Float
  help='Upper bound authorized by the employer for this advantage' args: 'Upper Bound'

No public methods.

• company_id Many2one → res.company
  default=<expr> string='Company' args: 'res.company'
• name Char
  required=True
• note Text
  string='Description'
• partner_id Many2one → res.partner
  string='Partner' args: 'res.partner'
• register_line_ids One2many → hr.payslip.line
  readonly=True string='Register Line' args: 'hr.payslip.line', 'register_id'

No public methods.

• payslip_count Integer
  compute='_compute_payslip_count' groups='hr_payroll.group_hr_payroll_user' string='Payslip Count'
• slip_ids One2many → hr.payslip
  readonly=True string='Payslips' args: 'hr.payslip', 'employee_id'

No public methods.

• children_ids One2many → hr.payroll.structure
  copy=True string='Children' args: 'hr.payroll.structure', 'parent_id'
• code Char
  required=True string='Reference'
• company_id Many2one → res.company
  copy=False default=<expr> required=True string='Company' args: 'res.company'
• name Char
  required=True
• note Text
  string='Description'
• parent_id Many2one → hr.payroll.structure
  default=_get_parent string='Parent' args: 'hr.payroll.structure'
• rule_ids Many2many → hr.salary.rule
  string='Salary Rules' args: 'hr.salary.rule', 'hr_structure_salary_rule_rel', 'struct_id', 'rule_id'

• copy(self, default=None)
  @api.multi@api.returns('self', <expr>)
• get_all_rules(self)
  @api.multi
  @return: returns a list of tuple (id, sequence) of rules that are maybe to apply

• company_id Many2one → res.company
  copy=False default=<expr> readonly=True states={'draft': [('readonly', False)]} string='Company' args: 'res.company'
• contract_id Many2one → hr.contract
  readonly=True states={'draft': [('readonly', False)]} string='Contract' args: 'hr.contract'
• credit_note Boolean
  help='Indicates this payslip has a refund of another' readonly=True states={'draft': [('readonly', False)]} string='Credit Note'
• date_from Date
  default=<expr> readonly=True required=True states={'draft': [('readonly', False)]} string='Date From'
• date_to Date
  default=<expr> readonly=True required=True states={'draft': [('readonly', False)]} string='Date To'
• details_by_salary_rule_category One2many → hr.payslip.line
  compute='_compute_details_by_salary_rule_category' string='Details by Salary Rule Category' args: 'hr.payslip.line'
• employee_id Many2one → hr.employee
  readonly=True required=True states={'draft': [('readonly', False)]} string='Employee' args: 'hr.employee'
• input_line_ids One2many → hr.payslip.input
  readonly=True states={'draft': [('readonly', False)]} string='Payslip Inputs' args: 'hr.payslip.input', 'payslip_id'
• line_ids One2many → hr.payslip.line
  readonly=True states={'draft': [('readonly', False)]} string='Payslip Lines' args: 'hr.payslip.line', 'slip_id'
• name Char
  readonly=True states={'draft': [('readonly', False)]} string='Payslip Name'
• note Text
  readonly=True states={'draft': [('readonly', False)]} string='Internal Note'
• number Char
  copy=False readonly=True states={'draft': [('readonly', False)]} string='Reference'
• paid Boolean
  copy=False readonly=True states={'draft': [('readonly', False)]} string='Made Payment Order ? '
• payslip_count Integer
  compute='_compute_payslip_count' string='Payslip Computation Details'
• payslip_run_id Many2one → hr.payslip.run
  copy=False readonly=True states={'draft': [('readonly', False)]} string='Payslip Batches' args: 'hr.payslip.run'
• state Selection
  copy=False default='draft' help="* When the payslip is created the status is 'Draft'\n \n* If the payslip is under verification, the status is 'Waiting'.\n \n* If the payslip is confirmed then status is set to 'Done'.\n \n* When user cancel payslip the status is 'Rejected'." index=True readonly=True string='Status' args: [('draft', 'Draft'), ('verify', 'Waiting'), ('done', 'Done'), ('cancel', 'Rejected')]
• struct_id Many2one → hr.payroll.structure
  help="Defines the rules that have to be applied to this payslip, accordingly to the contract chosen. If you let empty the field contract, this field isn't mandatory anymore and thus the rules applied will be all the rules set on the structure of all contracts of the employee valid for the chosen period" readonly=True states={'draft': [('readonly', False)]} string='Structure' args: 'hr.payroll.structure'
• worked_days_line_ids One2many → hr.payslip.worked_days
  copy=True readonly=True states={'draft': [('readonly', False)]} string='Payslip Worked Days' args: 'hr.payslip.worked_days', 'payslip_id'

• action_payslip_cancel(self)
  @api.multi
• action_payslip_done(self)
  @api.multi
• action_payslip_draft(self)
  @api.multi
• check_done(self)
  @api.multi
• compute_sheet(self)
  @api.multi
• copy(self, default=None)
  @api.multi@api.returns('self', <expr>)
• get_contract(self, employee, date_from, date_to)
  @api.model
  @param employee: recordset of employee @param date_from: date field @param date_to: date field @return: returns the ids of all the contracts for the given employee that need to be considered for the given dates
• get_inputs(self, contracts, date_from, date_to)
  @api.model
• get_salary_line_total(self, code)
• get_worked_day_lines(self, contracts, date_from, date_to)
  @api.model
  @param contract: Browse record of contracts @return: returns a list of dict containing the input that should be applied for the given contract between date_from and date_to
• onchange_contract(self)
  @api.onchange('contract_id')
• onchange_employee(self)
  @api.onchange('employee_id', 'date_from', 'date_to')
• onchange_employee_id(self, date_from, date_to, employee_id=False, contract_id=False)
  @api.multi
• refund_sheet(self)
  @api.multi
• unlink(self)
  @api.multi

• employee_ids Many2many → hr.employee
  args: 'hr.employee', 'hr_employee_group_rel', 'payslip_id', 'employee_id', 'Employees'

• compute_sheet(self)
  @api.multi

• amount Float
  help='It is used in computation. For e.g. A rule for sales having 1% commission of basic salary for per product can defined in expression like result = inputs.SALEURO.amount * contract.wage*0.01.'
• code Char
  help='The code that can be used in the salary rules' required=True
• contract_id Many2one → hr.contract
  help='The contract for which applied this input' required=True string='Contract' args: 'hr.contract'
• name Char
  required=True string='Description'
• payslip_id Many2one → hr.payslip
  index=True ondelete='cascade' required=True string='Pay Slip' args: 'hr.payslip'
• sequence Integer
  default=10 index=True required=True

No public methods.

• amount Float
  digits=dp.get_precision('Payroll')
• contract_id Many2one → hr.contract
  index=True required=True string='Contract' args: 'hr.contract'
• employee_id Many2one → hr.employee
  required=True string='Employee' args: 'hr.employee'
• quantity Float
  default=1.0 digits=dp.get_precision('Payroll')
• rate Float
  default=100.0 digits=dp.get_precision('Payroll Rate') string='Rate (%)'
• salary_rule_id Many2one → hr.salary.rule
  required=True string='Rule' args: 'hr.salary.rule'
• slip_id Many2one → hr.payslip
  ondelete='cascade' required=True string='Pay Slip' args: 'hr.payslip'
• total Float
  compute='_compute_total' digits=dp.get_precision('Payroll') store=True string='Total'

• create(self, vals_list)
  @api.model_create_multi

• credit_note Boolean
  help='If its checked, indicates that all payslips generated from here are refund payslips.' readonly=True states={'draft': [('readonly', False)]} string='Credit Note'
• date_end Date
  default=<expr> readonly=True required=True states={'draft': [('readonly', False)]} string='Date To'
• date_start Date
  default=<expr> readonly=True required=True states={'draft': [('readonly', False)]} string='Date From'
• name Char
  readonly=True required=True states={'draft': [('readonly', False)]}
• slip_ids One2many → hr.payslip
  readonly=True states={'draft': [('readonly', False)]} string='Payslips' args: 'hr.payslip', 'payslip_run_id'
• state Selection
  copy=False default='draft' index=True readonly=True string='Status' args: [('draft', 'Draft'), ('close', 'Close')]

• close_payslip_run(self)
  @api.multi
• draft_payslip_run(self)
  @api.multi
• unlink(self)
  @api.multi

• code Char
  help='The code that can be used in the salary rules' required=True
• contract_id Many2one → hr.contract
  help='The contract for which applied this input' required=True string='Contract' args: 'hr.contract'
• name Char
  required=True string='Description'
• number_of_days Float
  string='Number of Days'
• number_of_hours Float
  string='Number of Hours'
• payslip_id Many2one → hr.payslip
  index=True ondelete='cascade' required=True string='Pay Slip' args: 'hr.payslip'
• sequence Integer
  default=10 index=True required=True

No public methods.

• code Char
  help='The code that can be used in the salary rules' required=True
• input_id Many2one → hr.salary.rule
  required=True string='Salary Rule Input' args: 'hr.salary.rule'
• name Char
  required=True string='Description'

No public methods.

• active Boolean
  default=True help='If the active field is set to false, it will allow you to hide the salary rule without removing it.'
• amount_fix Float
  digits=dp.get_precision('Payroll') string='Fixed Amount'
• amount_percentage Float
  digits=dp.get_precision('Payroll Rate') help='For example, enter 50.0 to apply a percentage of 50%' string='Percentage (%)'
• amount_percentage_base Char
  help='result will be affected to a variable' string='Percentage based on'
• amount_python_compute Text
  default="\n # Available variables:\n #----------------------\n # payslip: object containing the payslips\n # employee: hr.employee object\n # contract: hr.contract object\n # rules: object containing the rules code (previously computed)\n # categories: object containing the computed salary rule categories (sum of amount of all rules belonging to that category).\n # worked_days: object containing the computed worked days.\n # inputs: object containing the computed inputs.\n\n # Note: returned value have to be set in the variable 'result'\n\n result = contract.wage * 0.10" string='Python Code'
• amount_select Selection
  default='fix' help='The computation method for the rule amount.' index=True required=True string='Amount Type' args: [('percentage', 'Percentage (%)'), ('fix', 'Fixed Amount'), ('code', 'Python Code')]
• appears_on_payslip Boolean
  default=True help='Used to display the salary rule on payslip.' string='Appears on Payslip'
• category_id Many2one → hr.salary.rule.category
  required=True string='Category' args: 'hr.salary.rule.category'
• child_ids One2many → hr.salary.rule
  copy=True string='Child Salary Rule' args: 'hr.salary.rule', 'parent_rule_id'
• code Char
  help='The code of salary rules can be used as reference in computation of other rules. In that case, it is case sensitive.' required=True
• company_id Many2one → res.company
  default=<expr> string='Company' args: 'res.company'
• condition_python Text
  default="\n # Available variables:\n #----------------------\n # payslip: object containing the payslips\n # employee: hr.employee object\n # contract: hr.contract object\n # rules: object containing the rules code (previously computed)\n # categories: object containing the computed salary rule categories (sum of amount of all rules belonging to that category).\n # worked_days: object containing the computed worked days\n # inputs: object containing the computed inputs\n\n # Note: returned value have to be set in the variable 'result'\n\n result = rules.NET > categories.NET * 0.10" help='Applied this rule for calculation if condition is true. You can specify condition like basic > 1000.' required=True string='Python Condition'
• condition_range Char
  default='contract.wage' help='This will be used to compute the % fields values; in general it is on basic, but you can also use categories code fields in lowercase as a variable names (hra, ma, lta, etc.) and the variable basic.' string='Range Based on'
• condition_range_max Float
  help='The maximum amount, applied for this rule.' string='Maximum Range'
• condition_range_min Float
  help='The minimum amount, applied for this rule.' string='Minimum Range'
• condition_select Selection
  default='none' required=True string='Condition Based on' args: [('none', 'Always True'), ('range', 'Range'), ('python', 'Python Expression')]
• input_ids One2many → hr.rule.input
  copy=True string='Inputs' args: 'hr.rule.input', 'input_id'
• name Char
  required=True translate=True
• note Text
  string='Description'
• parent_rule_id Many2one → hr.salary.rule
  index=True string='Parent Salary Rule' args: 'hr.salary.rule'
• quantity Char
  default='1.0' help='It is used in computation for percentage and fixed amount. For e.g. A rule for Meal Voucher having fixed amount of 1€ per worked day can have its quantity defined in expression like worked_days.WORK100.number_of_days.'
• register_id Many2one → hr.contribution.register
  help='Eventual third party involved in the salary payment of the employees.' string='Contribution Register' args: 'hr.contribution.register'
• sequence Integer
  default=5 help='Use to arrange calculation sequence' index=True required=True

No public methods.

• children_ids One2many → hr.salary.rule.category
  string='Children' args: 'hr.salary.rule.category', 'parent_id'
• code Char
  required=True
• company_id Many2one → res.company
  default=<expr> string='Company' args: 'res.company'
• name Char
  required=True translate=True
• note Text
  string='Description'
• parent_id Many2one → hr.salary.rule.category
  help='Linking a salary category to its parent is used only for the reporting purpose.' string='Parent' args: 'hr.salary.rule.category'

No public methods.

• date_from Date
  default=datetime.now().strftime('%Y-%m-01') required=True string='Date From'
• date_to Date
  default=<expr> required=True string='Date To'

• print_report(self)
  @api.multi

No new fields.

No public methods.

No new fields.

• get_details_by_rule_category(self, payslip_lines)
• get_lines_by_contribution_register(self, payslip_lines)

• module_account_accountant Boolean
  string='Account'
• module_l10n_be_hr_payroll Boolean
  string='Belgium Payroll'
• module_l10n_fr_hr_payroll Boolean
  string='French Payroll'
• module_l10n_in_hr_payroll Boolean
  string='Indian Payroll'

No public methods.