> ## Documentation Index
> Fetch the complete documentation index at: https://documentation.2cloudnine.com/llms.txt
> Use this file to discover all available pages before exploring further.
# QRG Calculate a single Payee within a Pay Batch
## Purpose
The purpose of this quick reference guide is to step through the process of calculating a single Payee
within a Pay Batch instead of using the Calculate on the entire Pay Batch. The intended audience for this
document is Standard Payroll Users.
The ability to calculate a single Payee is used mainly when adjustments have been made to a Payee’s Pay
Batch, such as Pay Transactions, Superannuation Withholding, PAYG Withholding, or other related
records, and therefore the Payee Pay Batch needs to be recalculated.
## Steps
### **Calculate a single Payee within a Pay Batch**
To Calculate a single Payee within a Pay Batch, the following steps should be completed. Please skip to
the next page if you already have the Pay Batch Manager UI open on your screen:
1. Click on the **App Launcher** icon (see Figure 1).
2. Go to the **Pay Batches** object by using the Search function (see Figure 2).
3. From the List View, select a Pay Batch with the status of Part Calculated suggesting that changes
have already been made to the records since the last calculation was performed, or, a status of
Calculated if there are changes that are yet to be applied to one of the Payee Pay Batches, which
will then change the status to Part Calculated, and click the **Launch** button (see Figure 3).
For newly created Payee Pay Batches, if the Status is Uncalculated and they have never
been Calculated before, the individual Part Calculate button will remain disabled.
Whereas if their Status is Uncalculated and they have been Calculated before, the
individual Part Calculate button will be enabled for these Payee Pay Batches, and the
Pay Batch status will be Part Calculated.
### **Calculate a single Payee’s Pay Batches via the Manual Adjustments screen**
1. Under the **Review** screen of the Pay Batch Manager, locate the Payee Pay Batch that requires
adjustments and/or recalculation, and click the action button at the end of the row (see Figure 4).
2. Click on the **Adjustments** option (see Figure 5).
3. From the **Manual Adjustments** screen, new Pay Transactions can be created if needed, and/or
existing Pay Transactions can be edited/deleted if required. If no manual changes are required,
please proceed to Step 7 (see Figure 6).
4. Click on the icon on the right-hand side and select **Calculate Payee** (see Figure 7).
5. The **Payee Pay Batch - Calculate** popup will automatically appear with a Status of Calculating,
and a confirmation message saying ‘Calculation process has started. Please wait.’ (see Figure 8).
6. Once the Calculation has been completed, the **Payee Pay Batch - Calculate** popup will display an
update of the Status to either Calculated or Calculate Failed, based on the successful completion
of the Calculation Process (see Figure 9).
7. Click on the **Ok** button.
If the Status changes to Calculate Failed, Users need to investigate the reason for the
Failed Calculation by reviewing the Calculation Failed tab and investigating any
debugs that were created (see Figure 10).
8. If the calculation was successful, the status of the Manual Adjustments screen will change to
Calculated (see Figure 11).
9. Click on the **Cancel** button to exit this Payee Pay Batch Adjustments screen.
10. Once all Payee Pay Batches have been Calculated successfully, the Status of the Pay Batch will change to Calculated, and the Pay Batch will be ready to Finalise (see Figure 12).
### **Calculate an Individual Payee Pay Batch via the Standard UI List**
1. Go to the **Review** navigation icon.
2. From the **All Employee**, **Uncalculated**, **Calculate Failed**, or **Calculated** tab, click the action
dropdown button at the end of the row for the **Payee Pay Batch** record that requires
recalculation (see Figure 13).
3. Select the **Calculate Payee** option. The Payee Pay Batch - Calculate page will be displayed to show the progress of the Calculation (see Figure 14).
Once the Calculation is complete the Payee Pay Batch - Calculate page will reflect the updated Status to
either Calculated or Calculate Failed based on the successful completion of the process (see Figure 15).
## Field Descriptions
| Field Name | Description |
| ---------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Main UI** | |
| Acknowledge Alerts | is used to accept alerts that appear as warnings but do not need any further action or updates to the records. |
| Tabs (All Employees, Uncalculated, Calculate Failed, Calculated, Leave, Payee, Assignment, Transaction, and Payee Pay Batch) | All Employees tab displays all the Payee Pay Batches in this Pay Batch.
Uncalculated tab displays only the Uncalculated Payee Pay Batches.
Calculate Failed tab displays only the Payee Pay Batches with a status of Failed.
Calculated tab displays only the Calculated Payee Pay Batches.
Leave tab will display all leave Transactions and Accruals.
Payee tab displays a list of warnings flagged for Payees to be reviewed.
Assignment tab displays a list of warnings flagged for Assignments to be reviewed.
Transaction tab displays a list of warnings flagged for Transactions to be reviewed.
Payee Pay Batch tab displays a list of warnings flagged for Payee Pay Batches to be reviewed. |
| Bulk Add | is used to add Payee Pay Batches or individual Pay Transactions that match the original filter of the Pay Batch creation to the Pay Batch. |
| Bulk Remove | is used to remove Payee Pay Batches from the Pay Batch in bulk. |
| Calculate (navigation icon) | click this navigation icon to view options related to Calculating the Pay Batch and the Part Calculate or Calculate All buttons. |
| Calendar Period | is the date range applicable for this Pay Batch. The Pay Batch may also contain Payee Pay batches relating to earlier Pay Calendar Periods if it was created with the ‘Include Earlier Periods’ checkbox selected. |
| Delete Pay Batch | this option can be used to permanently delete the Pay Batch. Using this option doesn’t delete any Payee data, but deletes only the PayBatch and any relationship with this Pay Batch on related records (ie. Pay Transactions, Leave Events, etc) so that a new Pay Batch can be created. |
| Finalise (navigation icon) | click this navigation icon to view and action various options related to finalising the Pay Batch. |
| Pay Advice Net | is the total net amount of related Pay Advices. |
| Pay Schedule | defines the Pay Schedule filter applied to the Pay Batch upon creation. |
| Payees | is the count of unique Payees from related Payee Pay Batch records. |
| Payroll Date | is the anticipated date that a Pay Batch will be finalised. |
| Payment Date | defines the Payment File Release Date. |
| Payment Entity | is the Payment Entity detailed on related Pay Advices, Payment Files, and STP Lodgements for this Pay Batch. Each Pay Batch is specific to only one Payment Entity. |
| Payment File Net | is the total net amount of related Payment Files. |
| Reporting (navigation icon) | click this navigation icon to generate a Variation Report for this Pay Batch to compare it to another Pay Batch. |
| Review (navigation icon) | click this navigation icon to view options related to reviewing the Pay Batch. |
| Total Gross | is the total gross earnings from all related Payee Pay Batch records. |
| Total Net | is the total net earnings from all related Payee Pay Batch records. |
| **Payee Pay Batch rows (under the action drop-down button next to Payee Pay Batch rows)** | |
| Adjustments | click this button to open the Adjustments screen for an individual Payee Pay Batch. |
| Calculate Payee | use this button to calculate the individual Payee Pay Batch. |
| Exclude from Payment File | use this button to exclude the total net amount associated with this Payee Pay Batch from the Payment File. This can be reversed at any time up until the Payment File is a status of Released. |
| Include in Payment File | use this button to include this Payee Pay Batch if previously ‘excluded from the Payment File’ back into the Payment File. |
| Remove Payee Pay Batch Record | use this button to delete the individual Payee Pay Batch record. |
| Reverse Payee Pay Batch | use this button to reverse all components of this Payee Pay Batch, to be processed in a new Pay Batch. |
| View Details | click this button to open the View Details Panel. |
| **Manual Adjustments Panel** | |
| Add Adjustments | click this button to manually add new Pay Transactions or delete/edit existing Pay Transactions. |
| Delete All Adjustments | click this button to delete all the Adjustment Pay Transactions created directly in the Pay Batch. |
| Calculate Payee | this button will Calculate the Payee Pay Batch that is currently open via the Manual Adjustments Panel. |
| Gross | displays the gross earnings from this Payee Pay Batch record. |
| Net | displays the net earnings from this Payee Pay Batch record. |
| Remove Payee Pay Batch Record | this button can be used to delete the current Payee Pay Batch record. |
| Payee Pay Batch | represents the unique identification number of the Payee Pay Batch. |
## Further Information
| Document | Document Type | Description |
| --------------------------------------------- | --------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| QRG Pay Batch Key Information | Information Quick Reference | Outlines useful information relevant to 2cloudnine Payroll’s Pay Batch functionality. The document includes definitions, prerequisites, diagrams, and other non-instructional information on how it facilitates efficient management of Pay Batches from Creation through Review, Calculation, and Finalisation. |
| QRG Create a New Pay Batch | Task Instructions | How to create a new Pay Batch through the Pay Batch Manager. |
| QRG Review a Pay Batch | Task Instructions | How to Review the Pay Batch on a Pay Batch level and an individual Payee Pay Batch level, as well as the steps required to use the Remove Pay Transaction, Remove Individual Payee Pay Batch records, Bulk Remove, Bulk Add, and Manual Adjustment functionalities within the Pay Batch Manager. |
| QRG Calculate a Pay Batch | Task Instructions | How to Calculate a Pay Batch as well as the steps to View and Resolve / Acknowledge Flags through the Pay Batch Manager. |
| QRG Finalise a Pay Batch | Task Instructions | How to Finalise a Pay Batch, Unfinalise a Pay Batch, Create and Distribute Pay Advice documents, and Create and Release Payment Files through the Pay Batch Manager. |
| QRG View Leave Accruals via Pay Batch Manager | Task Instructions | How to view Automatic Leave Accruals using Pay Batch Manager. |
| QRG Reverse Payee Pay Batch | Task Instructions | How to Reverse a Payee Pay Batch within the Pay Batch Manager. |
| QRG Exclude from Payment File | Task Instructions | How to Exclude a Payee Pay Batch from the Payment File. |
| QRG Create a Variance Report | Task Instructions | How to create a Variance Report within the Pay Batch Manager. |