ResetPaymentsFullOrPaymentMethod

Reset Payments - Full or by Payment Method

Minor Business Rule

Object Name: N0700042

Parent DLL: CPAY

Location: Client/Server

Language: NER

Functional Description

Purpose
This NER is used to reset all payment records either for a given Payroll ID , by payment method, or
for a given Payment Distribution record.

Setup Notes and Prerequisites
This NER requires that a Pre-Payroll has been run and payments have been created for employees.  This
NER is called as a row exit from Work With Payroll Workbench as well as the Work With Payment
Distribution Review form.

Special Logic

Technical Specification
Parameters

Data Item  Description           I/O  Req.Table Notes
PAYD       Payroll ID            I    YThis is required to process any type of
reset.
PMET       Payment Method        I    NRequired if resetting one specific group
of payments.
CKCN       Check Control Number  I    NRequired if resetting one particular dist.
record.
SCKC       Subsequent Chk Number I    N         Required if resetting one particular dist.
record.
EV01       Return Code           O    NThis return code are used for errors.

Related Tables/Business Views

Table     Table Description
F07210    Payroll Cycle Parameters File
F07350    Payment File
F07351    Payment Distribution File
F07352    Stub Information File

Processing

1.0Get Audit Information
2.0If the Payment Method is equal to blank or null (i.e. FULL PAYMENT RESET))

2.1Select all records in the F07350 for the Payroll ID
2.2Retrieve the Check Control Number for each of these records
2.3Select all records in the F07351 by the Check Control Number retrieved from the F07350.

2.3.1Update the Payment Number (DOCM) and Attachment Status Flag (ATTS) in the F07351.
2.4Select all records in the F07352 by the Check Control Number retrieved from the F07350.
2.4.1Update the Stub Overflow Line (SOVR) in the F07352.
3.0If the Check Control Number is not equal to Zero (i.e. PAYMENT DISTRIBUTION RESET)
3.1Select and retrieve the record from the F07351 based on the Check Control Number and
Subsequent Check Control Number
3.2If the Detail Stub Information Flag (DSIF) is equal to '1' select F07352 records for the
Check Control Number retrieved from the F07351
3.3Update the Stub Overflow Line (SOVR) in the F07352.
3.4Update the Payment Number (DOCM) and Attachment Status Flag (ATTS) in the F07351.
4.0If the Check Control Number is equal to Zero and Payment Method was passed (i.e. RESET ALL
PAYMENTS MATCHING PAYMENT METHOD PASSED)
4.1Select all records in the F07350 for the Payroll ID
4.2Retrieve the Check Control Number for each of these records
4.3Select all records in the F07351 by the Check Control Number retrieved from the F07350 and
by the payment method that was passed into the function.
4.3.1Select all the records in the F07352 and update the Stub Overflow Line (SOVR) only
if the Detail Stub Information Flag is equal to a '1' for the record selected in the
F07351.
4.3.2Update the Payment Number (DOCM) and Attachment Status Flag (ATTS) in the F07351.
5.0    Fetch and retrieve the Status flags from the F07210 for the Payroll ID.
5.1If the Payment Method is equal to a 'C' then blank out and update the Check Status and Check
Attachment Status flags but don't change Advice releated flags in the F07210.
5.2If the Payment Method is equal to a 'A' then blank out and update the Advice Status, Auto
Deposit File Status, and Advice Attachment Status flags but don't change the Check related flags
in the F07210.

Data Structure

D0700042 - Reset Payments - Full or by Payment Method

Parameter Name Data Item Data Type Req/Opt I/O/Both

szPayrollID PAYD char OPT NONE

A code that identifies a group of employees for whom you are processing payroll. Use this ID to process each step of the payroll
cycle. This code is also used to identify the interim ID that you select when you enter interim payments.

cPaymentMethod PMET char OPT NONE

The type of payment. Valid types of payments are:    A Auto Deposit    C Check

mnFromCheckControlNumber CKCN MATH_NUMERIC OPT NONE

