diff --git a/content/applications/hr/payroll.rst b/content/applications/hr/payroll.rst index 34680598b..90172798c 100644 --- a/content/applications/hr/payroll.rst +++ b/content/applications/hr/payroll.rst @@ -964,6 +964,7 @@ form. - :doc:`payroll/work_entries` - :doc:`payroll/reporting` - :doc:`payroll/work_entry_analysis` + - :doc:`payroll/salary_attachment` .. toctree:: :titlesonly: @@ -973,3 +974,4 @@ form. payroll/payslips payroll/reporting payroll/work_entry_analysis + payroll/salary_attachment diff --git a/content/applications/hr/payroll/reporting.rst b/content/applications/hr/payroll/reporting.rst index a85f4175a..43771fde2 100644 --- a/content/applications/hr/payroll/reporting.rst +++ b/content/applications/hr/payroll/reporting.rst @@ -184,40 +184,6 @@ spreadsheet view with the report added to it. If the **Documents** application *is* installed, the spreadsheet has the option to be stored in either the **Dashboards** app or **Documents** app. -Salary attachment report ------------------------- - -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 deduction and monthly individual payslips. - -The report can be exported as an XLSX file, or inserted into a spreadsheet, using the corresponding -buttons at the top. - -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 -checkmark next to it, that information is displayed. - -.. image:: reporting/attachment-measures.png - :align: center - :alt: Select the options to be displayed in the Salary Attachment Report. - -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 ` 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 diff --git a/content/applications/hr/payroll/reporting/attachment-measures.png b/content/applications/hr/payroll/reporting/attachment-measures.png deleted file mode 100644 index 0c403d5dd..000000000 Binary files a/content/applications/hr/payroll/reporting/attachment-measures.png and /dev/null differ diff --git a/content/applications/hr/payroll/reporting/attachment-of-salary.png b/content/applications/hr/payroll/reporting/attachment-of-salary.png deleted file mode 100644 index add93e5c2..000000000 Binary files a/content/applications/hr/payroll/reporting/attachment-of-salary.png and /dev/null differ diff --git a/content/applications/hr/payroll/salary_attachment.rst b/content/applications/hr/payroll/salary_attachment.rst new file mode 100644 index 000000000..a00f6d1b4 --- /dev/null +++ b/content/applications/hr/payroll/salary_attachment.rst @@ -0,0 +1,63 @@ +======================== +Salary attachment report +======================== + +*Salary attachments* in Odoo refer to a portion of an employee's earnings that are designated for +a specific purpose, both voluntary and involuntary. These can include contributions to a retirement +plan, repayment of a loan, wage garnishments, or child support. + +Voluntary salary attachments, such as repaying a loan, or contributing to a charity on a monthly +basis, are considered *Assignments of Salary* in Odoo. Salary attachments that are required, such as +a lawsuit settlement repayment, or repaying a tax lien, are considered *Attachments of Salary* in +Odoo. Child support payments have their own category, and are simply referred to as *Child Support* +in Odoo. + +To view this report, navigate to :menuselection:`Payroll app --> Reporting --> Salary Attachment +Report`. The :guilabel:`Salary Attachment Report` shows all deductions or allocations per employee, +organized by payslip, in a default pivot table. The default filter is the end of the current year +(:guilabel:`Payslip End Date: (year)`). The employees populate the rows, while the various +deductions populate the columns, organized by type of deduction, and further grouped by individual +payslip. + +The default report contains **all** payslips for the current year, so the report typically contains +a large number of columns. This could make it difficult to view all the data at once, as the report +may be very wide and require scrolling to view all the data. + +To view a condensed version of salary attachments, and have all the salary attachment columns +visible on one page, click the :icon:`fa-minus-square-o` :guilabel:`Total` icon at the top of the +report, above the various payslips. + +This presents the salary attachments for the current year, and only displays three columns, +:guilabel:`Attachment of Salary`, :guilabel:`Assignment of Salary`, and :guilabel:`Child Support.` + +Each entry displays the total amount paid for each specific type of salary attachment, for each +employee. + +.. image:: salary_attachment/salary-attachment.png + :alt: The Attachment of Salary report that shows all salary garnishments in a condensed view. + +The report can be downloaded as an XLSX file, or :doc:`inserted into a spreadsheet +<../../productivity/spreadsheet/insert>` using the corresponding buttons at the top. + +Click the :guilabel:`Measures` button to reveal the options of what data is displayed. +:guilabel:`Assignment of salary`, :guilabel:`Attachment of salary`, and :guilabel:`Child support` +are all selected and visible, by default, while the :guilabel:`Count` option is not. + +Click an option to either show or hide that particular metric. A :icon:`fa-check` +:guilabel:`(checkmark)` icon indicates the data is visible. + +Compare to 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 :icon:`fa-caret-down` :guilabel:`(down arrow)` icon in the +search bar, then click either :guilabel:`Payslip End Date: Previous Period` or :guilabel:`Payslip +End Date: Previous Year`, beneath the :icon:`fa-adjust` :guilabel:`Comparison` column. + +The report updates and displays the current time period values, and the previous time period values, +as well as the :guilabel:`Variation` between the two, in a percentage. + +.. image:: salary_attachment/comparison-attachment.png + :alt: The salary attachment report modified to compare to the previous year. diff --git a/content/applications/hr/payroll/salary_attachment/comparison-attachment.png b/content/applications/hr/payroll/salary_attachment/comparison-attachment.png new file mode 100644 index 000000000..d43e8d944 Binary files /dev/null and b/content/applications/hr/payroll/salary_attachment/comparison-attachment.png differ diff --git a/content/applications/hr/payroll/salary_attachment/salary-attachment.png b/content/applications/hr/payroll/salary_attachment/salary-attachment.png new file mode 100644 index 000000000..cd6106c3e Binary files /dev/null and b/content/applications/hr/payroll/salary_attachment/salary-attachment.png differ