diff --git a/content/applications/hr/payroll.rst b/content/applications/hr/payroll.rst index 72d9cb2a69..9078c001f6 100644 --- a/content/applications/hr/payroll.rst +++ b/content/applications/hr/payroll.rst @@ -61,142 +61,6 @@ Payroll - :guilabel:`Payslip PDF Display`: enable this option to show the payslip's PDF when the state is validated. -.. _payroll/work-entries-config: - -Contracts -========= - -In order for an employee to be paid, they **must** have an active contract for a specific type of -employment. Creating and viewing contract templates, and creating and viewing employment types, is -possible from this section of the configuration header menu. - -.. _payroll/contract-templates: - -Templates ---------- - -Contract templates are used when sending an offer to a candidate. -The contract template forms the basis of an offer, and can be modified for specific candidates or -employees, when necessary. If a contract template is created or modified in the *Payroll* -application, the changes are also reflected in the *Recruitment* application. - -.. important:: - To access contract templates, the *Salary Configurator* (`hr_contract_salary`) module **must** be - :ref:`installed `. - -To view all the current contract templates in the database, navigate to :menuselection:`Payroll app ---> Configuration --> Contracts: Templates`. - -On the :guilabel:`Contract Templates` page, all current contract templates appear in a list view. To -view the details of a contract template, click anywhere on the line to open the contract form. The -contract template can be modified from this form. Proceed to make any desired changes to the -contract. - -To create a new contract template, click the :guilabel:`New` button. Then, enter the following -information on the blank contract template form that appears: - -- :guilabel:`Contract Reference`: enter a brief description for the template. This should be clear - and easily understood, as this name appears in the *Recruitment* application, as well. -- :guilabel:`Working Schedule`: select the desired working schedule the contract applies to from the - drop-down menu. If a new working schedule is needed, create a :ref:`new working schedule - `. -- :guilabel:`Work Entry Source`: select how the work entries are generated. Choices are either: - - - :guilabel:`Working Schedule`: work entries are generated based on the selected working schedule. - - :guilabel:`Attendances`: work entries are generated based on the employee's attendance, as they - are logged in the *Attendances* application. Refer to the :ref:`Attendances - ` documentation for information on checking in and out. - - :guilabel:`Planning`: work entries are generated based on the employee's planning in the - *Planning* application. - -- :guilabel:`Salary Structure Type`: select the :ref:`salary structure type - ` from the drop-down menu. -- :guilabel:`Department`: select the department the contract template applies to from the drop-down - menu. If blank, the template applies to all departments. -- :guilabel:`Job Position`: select the :ref:`job position ` the contract - template applies to from the drop-down menu. If blank, the template applies to all job positions. -- :guilabel:`Wage on Payroll`: enter the monthly wage in the field. -- :guilabel:`Contract Type`: select the type of contract from the drop-down menu. This list is the - same as the :ref:`Employment Types `. -- :guilabel:`HR Responsible`: select the employee responsible for validating contracts, using this - template, from the drop-down menu. -- :guilabel:`New Contract Document Template`: select a default document that a new employee has to - sign to accept an offer. -- :guilabel:`Contract Update Document Template`: select a default document that a current employee - has to sign to update their contract. - -.. image:: payroll/contract-template.png - :align: center - :alt: A new contract template form, with the fields filled in. - -Salary information tab -~~~~~~~~~~~~~~~~~~~~~~ - -- :guilabel:`Wage Type`: select either :guilabel:`Fixed Wage` or :guilabel:`Hourly Wage` from the - drop-down menu. -- :guilabel:`Schedule Pay`: using the drop-down menu, select how often the employee is paid. Options - include :guilabel:`Annually`, :guilabel:`Semi-annually`, :guilabel:`Quarterly`, - :guilabel:`Bi-monthly`, :guilabel:`Monthly`, :guilabel:`Semi-monthly`, :guilabel:`Bi-weekly`, - :guilabel:`Weekly`, or :guilabel:`Daily`. -- :guilabel:`Wage`: enter the gross wage. The time period presented in this field is based on what - is selected for the :guilabel:`Scheduled Pay` field. It is recommended to populate the - :guilabel:`Yearly Cost (Real)` field *first*, since that entry updates this field automatically. -- :guilabel:`Yearly Cost (Real)`: enter the total yearly cost the employee costs the employer. When - this value is entered, the :guilabel:`Monthly Cost (Real)` is automatically updated. -- :guilabel:`Monthly Cost (Real)`: this field is **not** editable. The value is automatically - populated after the :guilabel:`Yearly Cost (Real)` is entered. - -.. important:: - The :guilabel:`Schedule Pay`, :guilabel:`Wage`, and :guilabel:`Yearly Cost (Real)` fields are all - linked. If any of these fields are updated, the other two fields automatically update to reflect - the change. It is best practice to check these three fields if any modifications have been made, - to ensure they are accurate. - -.. image:: payroll/salary-information.png - :align: center - :alt: The salary information tab, with the fields filled in. - -Pre-tax benefits and post-tax deductions -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Depending on the localization settings set for the company, the entries presented in this section -either vary, or may not appear at all. - -For example, some entries may pertain to retirement accounts, health insurance benefits, and -commuter benefits. - -Enter the monetary amounts or percentages to specify how much of the employee's salary goes to the -various benefits and/or deductions. - -.. _payroll/employment-types: - -Employment types ----------------- - -To view all the pre-configured employment types, navigate to :menuselection:`Payroll application --> -Configuration --> Contracts: Employment Types`. - -The employment types are presented in a list view on the :guilabel:`Employment Types` page. - -The default employment types are :guilabel:`Permanent`, :guilabel:`Temporary`, :guilabel:`Seasonal`, -:guilabel:`Interim`, :guilabel:`Full-Time`, :guilabel:`Part-Time`, and :guilabel:`Permanent`. - -To make a new employment type, click the :guilabel:`New` button in the upper-left corner, and a -blank line appears at the bottom of the :guilabel:`Employment Types` page. - -On this new blank line, enter the name of the employment type in the :guilabel:`Name` column. If the -employment type is country-specific, select the country using the drop-down menu in the -:guilabel:`Country` column. If a country is selected, then the employment type is *only* applicable -for that specific country. - -To rearrange the order of the employment types, click the :guilabel:`six small gray boxes` icon to -the left of the employment type :guilabel:`Name`, and drag the line to the desired position on the -list. - -.. image:: payroll/employment-types.png - :align: center - :alt: The employment types in the database by default, in a list view. - .. _payroll/work-entries: Work entries diff --git a/content/applications/hr/payroll/contracts.rst b/content/applications/hr/payroll/contracts.rst index 1302f3d53c..ec50fd0a25 100644 --- a/content/applications/hr/payroll/contracts.rst +++ b/content/applications/hr/payroll/contracts.rst @@ -3,8 +3,8 @@ Contracts ========= Every employee in Odoo is required to have a running contract in order to be paid. A contract -outlines the terms of an employee's position, their compensation, working hours, and any -other relevant details pertaining to their compensation. +outlines the terms of an employee's position, compensation, working hours, and any other relevant +terms. .. important:: Contract documents (PDFs) are uploaded and organized using the **Documents** application, and are @@ -54,13 +54,17 @@ Enter the following information in the top-half of the blank contract form: - :guilabel:`Contact Reference`: Type in the name or title for the contract, such as `John Smith Contract`. This field is **required**. - :guilabel:`Employee`: Using the drop-down menu, select the employee the contract is for. -- :guilabel:`Contract Start Date`: Required. Defaults to the current date. To choose a different - date, click into the field. In the popover calendar, select a different date. -- :guilabel:`Contract End Date`: Optional. Select a date from the calendar popover, or leave blank - for an indefinite contract. +- :guilabel:`Contract Start Date`: Select the date the contract goes into effect. Contracts can be + created retroactively, or be created to begin at a future date. The current date populates this + required field by default, but can be modified. +- :guilabel:`Contract End Date`: If the contract has a firm end date, enter the date in this field. + Leave this field blank if the contract runs indefinitely, or until a new contract is made (when + the employee has a change to their job title, salary, or benefits). - :guilabel:`Working Schedule`: Select one of the available working schedules the employee is - expected to work, from the drop-down menu. If this field is left blank, this allows the employee - to work as many or as few hours as desired every week, with no restrictions. + expected to work, from the drop-down menu. The selected working schedule determines how :doc:`work + entries ` are generated, which determines the employees schedule and compensation. + If this field is left blank, this allows the employee to work as many or as few hours as desired + every week, with no restrictions. .. tip:: The :guilabel:`Working Schedule` drop-down menu displays all the working schedules for the @@ -68,6 +72,8 @@ Enter the following information in the top-half of the blank contract form: Configuration --> Working Schedules`. Click :guilabel:`New`, and create a new working schedule, or click on an existing working schedule and make edits. +.. _payroll/work-entry-source: + - :guilabel:`Work Entry Source`: Using the drop-down menu, select how the :doc:`work entries ` are generated. This field is **required**. Click the radio button next to the desired selection. The options are: @@ -138,8 +144,8 @@ employee is paid. Fill in the following fields in this tab: correct if this field is modified. - :guilabel:`Monthly Cost (Real)`: This field automatically updates after the :guilabel:`Schedule Pay` and :guilabel:`Wage` fields are entered. This amount is the total monthly cost for the - employer. This field **cannot** be modified, and is calculated based on the :guilabel:`Yearly - Cost (Real)`. + employer. This field **cannot** be modified, and is calculated based on the :guilabel:`Yearly Cost + (Real)`. .. figure:: contracts/salary-info.png :alt: The Salary Information tab filled out. @@ -152,14 +158,8 @@ information (refer to the :doc:`country-specific localization document Configuration --> Templates`. - +- :guilabel:`Contract Template`: Using the drop-down menu, select a :ref:`contract template + ` to use when making an offer to an applicant. - :guilabel:`Originated Offer`: This field automatically populates with the original offer sent to the employee. This field is **not** modifiable, and is only populated if applicable. - :guilabel:`Part Time`: Tick the checkbox if the contract is for part time work. Once enabled, a @@ -209,8 +209,8 @@ templates are uploaded, modified, and stored. .. important:: The :guilabel:`PDF Template` fields are only visible if the **Sign** app is installed, along with - the :guilabel:`hr_contract_salary` and :guilabel:`hr_contract_salary_payroll` - :doc:`modules <../../general/apps_modules>`. + the :guilabel:`hr_contract_salary` and :guilabel:`hr_contract_salary_payroll` :doc:`modules + <../../general/apps_modules>`. .. figure:: contracts/signatories.png :alt: The Signatories tab with the roles specified for signing. @@ -279,6 +279,100 @@ After all required parties have signed the contract, the status changes to :guil All status changes happen automatically as the document is signed. +.. _payroll/contract-template: + +Contract templates +================== + +Contract *templates* eliminate the need to configure new contracts every time an employee is +hired. Having multiple contract templates allows for faster contract creation for different types of +employment positions that are commonly filled, such as full time, part time, seasonal, etc. + +Contract templates are created through the **Payroll** app configuration menu, and stored in the +**Documents** app. + +.. important:: + To access contract templates, the **Salary Configurator** (`hr_contract_salary`) module **must** + be :ref:`installed `. + +To view all contract templates, navigate to :menuselection:`Payroll app --> Configuration --> +Templates`. + +The :guilabel:`Contract Templates` page lists all existing templates. Click a template line to open +and edit it. + +To create a new contract template, click the :guilabel:`New` button. Then, enter the following +information on the blank contract template form that appears: + +- :guilabel:`Contract Reference`: Enter a brief description for the template. This should be clear + and easily understood, as this name appears in the **Recruitment** application, as well. +- :guilabel:`Working Schedule`: Select the desired working schedule the contract applies to from the + drop-down menu. If a new working schedule is needed, create a :ref:`new working schedule + `. +- :guilabel:`Work Entry Source`: Select :ref:`how the work entries are generated + `. +- :guilabel:`Salary Structure Type`: Select the :ref:`salary structure type + ` from the drop-down menu. +- :guilabel:`Department`: Select the department the contract template applies to from the drop-down + menu. If blank, the template applies to all departments. +- :guilabel:`Job Position`: Select the :ref:`job position ` the contract + template applies to from the drop-down menu. If blank, the template applies to all job positions. +- :guilabel:`Contract Type`: Select the type of contract from the drop-down menu. This list is the + same as the *employment type*. +- :guilabel:`Wage on Payroll`: Enter the monthly wage in the field. +- :guilabel:`HR Responsible`: Select the employee responsible for validating contracts, using this + template, from the drop-down menu. + +.. image:: contracts/contract-template.png + :alt: A new contract template form, with the fields filled in. + +Salary information tab +---------------------- + +- :guilabel:`Wage Type`: Select either :guilabel:`Fixed Wage` or :guilabel:`Hourly Wage` from the + drop-down menu. +- :guilabel:`Schedule Pay`: Using the drop-down menu, select how often the employee is paid. Options + include :guilabel:`Annually`, :guilabel:`Semi-annually`, :guilabel:`Quarterly`, + :guilabel:`Bi-monthly`, :guilabel:`Monthly`, :guilabel:`Semi-monthly`, :guilabel:`Bi-weekly`, + :guilabel:`Weekly`, or :guilabel:`Daily`. +- :guilabel:`Wage`: Enter the gross wage. The time period presented in this field is based on what + is selected for the :guilabel:`Scheduled Pay` field. It is recommended to populate the + :guilabel:`Yearly Cost (Real)` field *first*, since that entry updates this field automatically. +- :guilabel:`Yearly Cost (Real)`: Enter the total yearly cost the employee costs the employer. When + this value is entered, the :guilabel:`Monthly Cost (Real)` is automatically updated. +- :guilabel:`Monthly Cost (Real)`: This field is **not** editable. The value is automatically + populated after the :guilabel:`Yearly Cost (Real)` is entered. + +.. important:: + The :guilabel:`Schedule Pay`, :guilabel:`Wage`, and :guilabel:`Yearly Cost (Real)` fields are all + linked. If any of these fields are updated, the other two fields automatically update to reflect + the change. It is best practice to check these three fields if any modifications have been made, + to ensure they are accurate. + +.. image:: contracts/salary-information.png + :alt: The salary information tab, with the fields filled in. + +Benefits and deductions +~~~~~~~~~~~~~~~~~~~~~~~ + +Depending on the :doc:`payroll localization ` for the company, the entries +presented in this section either vary, or may not appear at all. For example, some entries may +pertain to retirement accounts, health insurance benefits, and commuter benefits. + +Enter the monetary amounts or percentages to specify how much of the employee's salary goes to the +various benefits and deductions. + +Signatories tab +--------------- + +This tab outlines which documents the employee must sign to either accept a new offer or an updated +contract. + +- :guilabel:`New Contract PDF Template`: Select the default document that a new employee has to sign + to accept an offer. +- :guilabel:`Contract Update PDF Template`: Select the default document that a current employee has + to sign to update their contract. + .. seealso:: - :doc:`../../productivity/documents` - :doc:`../../productivity/sign` diff --git a/content/applications/hr/payroll/contract-template.png b/content/applications/hr/payroll/contracts/contract-template.png similarity index 100% rename from content/applications/hr/payroll/contract-template.png rename to content/applications/hr/payroll/contracts/contract-template.png diff --git a/content/applications/hr/payroll/salary-information.png b/content/applications/hr/payroll/contracts/salary-information.png similarity index 100% rename from content/applications/hr/payroll/salary-information.png rename to content/applications/hr/payroll/contracts/salary-information.png