A number used to group all payroll transactions for each payment or individual interim payment. This number is carried into the accounting
journal entries and facilitates the update of the actual check number after payment printing is complete. This number is also used for
automatically voiding payments. The payment work table contains both the actual check number and the check control number. All associated
payment transactions are automatically reversed using the check control number. This is not the actual check number.

mnThruCheckControlNumber CKCN MATH_NUMERIC OPT NONE

A number used to group all payroll transactions for each payment or individual interim payment. This number is carried into the accounting
journal entries and facilitates the update of the actual check number after payment printing is complete. This number is also used for
automatically voiding payments. The payment work table contains both the actual check number and the check control number. All associated
payment transactions are automatically reversed using the check control number. This is not the actual check number.

mnSubCheckControlNo SCKC MATH_NUMERIC OPT NONE

The number that identifies the separate auto deposit transactions. This number is for paychecks with multiple auto deposit instructions.

cResetRegularPaymentsOnly EV01 char OPT NONE

An option that specifies the type of processing for an event.

mnFromCheckNumber DOCM MATH_NUMERIC OPT NONE

The number of the matching document, such as a receipt, payment, adjustment,or credit. You apply a matching document (DOCM) against
an original document (DOC), such as an invoice or voucher.

mnThruCheckNumber DOCM MATH_NUMERIC OPT NONE

The number of the matching document, such as a receipt, payment, adjustment,or credit. You apply a matching document (DOCM) against
an original document (DOC), such as an invoice or voucher.

cReturnCode EV03 char OPT NONE

A radio button that specifies the level at which trace/track result is to be displayed.  Select the Detail to display all transactions except IB, IX,
and IZ types.  Or, select Derivative Lots Only to display only those transactions that may have created new derivative lot.

Related Functions

None

Related Tables

None

Parameter Name	Data Item	Data Type	Req/Opt	I/O/Both
szPayrollID	PAYD	char	OPT	NONE
A code that identifies a group of employees for whom you are processing payroll. Use this ID to process each step of the payroll cycle. This code is also used to identify the interim ID that you select when you enter interim payments.
cPaymentMethod	PMET	char	OPT	NONE
The type of payment. Valid types of payments are: A Auto Deposit C Check
mnFromCheckControlNumber	CKCN	MATH_NUMERIC	OPT	NONE
A number used to group all payroll transactions for each payment or individual interim payment. This number is carried into the accounting journal entries and facilitates the update of the actual check number after payment printing is complete. This number is also used for automatically voiding payments. The payment work table contains both the actual check number and the check control number. All associated payment transactions are automatically reversed using the check control number. This is not the actual check number.
mnThruCheckControlNumber	CKCN	MATH_NUMERIC	OPT	NONE
A number used to group all payroll transactions for each payment or individual interim payment. This number is carried into the accounting journal entries and facilitates the update of the actual check number after payment printing is complete. This number is also used for automatically voiding payments. The payment work table contains both the actual check number and the check control number. All associated payment transactions are automatically reversed using the check control number. This is not the actual check number.
mnSubCheckControlNo	SCKC	MATH_NUMERIC	OPT	NONE
The number that identifies the separate auto deposit transactions. This number is for paychecks with multiple auto deposit instructions.
cResetRegularPaymentsOnly	EV01	char	OPT	NONE
An option that specifies the type of processing for an event.
mnFromCheckNumber	DOCM	MATH_NUMERIC	OPT	NONE
The number of the matching document, such as a receipt, payment, adjustment,or credit. You apply a matching document (DOCM) against an original document (DOC), such as an invoice or voucher.
mnThruCheckNumber	DOCM	MATH_NUMERIC	OPT	NONE
The number of the matching document, such as a receipt, payment, adjustment,or credit. You apply a matching document (DOCM) against an original document (DOC), such as an invoice or voucher.
cReturnCode	EV03	char	OPT	NONE
A radio button that specifies the level at which trace/track result is to be displayed. Select the Detail to display all transactions except IB, IX, and IZ types. Or, select Derivative Lots Only to display only those transactions that may have created new derivative lot.