Skip to content

Commit 07d3a6b

Browse files
tivissesamueljlieber
authored andcommitted
[FIX] payroll: Improve false or misleading contract documentation page
Part-of: #12181 Signed-off-by: Yannick Tivisse (yti) <[email protected]>
1 parent 18c4334 commit 07d3a6b

File tree

1 file changed

+13
-83
lines changed

1 file changed

+13
-83
lines changed

content/applications/hr/payroll/contracts.rst

Lines changed: 13 additions & 83 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
Contracts
33
=========
44

5-
Every employee in Odoo is required to have a contract in order to be paid. A contract outlines the
6-
terms of an employee's position, their compensation, working hours, and any other details about
7-
their position.
5+
Every employee in Odoo is required to have a running contract in order to be paid. A contract
6+
outlines the terms of an employee's position, their compensation, working hours, and any
7+
other details about their position.
88

99
.. important::
1010
Contract documents (PDFs) are uploaded and organized using the *Documents* application, and are
@@ -14,7 +14,7 @@ their position.
1414

1515
To view the employee contracts, go to the :menuselection:`Payroll app --> Contracts --> Contracts`
1616
from the top menu. All employee contracts, and their current contract status, are displayed in a
17-
Kanban view, by default. The Kanban view displays running contracts, contracts that require action,
17+
list view, by default. The list view displays running contracts, contracts that require action,
1818
expired contracts, and cancelled contracts.
1919

2020
.. image:: contracts/contracts-overview.png
@@ -29,7 +29,7 @@ expired contracts, and cancelled contracts.
2929

3030
In order for an employee to be paid, an active contract is required. If a new contract is needed,
3131
click the :guilabel:`Create` button on the :guilabel:`Contracts` dashboard. A contract form appears
32-
where the information can be entered. Required fields are underlined in bold.
32+
where the information can be entered.
3333

3434
New contract form
3535
-----------------
@@ -88,36 +88,6 @@ General information section
8888
:alt: New contract form to be filled in when creating a new contract, with required fields
8989
outlined in red.
9090

