F07210GetPayCycleParameters

F07210 - Retrieve Pay Cycle Parameters

Minor Business Rule

Object Name: N0700065

Parent DLL: CPAY

Location: Client/Server

Language: NER

F07210 Get Pay Cycle Parameters

Object Name: N0700065 Retrieve Pay Cycle Parameters


Parent DLL: CHRM


Location: Client/Server


Language: NER


Functional Description


Purpose


Retrieves the payroll parameters for a payroll id., from the Pay Cycle Parameters (F07210) table.


Special Logic


Pass the payroll id. into the business function.  Pay cycle code, pay cycle group, pay period number, 

year, ending date, beginning effective date and ending effective date are returned from the business 

function.


Return Code will be populated with a '0' upon successful processing.  If processing is unsuccessful, 

return code will be populated with a '1'.

Data Structure

D0700065 - DS for F07210 - Retrieve Pay Cycle Parameters

Special Input Expected

Payroll Identification must be passed into the business function.


Special Output Expected


Pay Cycle Code, Pay Cycle Group Type, Pay Period Number, Pay Period Year, Pay Period End Date, 

Beginning Efective Date, Ending Effective Date are returned from the business function.


Significant Data Values


Return Code = 1 (Unsuccessful processing)

Return Code = 0 (Successful processing)

^

Parameter NameData ItemData TypeReq/OptI/O/Both
szPayrollIDOWPAYDcharOPTNONE

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.

szPayCycleCodePCCDcharOPTNONE

A code that identifies the values for a master payroll cycle.

cPayCylcleGroupTypePCGTcharOPTNONE

A code which identifies which Business Unit in the Timecard Detail File (F06116) is to be used in the selection of the transactions for a 
Payroll Processing. Any one of the following Business Units may be selected:    D Distribution Business Unit (YTMCU)    J Job Location (YTMUCO)   
 H Home Business Unit (YTHMCU)

mnDateYrDTEYMATH_NUMERICOPTNONE

A two-digit number that specifies the applicable year. If you leave this field blank, the program uses the system date.

szPayPeriodNumberPPNBcharOPTNONE

The number of the pay period from the beginning of the year. For instance, a monthly payroll cycle beginning in January has a total of 12 
periods with October being the 10th period. Typical values are:        001-052 (Weekly Payroll Cycle)        001-026 (Biweekly Payroll Cycle)        
001-024 (Semimonthly Payroll Cycle)        001-012 (Monthly Payroll Cycle)        001-004 (Quarterly Payroll Cycle)        001-001 (Annual Payroll Cycle)

jdDatePayPeriodEndingPPEDJDEDATEOPTNONE

The last day of a processing period (pay period, month, quarter or year).

jdDateBeginningEffectiveEFTBJDEDATEOPTNONE

The date that an address, item, transaction, or table record becomes active.  The meaning of this field differs, depending on the program.  
For example, the effective date could represent the following:    o When a change of address becomes effective.   o When a lease becomes 
effective.   o When a price becomes effective.   o When the currency exchange rate becomes effective.   o When a tax rate becomes effective. 

jdDateEndingEffectiveEFTEJDEDATEOPTNONE

The date on which the item, transaction, or table becomes inactive, or through which you want transactions to appear. This field is used 
generically throughout the system. It could be a lease effective date, a price or cost effective date, a currency effective date, a tax rate effective 
date, or whatever is appropriate.

cReturnCodeEV01charOPTNONE

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

Related Functions

None

Related Tables

None