Data Input Requirements for Third-Party Paysheet Data
When you use the Load Paysheet Transactions COBOL SQL process (PSPPSHUP) to load paysheet entries from the record PSHUP_TXN with a paysheet update source code (PU_SOURCE) of OT (other sources) or your own custom third-party source code O%, the following transaction types are supported:
C - Canadian tax override
D - deduction override (benefit/general deduction overrides; excludes garnishments)
E - earnings
S - garnishment override
T - U.S. tax override
G - total gross
N - net pay
The Load Paysheet Transactions process bypasses paysheet transactions for inactive employees.
The paysheet load holding record (PSHUP_TXN) must contain valid transactions that do not result in payroll error messages. For example, when a manual check is loaded with a paysheet update source of Other Sources, transactions for the related total gross and net pay transaction types must also be provided as follows:
A total gross transaction for each manual check when the total gross is not zero.
A net pay transaction for each manual check when the net pay is not zero.
The following table provides the data input requirements for a paysheet update source of OT or your own custom O% source code. The table includes requirements for each of the supported transaction types. Failure to follow the recommended setup may result in unpredictable pay data.
Field Name |
CAN Taxes |
Deductions |
Earnings |
Garnish-ment Override |
U.S. Taxes |
Total Gross |
Net Pay |
---|---|---|---|---|---|---|---|
PU_SOURCE |
OT or custom O% code. |
||||||
CREATION_DT |
A valid date |
||||||
COMPANY |
A valid company code |
||||||
PAYGROUP |
A valid pay group |
||||||
PAY_END_DT |
Null |
||||||
OFF_CYCLE |
N for on-cycle Y for off-cycle |
||||||
EARNS_BEGIN_DT |
Null |
Null |
A valid date or Null to let system set the date. |
Null |
Null |
Null |
Null |
EARNS_END_DT |
Null |
Null |
A valid date or Null to let system set the date. |
Null |
Null |
Null |
Null |
EMPLID |
A valid employee ID |
||||||
EMPL_RCD |
A valid employee record # for the employee ID |
||||||
SEQNO |
A unique sequence number for the combination of: PU_SOURCE, CREATION_DT, COMPANY, PAYGROUP, OFF_CYCLE, EMPLID, EMPL_RCD |
||||||
PU_TXN_TYPE |
C |
D |
E |
S |
T |
G Note: Use this transaction type only for manual check, to populate Gross Pay field. |
N Note: Use this transaction type only for manual check, to populate Net Pay field. |
PU_TXN_STATUS |
A |
||||||
PAGE_NUM |
0 (zero) |
||||||
LINE_NUM |
0 (zero) |
||||||
ADDL_NBR |
0 (zero) |
||||||
SEPCHK |
0 through 99 |
||||||
DEPTID |
blank |
||||||
JOBCODE |
blank |
||||||
POSITION_NBR |
blank |
||||||
ACCT_CD |
blank |
||||||
GL_PAY_TYPE |
blank |
||||||
PU_DISTRIBUTE |
blank |
||||||
ERNCD |
blank |
blank |
A valid earnings code |
blank |
blank |
blank |
blank |
ADDL_PAY_SHIFT |
N |
N |
A valid shift code: J (use job) N (not applicable) 1 (shift 1) 2 (shift 2) 3 (shift 3) |
N |
N |
N |
N |
ADDL_SEQ |
0 (zero) |
||||||
ADDLPAY_REASON |
blank |
||||||
OTH_HRS |
0 (zero) |
0 (zero) |
greater than, equal to, or lesser than 0 (zero) |
0 (zero) |
0 (zero) |
0 (zero) |
0 (zero) |
HOURLY_RT |
0 (zero) |
0 (zero) |
0 (zero) |
0 (zero) |
0 (zero) |
0 (zero) |
0 (zero) |
OK_TO_PAY |
Y sets pay line to OK to Pay. N sets pay line to Not OK to Pay. Blank sets OK to Pay for pay line based on PSPPSHUP process run control. |
||||||
DISABLE_DIR_DEP |
N |
||||||
STATE |
blank |
blank |
blank |
blank |
A valid state code for the employee. The state code must exist in employee's tax data. |
blank |
blank |
LOCALITY |
blank |
blank |
blank |
blank |
A valid locality code for the employee. The locality code must exist in the employee's tax data for the state specified in this record. |
blank |
blank |
TAX_PERIODS |
0 (zero) Note: The value is set by the PSPPSHUP process. |
0 (zero) Note: The value is set by the PSPPSHUP process. |
A valid tax period or 0 (zero) to use the default. |
0 (zero) Note: The value is set by the PSPPSHUP process. |
0 (zero) Note: The value is set by the PSPPSHUP process. |
A valid tax period or 0 (zero) to use the default. |
A valid tax period or 0 (zero) to use the default. |
TAX_METHOD |
blank Note: The value is set by the PSPPSHUP process. |
blank Note: The value is set by the PSPPSHUP process. |
A valid tax method or blank to use the default. |
blank Note: The value is set by the PSPPSHUP process. |
blank Note: The value is set by the PSPPSHUP process. |
A valid tax method or blank to use the default. |
A valid tax method or blank to use the default. |
DED_TAKEN |
Blank or R (no override) for no benefit deduction overrides. Otherwise, one of these benefit deduction override codes: D (deduction) S (subset) N (None) R (No Override) |
||||||
DED_SUBSET_ID |
A valid subset ID, if the DED_TAKEN value is S |
||||||
DED_TAKEN_GENL |
Blank or R (no override) for no general deduction overrides. Otherwise, one of these benefit deduction override codes: D (deduction) S (subset) N (None) R (No Override) |
||||||
DED_SUBSET_GENL |
A valid subset ID, if the DED_TAKEN_GENL value is S |
||||||
BUSINESS_UNIT |
blank |
||||||
COMP_RATECD |
blank |
||||||
TAX_CLASS |
blank |
blank |
blank |
blank |
A valid U.S. tax class. |
blank |
blank |
ONE_TIME_CD |
A valid one-time code: A (addition) O (override) P (arrears payback) R (refund) |
A valid one-time code: A (addition) O (override) P (arrears payback) R (refund) |
blank |
blank |
A valid one-time code: A (addition) O (override) P (arrears payback) R (refund) |
blank |
blank |
CTX_CLASS |
A valid Canadian tax class. |
blank |
blank |
blank |
blank |
blank |
blank |
PLAN_TYPE |
blank |
A valid plan type |
blank |
blank |
blank |
blank |
blank |
BENEFIT_PLAN |
blank |
A valid benefit plan |
blank |
blank |
blank |
blank |
blank |
DEDCD |
blank |
A valid deduction code |
blank |
A valid deduction code |
blank |
blank |
blank |
DED_CLASS |
blank |
A valid deduction class for the deduction code |
blank |
A valid deduction class for the deduction code |
blank |
blank |
blank |
DED_CALC |
blank |
A valid deduction calculation routine |
blank |
A valid deduction calculation routine |
blank |
blank |
blank |
DED_RATE_PCT |
0 (zero) |
0 (zero) or a position rate/percent |
0 (zero) |
0 (zero) or a position rate/percent |
0 (zero) |
0 (zero) |
0 (zero) |
PU_AMT |
An amount greater than zero that represents the Canadian tax additional amount, Canadian tax arrears payback amount, Canadian tax override or refund. |
0 (zero) or an amount greater than zero that represents one-time deduction override amount. |
A non-zero amount, negative or positive. |
blank |
An amount greater than zero that represents the U.S. tax additional amount, U.S. tax arrears payback amount, U.S. tax override or refund. |
A non-zero amount Note: The amount in this field is used to populate the Total Gross field for the manual check. |
A non-zero amount Note: The amount in this field is used to populate the Net Pay field for the manual check. |
MANUAL_CHECK |
Do not leave blank. N Y when loading transactions from paycheck generated outside of Payroll for North America |
||||||
PAYCHECK_NBR |
0 (zero) if MANUAL_CHECK = N A manual check paycheck number greater than zero if MANUAL_CHECK = Y |
||||||
DED_SLSTX_CLASS |
blank |
A valid sales tax type for Canadian deductions. B (none) for non-Canadian deductions. |
blank |
blank |
blank |
blank |
blank |
EX_DOC_ID |
blank |
||||||
EX_DOC_TYPE |
blank |
||||||
EX_LINE_NBR |
0 (zero) |
||||||
CURRENCY_CD |
Blank to use default currency code from pay group. Note: If entered, it does not affect the currency in which the employee is paid. |
||||||
OVERRIDE_ONLY |
Y |
||||||
GROSSUP |
N |
N |
Y or N Note: N for manual check. |
N |
N |
N |
N |
VC_PLAN_ID |
blank |
||||||
VC_PAYOUT_PRD_ID |
blank |
||||||
GB_GROUP_ID |
blank |
||||||
APPLID |
blank |
||||||
AWARD_DATE |
Null |
||||||
EIM_KEY |
blank |
||||||
PAYOUT_DT |
Null or a valid date that is equal to or less than the check date of the pay calendar being processed. |
||||||
GARNID |
blank |
blank |
blank |
The garnishment ID that is to be overridden. |
blank |
blank |
blank |
GARN_ONE_TIME_CD |
blank |
blank |
blank |
A valid one-time garnishment override code: O (override) R (refund) S (suspend) |
blank |
blank |
blank |
GARN_PRIORITY |
blank |
blank |
blank |
Null or a valid priority number |
blank |
blank |
blank |
GARN_DED_CALC |
blank |
blank |
blank |
The code for a valid garnishment calculation routine: G (> %DE/Amt) H (> %Grs/Amt) M (Maximum) P (%DE + Amt) R (%Grs + Amt) S (X-%DE/Amt) T (X-Pct Grs) |
blank |
blank |
blank |
GARN_DED_PCT |
blank |
blank |
blank |
The percent of disposable earnings to use in the override calculation |
blank |
blank |
blank |
GARN_DED_AMT |
blank |
blank |
blank |
A flat amount to use in the override calculation |
blank |
blank |
blank |
CMPNY_FEE_PCT |
blank |
blank |
blank |
The percentage to use when calculating the company processing fee |
blank |
blank |
blank |
CMPNY_FEE_AMT |
blank |
blank |
blank |
The flat amount to use when calculating the company processing fee |
blank |
blank |
blank |
PAYEE_FEE_PCT |
blank |
blank |
blank |
The percentage to use when calculating the processing fee paid to the payee. |
blank |
blank |
blank |
PAYEE_FEE_AMT |
blank |
blank |
blank |
The flat amount to use when calculating the processing fee paid to the payee. |
blank |
blank |
blank |
PY_GARN_EXEMPT |
blank |
blank |
blank |
N to garnish only earnings above allowable exemptions. Y to garnish all of the earnings Note: Enter a value only for U.S. garnishment overrides. |
blank |
blank |
blank |
CHECK_DT |
The check date, if MANUAL_CHECK is set to Y. Otherwise, leave this blank. |
||||||
PU_TXN_MANUAL_CHG |
N |