91-
- :guilabel:`Contact Reference`: type in the name or title for the contract, such as `John Smith
92-
Contract`. This field is **required**.
93-
- :guilabel:`Employee`: name of the employee the contract applies to.
94-
- :guilabel:`Contract Start Date`: the date the contract starts. Choose a date by clicking on the
95-
drop-down menu, navigating to the correct month and year by using the :icon:`fa-chevron-left`
96-
:icon:`fa-chevron-right` :guilabel:`(arrow)` icons, then clicking on the desired date. This field
97-
is **required**.
98-
- :guilabel:`Contract End Date`: the date the contract ends. Choose a date by clicking on the
99-
drop-down menu, navigating to the correct month and year by using the :icon:`fa-chevron-left`
100-
:icon:`fa-chevron-right` :guilabel:`(arrow)` icons, then clicking on the desired date. This field
101-
is **required**.
102-
- :guilabel:`Salary Structure Type`: select one of the salary structure types from the drop-down
103-
menu. The default salary structure types are :guilabel:`Employee` or :guilabel:`Worker`. A new
104-
salary structure type can be created by typing the name in the field. This field is **required**.
105-
- :guilabel:`Working Schedule`: select one of the working schedules from the drop-down menu. This
106-
field is **required**.
107-
- :guilabel:`Department`: the department the contract applies to.
108-
- :guilabel:`Job Position`: the specific job position the contract applies to.
109-
- :guilabel:`Wage on Payroll`: the amount to be paid to the employee each month.
110-
- :guilabel:`Contract Type`: choose from :guilabel:`CDI`, :guilabel:`CDD`, or :guilabel:`PFI` from
111-
the drop-down menu.
112-
113-
- :guilabel:`CDI` is an open-ended contract with only a start date, but no end date.
114-
- :guilabel:`CDD` is a contract with both a start date and an end date.
115-
- :guilabel:`PFI` is a Belgian-specific contract used when hiring employees that need training,
116-
and covers the training period specifically.
117-
118-
- :guilabel:`HR Responsible`: if there is a specific person in HR that is responsible for the
119-
contract, select the person from the drop-down menu. This field is required.
120-
12191
.. tip::
12292
The :guilabel:`Working Schedule` drop-down menu displays all the working times for the selected
12393
:guilabel:`Company`. To modify or add to this list, go to :menuselection:`Payroll app -->
@@ -213,17 +183,6 @@ Notes section
213183
:align: center
214184
:alt: Contract details in optional tabs for a new contract.
215185

216-
- :guilabel:`Analytic Account`: this field allows a link between the contract and a specific
217-
analytic account for accounting purposes.
218-
- :guilabel:`Contract Template`: select a pre-existing contract template from the drop-down menu.
219-
Contract templates are typically created through the *Recruitment* application.
220-
- :guilabel:`New Contract Document Template`: select a contract from the drop-down menu to be
221-
modified for this new employee contract.
222-
- :guilabel:`Contract Update Document Template`: select a contract from the drop-down menu, if the
223-
employee has an existing contract that requires updating.
224-
- :guilabel:`Notes`: the notes field is a text field where any notes for the employee contract can
225-
be entered for future reference.
226-
227186
Modify a contract template
228187
~~~~~~~~~~~~~~~~~~~~~~~~~~
229188

@@ -234,7 +193,7 @@ the corresponding contract template, and proceed to make any desired changes.
234193
Click the :guilabel:`Upload your file` button next to the corresponding document, navigate to the
235194
file, then click :guilabel:`Open` to select the document and add it to the tab.
236195

237-
Modifying contract templates
196+
Modifying document templates
238197
============================
239198

240199
Contracts templates can be modified at any point when changes are needed.
@@ -264,24 +223,6 @@ Once the edits are complete, click the :guilabel:`Save` button. All the informat
264223
contract template populates the fields in the :guilabel:`Salary Information` tab. Any additional
265224
tabs, such as :guilabel:`Personal Documents`, appears if applicable.
266225

267-
Salary information
268-
------------------
269-
270-
.. image:: contracts/salary-info.png
271-
:align: center
272-
:alt: Optional tabs for a new contract.
273-
274-
This section is where the specific salary details are defined. This section is country-specific, so
275-
these fields vary, depending on where the company is located.
276-
277-
Enter the amount in the various fields, or tick a checkbox to apply a benefit. Some options that can
278-
be entered here include :guilabel:`Group Insurance Sacrifice Rate` and :guilabel:`Canteen Cost`, for
279-
example.
280-
281-
Some fields may be automatically filled in as other fields are entered. For example, the
282-
:guilabel:`Yearly Cost (Real)` and :guilabel:`Monthly Cost (Real)` updates once the :guilabel:`Wage`
283-
is populated.
284-
285226
Personal documents
286227
------------------
287228

@@ -292,22 +233,19 @@ are linked to the employee on their employee record. Documents cannot be added t
292233
The available documents in this tab can be downloaded. Click the :icon:`fa-download`
293234
:guilabel:`(download)` icon next to the document to download it.
294235

295-
Save and send the contract
296-
--------------------------
297-
298-
Once a contract has been created and/or modified, save the contract by clicking the :guilabel:`Save`
299-
button. Next, the contract must be sent to the employee to be signed.
236+
Send the contract
237+
-----------------
300238

301-
Click on one of the following buttons to send the contract to the employee:
239+
Click on the following button to send the contract to the employee:
302240

303241
.. image:: contracts/send-contract.png
304242
:align: center
305243
:alt: Send the contract to the employee via one of the buttons.
306244

307-
- :guilabel:`Generate Simulation Link`: this option is **only** for Belgian companies. Clicking this
308-
opens a pop-up window that contains the basic information from the contract, as well as a link for
309-
the contract when using the salary configurator. Click :guilabel:`Send` to send an email to the
310-
employee, so they can sign the contract.
245+
- :guilabel:`Generate Offer`: Clicking this opens a pop-up window that contains the basic
246+
information from the contract, as well as a link for the contract when using the salary
247+
configurator. Click :guilabel:`Send` to send an email to the employee, so they can sign
248+
the contract.
311249

312250
At the bottom of the pop-up form is a :guilabel:`Link Expiration Date`. This is the timeframe that
313251
the contract offer is valid for. By default, this field is pre-populated with `30 days`, but it can
@@ -347,14 +285,6 @@ Fill out the following fields on the form:
347285
- :guilabel:`Description`: enter a short description for the salary attachment, such as `Child
348286
Support` or `529 Contribution`.
349287
- :guilabel:`Type`: using the drop-down menu, select the type of salary attachment being created.
350-
Choose from:
351-
352-
- :guilabel:`Attachment of Salary`: any payments taken out towards something that is *not* child
353-
support. Typically any garnishments, such as lawsuit payments, payments toward taxes owed, etc.
354-
- :guilabel:`Assignment of Salary`: any deduction that is not required, but voluntary, such as a
355-
pre-tax allocation to a college savings account.
356-
- :guilabel:`Child Support`: any payments taken out specifically for child support.
357-
358288
- :guilabel:`Start Date`: the date the salary attachment starts. Choose a date by clicking on the
359289
drop-down menu, navigating to the correct month and year by using the :icon:`fa-chevron-left`
360290
:icon:`fa-chevron-right` :guilabel:`(arrow)` icons, then clicking on the desired date. This field

0 commit comments

Comments
 (0)