!!!DEFINE PAYROLLS
__Payrolls__ may be created and maintained in the Define Payrolls (IPPR) form. Payrolls define the pay frequency for various groups of employees. Separate Payrolls are defined for each pay frequency in which a group of employees are paid. This means that employees who are paid at different times will have separate payroll codes. E.G. employees paid every week; employees paid every two weeks. Employees who have the same pay frequency, pay dates, and payroll bank will belong to the same payroll and have the same payroll code.

An employee can be on only one payroll code per ‘Employment Type’. Employment type is defined for each employee on the [IEHR] (Establish Personnel Profiles) form. Examples of employment types would be ‘Employee’, ‘Contractor’ or ‘Retiree’.

Each Payroll Code will need to be defined in full detail. 

You may access this feature under the Screen/Form menu:
__Payroll > Setup and Definitions > Define Payrolls__

__‘Define Payroll Information’ Usage and Examples__
Payroll Information data is stored in the [P2K_PR_PAYROLLS] table.
;[Entity|ENTITY_CODE]:This field displays the entity for which the payroll is defined. Entity_Code from [P2K_CM_ENTITIES] is a mandatory 16-character alphanumeric field that you must manually enter or use the LOV (F9) to choose an option.
;[Payroll|PAYROLL_CODE]:This field holds a user-defined code that uniquely identifies the payroll within the organization. Payroll_Code is a 16-character alphanumeric mandatory field that you must manually enter.
;[Description|DESCRIPTION]:This field gives a short description of the payroll code. Description is an optional 50-character alphanumeric field that you may manually enter.
----
!!Define Payrolls (IPPR) - Payroll
;[Legislation|LEGISLATION]:This code indicates the primary country whose legislation governs the organization. Legislation is a mandatory fixed lexicon ([X_LEGISLATION]) that you may use to look up the value.
;[Pay Point Set|PAY_POINT_SET_CODE]:The pay point set is a set of payroll calculation instructions to be executed for this payroll during the pay cycle. Pay_Point_Set_Code from [P2K_PR_PAY_POINT_SETS] is a 16-character mandatory field that you must complete with a value from the LOV (F9) provided. These pay point sets are defined in the [IPPP] screen.
;[Pay Calendar|PAY_CALENDAR_CODE]:This field defines which calendar is to be used for this payroll. E.G. Pay Period dates, Pay Issue dates, etc. Pay_Calendar_Code from [P2K_PR_PAY_CALENDARS] is a mandatory 16- character field that you must complete with a value from the LOV (F9) provided. These values are defined in the [IPCL] screen.
;[Additional Tax Option|ADDITIONAL_TAX_OPTION]:This field is used when an employee opts to pay additional tax per pay period. You may specify one of the following:
*Always - Additional tax is always taken, regardless if the employee has tax withheld
*Only If Available - Additional tax is taken only if the employee has income tax removed.
;:Additional_Tax_Option is an optional fixed lexicon ([X_ADDITIONAL_TAX_OPTION]) that you may use to look up the value.

;[MTD Summary|MONTHLY_SUMMARIES]: MTD Summary is the month to date summary toggle. If the MTD Summary toggle is checked, the pay close process ([UPCLOZ]) will create and store month-to-date totals. If the MTD Summary toggle is not checked, no month-to-date totals will be kept. Monthly_Summaries is an optional toggle field.

;:For Canadian Installations: MTD totals are required in order to store month-to-date totals required for the Canada Custom Revenue Agency (CCRA). All Canadian clients must keep Mtd information in order to retrieve the monthly information needed to do monthly remittance on the [RPYEC] report.
;[QTD Summary|QUARTERLY_SUMMARIES]:QTD Summary is the quarter to date summary toggle.If the QTD Summary toggle is checked, the pay close process ([UPCLOZ]) will create and store quarter-to-date totals. If the QTD Summary toggle is not checked, no quarter-to-date totals will be kept.
;:__For U.S. installations__: Quarter-to-date totals are __mandatory__.

;:__For Canadian Installations__: Quarter-to-date totals are __optional__.

;:Quarterly_Summaries is an optional toggle field.
;[Fiscal Summary|FISCAL_SUMMARIES]: If the ‘Fiscal Summaries’ toggle is checked, the pay close process ([UPCLOZ]) will create and store fiscal-to-date totals. 
;:If the ‘Fiscal Summaries’ toggle is not checked, no fiscal-to-date totals will be kept.

;:If the fiscal year runs for a different 12-month period (e.g. April to March), or is based on a 13 period year, High Line recommends that separate fiscal totals be kept from the year-to-date totals. 

