[IMP] payroll: updating new reporting for 17

closes odoo/documentation#8356

X-original-commit: e4057858a1
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
Signed-off-by: Lara Martini (larm) <larm@odoo.com>
This commit is contained in:
Lara Martini (larm) 2024-02-22 09:59:37 -05:00 committed by Sam Lieber (sali)
parent c6e668630d
commit 727ecfc958
25 changed files with 229 additions and 133 deletions

View File

@ -946,15 +946,15 @@ Refer to the :doc:`../hr/recruitment/new_job` documentation for more details on
form.
.. seealso::
- :doc:`payroll/reporting`
- :doc:`payroll/contracts`
- :doc:`payroll/payslips`
- :doc:`payroll/work_entries`
- :doc:`payroll/reporting`
.. toctree::
:titlesonly:
payroll/reporting
payroll/contracts
payroll/payslips
payroll/work_entries
payroll/reporting

View File

@ -2,218 +2,314 @@
Reporting
=========
The :guilabel:`Reporting` section of the *Payroll* app offers a variety of reports to choose from.
The :guilabel:`Payroll`, :guilabel:`Meal Vouchers`, :guilabel:`Attachment of Salary`, and
:guilabel:`DMFA` reports are universal and available for all companies regardless of location. The
:guilabel:`Paid Time Off Allocation`, :guilabel:`273S Sheet`, and :guilabel:`274.XX Sheets` reports
are specific to Belgian companies only.
The *Reporting* section of the *Payroll* app offers a variety of reports to choose from, organized
by location.
To view a report, go to :menuselection:`Payroll --> Reporting` and click on the specific report.
The *Payroll* report, *Work Entry Analysis* report, and *Salary Attachment Report* are default
reports in the *Payroll* app, and are available for all companies, regardless of location.
Beneath the three default reports are all localization-based reports, organized by country, in
alphabetical order. These reports contain all the various information for the offered benefits and
local tax laws.
To view all the available reports for the database, including all the localization-specific ones,
navigate to :menuselection:`Payroll app --> Reporting` to view the available reports in a drop-down
menu. Click on a specific report to view it.
.. image:: reporting/reports.png
:align: center
:alt: Report dashboard view.
:alt: Report dashboard view showing extra reports for Belgium databases.
If a report is unavailable to a company, a user error pops up, stating `You must be logged in to a
Belgian company to use this feature.`
If a report is unavailable to a user, an :guilabel:`Invalid Operation` pop-up window appears,
stating: :guilabel:`You must be logged in to a (country) company to use this feature`, where
"(country)" is the specific country the company is configured for.
At the top of each report, click on :guilabel:`Filters` to display the optional filters for the
specific report. Filters show information that matches the specific filter parameters. For example,
when selecting the :guilabel:`Last 365 Day Payslip` filter, only payslips for the last 365 days
appear. All reports have the option to add a custom filter, and each have different default custom
filter options. Select the parameters, then click the :guilabel:`Apply` button.
.. image:: reporting/custom-filter.png
:align: center
:alt: Report dashboard view.
Clicking on :guilabel:`Favorites` displays three options: :guilabel:`Save the current search`,
:guilabel:`Add the search to the dashboard`, or :guilabel:`Insert the search to a Google
spreadsheet`.
.. image:: reporting/favorites.png
:align: center
:alt: Favorite options for reports.
Default reports
===============
Payroll
-------
Click on :menuselection:`Payroll --> Reporting --> Payroll` to display the :guilabel:`Payroll
Analysis` report.
Click on :menuselection:`Payroll app --> Reporting --> Payroll` to display the :guilabel:`Payroll
Analysis` report. This report shows all the payslips generated in the last 365 days, due to the
default :ref:`filter <payroll/filters>`: `Last 365 Days Payslip`.
.. image:: reporting/payroll-report.png
:align: center
:alt: Report dashboard view.
:alt: Payroll overview report showing payroll for the last 365 days.
This shows all the payslips generated in the last 365 days. The report can display metrics for a
variety of parameters. Click the :guilabel:`Measures` box to view a drop-down menu with the various
options to display. The options available include: :guilabel:`# Payslip`, :guilabel:`Basic Wage`,
:guilabel:`Basic Wage for Time Off`, :guilabel:`Days of Paid Time Off`, :guilabel:`Days of
Unforeseen Absence`, :guilabel:`Days of Unpaid Time Off`, :guilabel:`Gross Wage`, :guilabel:`Net
Wage`, :guilabel:`Number of Days`, :guilabel:`Number of Hours`, :guilabel:`Work Days`,
:guilabel:`Work Hours`, and :guilabel:`Count`.
The report can display metrics for a variety of parameters. Click the :guilabel:`Measures` box to
view a drop-down menu with the various metric options to display. The default options available
include:
- :guilabel:`# Payslip`
- :guilabel:`Basic Wage`
- :guilabel:`Basic Wage for Time Off`
- :guilabel:`Days of Paid Time Off`
- :guilabel:`Days of Unforeseen Absence`
- :guilabel:`Days of Unpaid Time Off`
- :guilabel:`Gross Wage`
- :guilabel:`Net Wage`
- :guilabel:`Number of Days`
- :guilabel:`Number of Hours`
- :guilabel:`Work Days`
- :guilabel:`Work Hours`
- :guilabel:`Count`
:guilabel:`Net Wage` is the default metric for the :guilabel:`Payroll` report.
.. image:: reporting/measures.png
:align: center
:alt: Report dashboard view.
:alt: The various measures available to display for the Payroll Analysis report.
Line chart
~~~~~~~~~~
A line chart is the default view for the *Payroll Analysis* report. If a different view was
selected, click on the :guilabel:`Line Chart` icon (middle icon) in the menu bar to change the view
back to a line chart. An option to display the line chart in ascending or descending order appears
at the end of the options.
A line chart is the default view for the *Payroll* report. If a different view is selected, click
the :guilabel:`Line Chart` button (represented by a :guilabel:`📈 (chart increasing)` icon) in the
menu bar to change the view back to a line chart.
Several options are available for the line chart. Click the corresponding button to activate the
selection, and change the way the data is presented. These icons appear at the end of the chart
options. The various options are:
.. _payroll/stacked:
- :guilabel:`Stacked`: data is presented with each metric in its own line, "stacked" on top of each
other. This helps visualize the distribution and variances between different categories.
.. _payroll/cumulative:
- :guilabel:`Cumulative`: data is presented with each metric on an individual line, with the total
amount calculated by combining all the lines. This provides a comprehensive view of the cumulative
data.
.. _payroll/descending:
- :guilabel:`Descending`: data is shown with the largest values on the left side of the chart,
gradually decreasing towards the smallest values on the right side, along the x-axis. This
arrangement helps emphasize trends or outliers at the extremes.
.. _payroll/ascending:
- :guilabel:`Ascending`: data is presented with the smallest values on the left side of the chart,
increasing towards the largest values on the right side, along the x-axis. This arrangement can be
useful for highlighting progressive growth or trends.
.. note::
These options can be combined to create a variety of views.
.. image:: reporting/line-chart.png
:align: center
:alt: Report dashboard view.
:alt: Menu buttons with the line chart called out, along with the other option buttons.
Bar chart
~~~~~~~~~
To display the data in a bar chart, click on the :guilabel:`Bar Chart` icon (first icon) in the menu
bar.
To display the data in a bar chart, click on the :guilabel:`Bar Chart` button (represented by a
:guilabel:`📊 (bar chart)` icon) in the menu bar.
Click the :ref:`Stacked <payroll/stacked>` icon to view the bar chart in a stacked format (where
multiple values appear in each column). :ref:`Cumulative <payroll/cumulative>` bar charts are useful
for visualizing the progression over time or other categories.
An option to display the columns in :ref:`Descending <payroll/descending>` or :ref:`Ascending
<payroll/ascending>` order appears at the end of the options.
.. image:: reporting/bar-chart.png
:align: center
:alt: Report dashboard view.
Click the :guilabel:`Stacked` icon to view the bar chart in a stacked format (where multiple values
appear in each column). An option to display the columns in ascending or descending order appears at
the end of the options.
:alt: Menu buttons with the bar chart called out, along with the other option buttons.
.. tip::
Clicking an option enables it. To disable the option, click it again. When the option is enabled
it appears grey. When it is inactive, it appears white.
Clicking an option enables it. To turn off the option, click it again. When the option is enabled
the icon appears lighter, with a turquoise outline. When it is inactive, it appears gray, with no
outline.
Pie chart
~~~~~~~~~
To display the data in a pie chart, click on the :guilabel:`Pie Chart` icon (last icon) in the menu
bar. There are no additional options available in this view.
To display the data in a pie chart, click on the :guilabel:`Pie Chart` button (represented by a
:guilabel:`(pie chart)` icon) in the menu bar. There are no additional options available in this
view.
.. image:: reporting/pie-chart.png
:align: center
:alt: Report dashboard view.
:alt: Menu buttons with the pie chart called out.
Pivot table
~~~~~~~~~~~
The bottom half of the :guilabel:`Payroll Analysis` dashboard presents a pivot table no matter which
type of chart is selected for the top of the dashboard. The default information displayed is the
number of payslips, net wage, gross wage, days of paid time off, and days of unpaid time off. The
information is divided by department. To display more information on the report, select the
:guilabel:`Measures` drop-down menu, then click on any other items to display.
To display the data in a pivot table, click on the :guilabel:`Pivot` button (represented by a
:guilabel:`(pivot)` icon) located in the far-right side of the top menu bar.
.. image:: reporting/measures-bottom.png
The default information displayed includes the number of payslips (:guilabel:`# Payslip`), the
:guilabel:`Net Wage`, the :guilabel:`Gross Wage`, the number of :guilabel:`Days of Paid Time Off`,
and the number of :guilabel:`Days of Unpaid Time Off`. The information is organized by department.
To display more information on the report, click the :guilabel:`Measures` button to reveal a
drop-down menu. Then, click on any other metric to display it on the pivot table.
.. image:: reporting/pivot.png
:align: center
:alt: Report dashboard view.
:alt: Pivot table view with the various metrics called out.
To sort the entries by a specific column, such as :guilabel:`Net Wage`, click on the column name
twice. The first click selects the column, and the second click sorts the information in descending
order.
.. image:: reporting/net-wage.png
To export the data in an XLSX format, click the :guilabel:`Download xlsx` button, represented by a
:guilabel:`⬇️ (down arrow above a horizontal bar)` icon, located at the far-right of the available
icons. The information is then downloaded into a spreadsheet.
.. image:: reporting/xlsx.png
:align: center
:alt: To sort information by descending order, click the column head twice.
:alt: The menu options with the download button highlighted.
To export the data in an XLSX format, click the :guilabel:`Download xlsx` icon. The information will
be downloaded into an Excel spreadsheet.
.. image:: reporting/export.png
:align: center
:alt: Download an Excel spreadsheet of the data by clicking the download button.
The data can be inserted into a spreadsheet by clicking the :guilabel:`Insert in Spreadsheet`
button. A pop-up appears asking which spreadsheet to place the information in. Select an existing
spreadsheet or enter the name for a new spreadsheet. Click the :guilabel:`Confirm` button to move to
a spreadsheet view with all the information populated.
Any report can be inserted into a spreadsheet by clicking the :guilabel:`Insert in Spreadsheet`
button. A :guilabel:`Select a spreadsheet to insert your (type of report)` pop-up window appears,
asking which spreadsheet to place the information in. Select an existing spreadsheet or dashboard,
or select a new :guilabel:`Blank spreadsheet`. Click the :guilabel:`Confirm` button to move to a
spreadsheet view with the report added to it.
.. image:: reporting/spreadsheet.png
:align: center
:alt: Send the data to a spreadsheet.
:alt: The view of data sent to a spreadsheet.
Once in the spreadsheet view, click on :guilabel:`File`, then select :guilabel:`Save` to save the
data, or :guilabel:`Save as Template` to save the setting as a template to use in the future.
.. _payroll/doc-storage:
.. note::
The *Documents* application must be installed in order to use the :guilabel:`Insert in
Spreadsheet` option.
If the *Documents* app is **not** installed, the :guilabel:`Insert in Spreadsheet` option places
the newly-created spreadsheet in the *Dashboards* app.
If the *Documents* application **is** installed, the spreadsheet has the option to be stored in
either the *Dashboards* app or *Documents* app.
Meal Vouchers
-------------
Work entry analysis
-------------------
:guilabel:`Meal Vouchers` provides an overview of the meal vouchers used by employees, and can be
shown by :guilabel:`Day`, :guilabel:`Week`, :guilabel:`Month`, :guilabel:`Quarter`, or
:guilabel:`Year`. The default view is by month.
The default :guilabel:`Work entry analysis` report provides an overview of the validated work
entries for the current month. To view this report, navigate to :menuselection:`Payroll app -->
Reporting --> Work Entry Analysis`.
.. image:: reporting/meal-vouchers.png
The work entries appear in a pivot table, with the default filters of `Current month: (Month)(Year)`
and `Validated`. The various types of :doc:`work_entries` are listed on the left-hand side (x-axis),
while the :guilabel:`Total` values appear along the top (the y-axis).
To change the displayed view, click the :guilabel:` (plus)` icon next to the word
:guilabel:`Total`, then click on one of the grouping options. The available options are
:guilabel:`Work Entry Type`, :guilabel:`Employee`, and :guilabel:`Department`. If in a multi-company
database, a :guilabel:`Company` option also appears.
To add a new group to sort the data, click :guilabel:`Add Custom Group`, then click one of the
presented options.
.. tip::
Wherever a :guilabel:` (plus)` icon appears on a pivot table, the information can be further
grouped. Click on a :guilabel:` (plus)` icon to reveal the available grouping options.
Click on a :guilabel:` (minus)` icon anywhere on the pivot table to remove that respective
grouping.
It is possible to compare the current :guilabel:`Work entry analysis` report to the previous month
or the previous year. To view these comparisons, click the :guilabel:`⬇️ (down arrow)` icon in the
search bar to reveal the various :ref:`filter <payroll/filters>` and grouping options.
In the section titled :guilabel:`Comparison`, click on either :guilabel:`Current Month: Previous
Period` or :guilabel:`Current Month: Previous Year`. The report updates and displays the previous
time period values, as well as the :guilabel:`Variation` between the two.
.. image:: reporting/work-entry-comparison.png
:align: center
:alt: Meal voucher
:alt: A pivot table comparing the work entries of the current month and the previous month.
To change the displayed view, click on :guilabel:`Total`. The data collapses, showing only the count
column. Click on :guilabel:`Total` again, then hover over :guilabel:`Day`, then click on one of the
other time-period options available.
To export the data in an XLSX format, click the :guilabel:`Download xlsx` button, represented by a
:guilabel:`⬇️ (down arrow above a horizontal bar)` icon, located at the far-right of the available
icons. The information is then downloaded into a spreadsheet.
.. image:: reporting/voucher-day.png
:align: center
:alt: Meal voucher
It is possible to compare the current meal voucher report to the one for the previous time period or
the previous year. To view these comparisons, click on the :guilabel:`Comparison` drop-down menu at
the top, then select either :guilabel:`Date: Previous Period` or :guilabel:`Date: Previous Year`.
.. image:: reporting/meal-comparison.png
:align: center
:alt: Meal voucher
To export the data in an XLSX format, click the :guilabel:`Download xlsx` icon. The information will
be downloaded into an Excel spreadsheet.
.. image:: reporting/voucher-download.png
:align: center
:alt: Download an Excel spreadsheet of the data by clicking the download button.
The data can be inserted into a spreadsheet by clicking the :guilabel:`Insert in Spreadsheet`
button. A pop-up appears asking which spreadsheet to place the information in. Select an existing
spreadsheet or enter the name for a new spreadsheet. Click the :guilabel:`Confirm` button to move to
a spreadsheet view with all the information populated.
Once in the spreadsheet view, click on :guilabel:`File`, then select :guilabel:`Save` to save the
data, or :guilabel:`Save as Template` to save the settings as a template to use in the future.
The data can also be inserted into a spreadsheet. Click the :guilabel:`Insert in Spreadsheet` button
and a :guilabel:`Select a spreadsheet to insert your (type of report)` pop-up window appears, asking
which spreadsheet to place the information in. Select an existing spreadsheet or dashboard, or
select a new :guilabel:`Blank spreadsheet`. Click the :guilabel:`Confirm` button to move to a
spreadsheet view with the report added to it.
.. note::
The *Documents* application must be installed in order to use the :guilabel:`Insert in
Spreadsheet` option.
The work entry analysis spreadsheet is :ref:`stored in the same locations <payroll/doc-storage>`
as a pivot table.
Attachment of Salary
--------------------
Salary attachment report
------------------------
The :guilabel:`Attachment of Salary` report shows all deductions or allocations per employee, such
as child support payments and wage garnishments.
The :guilabel:`Salary Attachment Report` shows all deductions or allocations per employee, such as
child support payments and wage garnishments. To view this report, navigate to
:menuselection:`Payroll app --> Reporting --> Salary Attachment Report`.
.. image:: reporting/attachment-of-salary.png
:align: center
:alt: View the Attachment of Salary report that shows all salary garnishments.
The employees are listed in the left-side column, while the different deductions are listed in the
top row, organized by month.
top row, organized by deduction and monthly individual payslips.
The report can be exported as a XLSX file, or inserted into a spreadsheet, using the corresponding
The report can be exported as an XLSX file, or inserted into a spreadsheet, using the corresponding
buttons at the top.
Clicking on the :guilabel:`Measures` button shows options for how the data is displayed.
Click the :guilabel:`Measures` button to reveal the options of what data can be displayed.
:guilabel:`Assignment of salary`, :guilabel:`Attachment of salary`, :guilabel:`Child support`, and
:guilabel:`Count`, can all be selected or deselected by clicking on the item. If an item has a check
mark, it is displayed.
:guilabel:`Count` can all be selected or deselected by clicking on the item. If an item has a
checkmark next to it, that information is displayed.
.. image:: reporting/attachment-measures.png
:align: center
:alt: Select the options that be displayed in the report.
:alt: Select the options to be displayed in the Salary Attachment Report.
The salary attachment report can be compared to the one for the previous time period or the previous
year. To view these comparisons, click on the on the :guilabel:`Comparison` drop-down menu at the
top, then select either :guilabel:`Payslip End Date: Previous Period` or :guilabel:`Payslip End
Date: Previous Year`.
The :guilabel:`Salary Attachment Report` can be compared to the report for the previous time period
or the previous year. To view these comparisons, click the :guilabel:`⬇️ (down arrow)` icon in the
search bar to reveal the various :ref:`filter <payroll/filters>` and grouping options.
In the section titled :guilabel:`Comparison`, click on either :guilabel:`Payslip End Date: Previous
Period` or :guilabel:`Payslip End Date: Previous Year`. The report updates and displays the
previous time period values, as well as the :guilabel:`Variation` between the two.
.. _payroll/filters:
Filters
=======
At the top of each report, the default filters are shown inside the :guilabel:`Search...` box.
Click the :guilabel:`⬇️ (down arrow)` icon in the search bar to display the available
:guilabel:`Filters`. Filters show information that match the specific filter parameters.
.. example::
The :guilabel:`Work Entries Analysis` report has two default filters, the `Current month:(Month)
(Year)` filter, and the `Validated` filter.
.. image:: reporting/custom-filter.png
:align: center
:alt: Filters enabled for the Work Entries Analysis report.
The :guilabel:`Payroll` report has only one default filter, the `Last 365 Days Payslip` filter.
The :guilabel:`Salary Attachment Report` has only one default filter, the `Payslip End Date:
(Year)` filter.
All reports can include custom filters, or group information, by different metrics (employee,
department, company, etc.).
Some reports have the option to compare the current report to the previous time period or year (a
:guilabel:`Comparison` option).
Click on a parameter to select it and activate it. The report is immediately updated with the new
parameters.
The updated report can be set as a *favorite* report, meaning the parameters are stored for quick
access in the future. To do that, click :guilabel:`Save the current search`, under the
:guilabel:`Favorites` section, located in the search bar drop-down mega menu of filter options.
Doing so reveals two options and a :guilabel:`Save` button.
To set the current report as the default configuration when the report is accessed, check the box
next to :guilabel:`Default filter`. If the current report should be accessible to everyone in the
database, check the box next to :guilabel:`Share`.
Finally, click :guilabel:`Save`, which saves the currently configured report. Then, it appears
beneath the :guilabel:`Favorites` in the search bar drop-down mega menu of filter options.

Binary file not shown.

Before

Width:  |  Height:  |  Size: 10 KiB

After

Width:  |  Height:  |  Size: 29 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 11 KiB

After

Width:  |  Height:  |  Size: 14 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 2.6 KiB

After

Width:  |  Height:  |  Size: 3.6 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 7.6 KiB

After

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 10 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 2.2 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 2.2 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 5.7 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 2.4 KiB

After

Width:  |  Height:  |  Size: 5.6 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 4.7 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 24 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 28 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 11 KiB

After

Width:  |  Height:  |  Size: 20 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 5.9 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 23 KiB

After

Width:  |  Height:  |  Size: 9.2 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 2.2 KiB

After

Width:  |  Height:  |  Size: 2.7 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 15 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 18 KiB

After

Width:  |  Height:  |  Size: 35 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 17 KiB

After

Width:  |  Height:  |  Size: 15 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 9.0 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.2 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 28 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.9 KiB