;:Fiscal_Summaries is an optional toggle field.
;[Tax Exempt Point|TAX_EXEMPT_POINT]: __For Canadian Installations Only.__
;:This field indicates the minimum, midpoint or maximum of the TD1 claim code range amount that should be used when calculating taxes. The process for how the employee’s tax exemption should be calculated is based on the governmental tax tables. These toggles should be adjusted if, during payroll testing, users find that the taxation amounts are slightly off.
*Minimum
*Mid Point (default)
*Maximum

;:Tax_Exempt_Point is a mandatory fixed lexicon ([X_TAX_EXEMPT_POINT]).
;[Account for Checks|PBA_ID_CHECK]:This field indicates the bank account from which the funds are withdrawn for check payments. Bank_Account from [P2K_PR_PAYROLL_BANK_ACCOUNTS] is an optional 30-character alphanumeric field that you may manually enter or use the LOV (F9) to choose an option.
;[Account for Deposits|PBA_ID_DEPOSIT]:This field displays the bank account from which the funds are withdrawn for deposit payments. Bank_Account from [P2K_PR_PAYROLL_BANK_ACCOUNTS] is an optional 30-character alphanumeric field that you may manually enter or use the LOV (F9) to choose an option.
;[Bank Name|BANK_NAME]:This field identifies the bank where the account for checks is held. Bank Name will default based on the Account for checks chosen from [IPBA], needs to be added.
;[Bank Name|BANK_NAME]:This field identifies the bank where the account for deposits is held. Bank Name will default based on the Account for deposits chosen from [IPBA], needs to be added.
;[Detailed Pay Stub|DETAILED_PAY_STUB]:If the Detailed Pay Stub toggle is checked, the hours and rate associated to the earnings are stored for printing on the check stub and/or deposit notices. If the toggle is not checked, then these details are not retained and only the earnings may be accessed. Detailed_Pay_Stub is an optional toggle field.
;[Earnings Element|PEL_ID_EARNINGS]:All current and year-to-date earnings that are to appear on the stubs and/or notices need to be indicated in this [element|PAY ELEMENTS]. The Gross [Pay element|PAY ELEMENTS] may be used.
;[Deductions Element|PEL_ID_DEDUCTIONS]: All current and year-to-date employee deductions that are to appear on the stubs and/or notices need to be indicated in this [element|PAY ELEMENTS]. The Total Deductions [pay element|PAY ELEMENTS] may be used.
;[Benefits Elements|PEL_ID_BENEFITS]: All current and year-to-date employee contributions that are to appear on the stubs and/or notices need to be indicated in this [element|PAY ELEMENTS].
;[Other Elements|PEL_ID_OTHER]:Any other current [pay component|PAY COMPONENTS] amounts that are to appear on the stubs and/or notices may be indicated in this [element|PAY ELEMENTS].
;[Max. Gross|MAXIMUM_GROSS]:If a maximum gross is entered in this field, a warning will be issued in the payroll exception report when an employee’s gross exceeds this amount. Maximum_Gross is an optional 18 digit numeric field that you must manually enter.
;[Max. Net|MAXIMUM_NET]:If a maximum net is entered in this field, a warning will be issued in the payroll exception report when an employee’s net exceeds this amount. Maximum_Net is an optional 18 digit numeric field that you must manually enter.

;:__Maximum gross and net do not affect how an employee’s pay is calculated.__
;[Min. Net|MINIMUM_NET]:If a minimum net is entered in this field, a warning will be issued in the payroll exception report when an employee’s net is below this amount. 

;:__The employee’s net pay will be adjusted to this amount. This may mean that one or more deductions will not be taken.__

;:Minimum_Net is an optional 18 digit numeric field that you must manually enter.
;[Starting Check #|STARTING_NUMBER]:This field displays the first check number in the series. Starting_Number is a mandatory 10 digit numeric field that you may either manually enter or select from the LOV.
;[Ending|ENDING_NUMBER]:This field displays the last check number in the series. The information in this screen is for display only. The values are defined in the [IPBA] form and may not be edited directly in this screen. Ending_Number is for display only.
;[Last Used|LAST_NUMBER_USED]:This field displays the last check number issued for this account. The information in this screen is for display only. The values are defined in the [IPBA] form and may not be edited directly in this screen. Last_Number_Used is for display only.
\\
----
!!Define Payrolls (IPPR) - Batch Elements
The Batch Element tab will allow you to set up a list of the elements used to balance the batch.
;[Element|ELEMENT_CODE]:The batch elements are lists of pay components that need to be used to balance ‘Actuals’ from the pay header transaction lines against ‘Givens’ that you may supply in the batch. Element_Code from [P2K_PR_ELEMENTS] is an optional field that you may manually enter or use the LOV (F9) to choose an option.
;[Description|DESCRIPTION]:This field provides a short description of the batch element. Description is an optional 50-character alphanumeric field that will default from the element code.

The sort order of batch balancing elements on the Transaction Audit Report ([UPAUDT]) is based on the “Element Description” from Pay Elements ([IPPE]), not the Pay Element code.