ClearHistoricalPayrollCaches

Create Historical Payroll Register Cache

Minor Business Rule

Object Name: B0701630

Parent DLL: CPAY

Location: Client/Server

Language: C

Data Structure

D0701630B - Process Historical Payroll Register Cache

Parameter NameData ItemData TypeReq/OptI/O/Both
szCursorCacheNamePIDcharOPTNONE

The number that identifies the batch or interactive program (batch or interactive object). For example, the number of the Sales Order Entry 
interactive program is P4210, and the number of the Print Invoices batch process report is R42565. The program ID is a variable length value. 
It is assigned according to a structured syntax in the form TSSXXX, where: T The first character of the number is alphabetic and identifies the 
type, such as P for Program, R for Report, and so on. For example, the value P in the number P4210 indicates that the object is a 
program. SS The second and third characters of the number are numeric and identify the system code. For example, the value 42 in the number P4210 
indicates that this program belongs to system 42, which is the Sales Order Processing system. XXX The remaining characters of the numer are 
numeric and identify a unique program or report. For example, the value 10 in the number P4210 indicates that this is the Sales Order Entry 
program.

cCacheModeEV01charOPTNONE

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

cPayrollTypeEV01charOPTNONE

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

cSummaryModeEV01charOPTNONE

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

mnAddressNumberAN8MATH_NUMERICOPTNONE

A number that identifies an entry in the Address Book system, such as employee, applicant, participant, customer, supplier, tenant, or 
location.

szTaxIDTAXXcharOPTNONE

A number that identifies your company to the tax authority. This number can include the tax ID number for an individual, a federal or state 
corporate tax ID, a sales tax number, and so on. This number has specifically been established for the Payroll system to handle the 
requirements of taxing authorities that require more than 9 positions for the tax identification number. Do not enter hyphens (dashes), slashes, spaces, or 
other punctuation in the tax identification number.

szBusinessUnitHMCUcharOPTNONE

The number of the business unit in which the employee generally resides.

szHomeCompanyHMCOcharOPTNONE

The company number where the employee records generally reside.

mnCheckControlNumberCKCNMATH_NUMERICOPTNONE

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.

cFetchOnTaxIDEV01charOPTNONE

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

cResetCacheCursorEV01charOPTNONE

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

cPrintByTaxIDEV01charOPTNONE

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

cPrintDBATaxesEV01charOPTNONE

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

cTotalTypeEV01charOPTNONE

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

cPDBATypeDISOcharOPTNONE

A code used to distinguish between the following types of payroll entries: P Time Cards (Earnings)   D Deductions withheld   B Benefit (both 
cash and non cash)   A Accrual of sick, vacation, comp, and so forth  Note: These codes may only be changed by J.D. Edwards If you enter an * 
in this field the system displays all four types of PDBAs.

mnPDBACodePDBAMATH_NUMERICOPTNONE

A code that defines the type of pay, deduction, benefit, or accrual. Pay types are numbered from 1 to 999. Deductions and benefits are 
numbered from 1000 to 9999.

szTaxAreaTARAcharOPTNONE

A code that identifies a geographical location and the tax authorities for an employee work site, including employee and employer statutory 
requirements. In the Vertex payroll tax calculation software, the tax area code is synonymous with GeoCode. To determine the valid codes 
for your location, refer to the documentation for the tax calculation software that you are using.

szTaxTypePTAXcharOPTNONE

A code that specifies the type of payroll tax being processed. This is a user defined code (07/TX). To set up state minimum wage amounts, 
you must enter MW in this field. To do so, you must first add MW to UDC 07/TX. However, you should not change the codes and definitions 
that J.D. Edwards provides with the software.

szDescriptionDESCcharOPTNONE

A description, remark, name, or address.

mnCurrentAmountGPAYMATH_NUMERICOPTNONE

The actual gross pay amount for an employee. This amount is different from the distributed gross pay amount used for labour 
distribution. On Work Order Time Entry, use this field to record miscellaneous pay for an employee, such as piece rate bonus.

mnYTDAmountGPAYMATH_NUMERICOPTNONE

The actual gross pay amount for an employee. This amount is different from the distributed gross pay amount used for labour 
distribution. On Work Order Time Entry, use this field to record miscellaneous pay for an employee, such as piece rate bonus.

mnCurrentHoursPHRWMATH_NUMERICOPTNONE

The number of hours associated with each transaction.

mnYTDHoursPHRWMATH_NUMERICOPTNONE

The number of hours associated with each transaction.

mnCurrentExcludableBX01MATH_NUMERICOPTNONE

The amount of monthly gross pay excluded from the tax calculation. This amount includes deductions for retirement savings plans and 
other non-taxable accounts.

mnYTDExcludableBX01MATH_NUMERICOPTNONE

The amount of monthly gross pay excluded from the tax calculation. This amount includes deductions for retirement savings plans and 
other non-taxable accounts.

mnCurrentExcessBE01MATH_NUMERICOPTNONE

The amount of wages earned, but in excess of the annual limit, for tax calculation.

mnYTDExcessBE01MATH_NUMERICOPTNONE

The amount of wages earned, but in excess of the annual limit, for tax calculation.

mnCurrentTaxBY01MATH_NUMERICOPTNONE

The monthly amount of tax calculated.

mnYTDTaxBY01MATH_NUMERICOPTNONE

The monthly amount of tax calculated.

cCacheErrorCodeEV01charOPTNONE

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

jdPrintStartDateCKDTJDEDATEOPTNONE

The date associated with the various types of net pay instructions. This date relates to a payroll check, an interim payment, a bank 
automatic-deposit advice slip, a payslip (cash), or a claim reimbursement.

Related Functions

None

Related Tables

None
EndHistoricalPayrollCache

EndHistoricalPayrollCache

Create Historical Payroll Register Cache

Minor Business Rule

Object Name: B0701630

Parent DLL: CPAY

Location: Client/Server

Language: C

Data Structure

D0701630A - Historical Payroll Register Cache

Parameter NameData ItemData TypeReq/OptI/O/Both
szCursorCacheNamePIDcharOPTNONE

The number that identifies the batch or interactive program (batch or interactive object). For example, the number of the Sales Order Entry 
interactive program is P4210, and the number of the Print Invoices batch process report is R42565. The program ID is a variable length value. 
It is assigned according to a structured syntax in the form TSSXXX, where: T The first character of the number is alphabetic and identifies the 
type, such as P for Program, R for Report, and so on. For example, the value P in the number P4210 indicates that the object is a 
program. SS The second and third characters of the number are numeric and identify the system code. For example, the value 42 in the number P4210 
indicates that this program belongs to system 42, which is the Sales Order Processing system. XXX The remaining characters of the numer are 
numeric and identify a unique program or report. For example, the value 10 in the number P4210 indicates that this is the Sales Order Entry 
program.

cPrintByTaxIDEV01charOPTNONE

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

cYTDTotalLevelEV01charOPTNONE

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

cCacheErrorCodeEV01charOPTNONE

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

Related Functions

None

Related Tables

None
InitializeHistoricalPayrollCache

InitializeHistoricalPayrollCache

Create Historical Payroll Register Cache

Minor Business Rule

Object Name: B0701630

Parent DLL: CPAY

Location: Client/Server

Language: C

Data Structure

D0701630A - Historical Payroll Register Cache

Parameter NameData ItemData TypeReq/OptI/O/Both
szCursorCacheNamePIDcharOPTNONE

The number that identifies the batch or interactive program (batch or interactive object). For example, the number of the Sales Order Entry 
interactive program is P4210, and the number of the Print Invoices batch process report is R42565. The program ID is a variable length value. 
It is assigned according to a structured syntax in the form TSSXXX, where: T The first character of the number is alphabetic and identifies the 
type, such as P for Program, R for Report, and so on. For example, the value P in the number P4210 indicates that the object is a 
program. SS The second and third characters of the number are numeric and identify the system code. For example, the value 42 in the number P4210 
indicates that this program belongs to system 42, which is the Sales Order Processing system. XXX The remaining characters of the numer are 
numeric and identify a unique program or report. For example, the value 10 in the number P4210 indicates that this is the Sales Order Entry 
program.

cPrintByTaxIDEV01charOPTNONE

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

cYTDTotalLevelEV01charOPTNONE

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

cCacheErrorCodeEV01charOPTNONE

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

Related Functions

None

Related Tables

None
ProcessHistoricalPayrollCache

ProcessHistoricalPayrollCache

Create Historical Payroll Register Cache

Minor Business Rule

Object Name: B0701630

Parent DLL: CPAY

Location: Client/Server

Language: C

Data Structure

D0701630B - Process Historical Payroll Register Cache

Parameter NameData ItemData TypeReq/OptI/O/Both
szCursorCacheNamePIDcharOPTNONE

The number that identifies the batch or interactive program (batch or interactive object). For example, the number of the Sales Order Entry 
interactive program is P4210, and the number of the Print Invoices batch process report is R42565. The program ID is a variable length value. 
It is assigned according to a structured syntax in the form TSSXXX, where: T The first character of the number is alphabetic and identifies the 
type, such as P for Program, R for Report, and so on. For example, the value P in the number P4210 indicates that the object is a 
program. SS The second and third characters of the number are numeric and identify the system code. For example, the value 42 in the number P4210 
indicates that this program belongs to system 42, which is the Sales Order Processing system. XXX The remaining characters of the numer are 
numeric and identify a unique program or report. For example, the value 10 in the number P4210 indicates that this is the Sales Order Entry 
program.

cCacheModeEV01charOPTNONE

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

cPayrollTypeEV01charOPTNONE

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

cSummaryModeEV01charOPTNONE

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

mnAddressNumberAN8MATH_NUMERICOPTNONE

A number that identifies an entry in the Address Book system, such as employee, applicant, participant, customer, supplier, tenant, or 
location.

szTaxIDTAXXcharOPTNONE

A number that identifies your company to the tax authority. This number can include the tax ID number for an individual, a federal or state 
corporate tax ID, a sales tax number, and so on. This number has specifically been established for the Payroll system to handle the 
requirements of taxing authorities that require more than 9 positions for the tax identification number. Do not enter hyphens (dashes), slashes, spaces, or 
other punctuation in the tax identification number.

szBusinessUnitHMCUcharOPTNONE

The number of the business unit in which the employee generally resides.

szHomeCompanyHMCOcharOPTNONE

The company number where the employee records generally reside.

mnCheckControlNumberCKCNMATH_NUMERICOPTNONE

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.

cFetchOnTaxIDEV01charOPTNONE

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

cResetCacheCursorEV01charOPTNONE

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

cPrintByTaxIDEV01charOPTNONE

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

cPrintDBATaxesEV01charOPTNONE

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

cTotalTypeEV01charOPTNONE

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

cPDBATypeDISOcharOPTNONE

A code used to distinguish between the following types of payroll entries: P Time Cards (Earnings)   D Deductions withheld   B Benefit (both 
cash and non cash)   A Accrual of sick, vacation, comp, and so forth  Note: These codes may only be changed by J.D. Edwards If you enter an * 
in this field the system displays all four types of PDBAs.

mnPDBACodePDBAMATH_NUMERICOPTNONE

A code that defines the type of pay, deduction, benefit, or accrual. Pay types are numbered from 1 to 999. Deductions and benefits are 
numbered from 1000 to 9999.

szTaxAreaTARAcharOPTNONE

A code that identifies a geographical location and the tax authorities for an employee work site, including employee and employer statutory 
requirements. In the Vertex payroll tax calculation software, the tax area code is synonymous with GeoCode. To determine the valid codes 
for your location, refer to the documentation for the tax calculation software that you are using.

szTaxTypePTAXcharOPTNONE

A code that specifies the type of payroll tax being processed. This is a user defined code (07/TX). To set up state minimum wage amounts, 
you must enter MW in this field. To do so, you must first add MW to UDC 07/TX. However, you should not change the codes and definitions 
that J.D. Edwards provides with the software.

szDescriptionDESCcharOPTNONE

A description, remark, name, or address.

mnCurrentAmountGPAYMATH_NUMERICOPTNONE

The actual gross pay amount for an employee. This amount is different from the distributed gross pay amount used for labour 
distribution. On Work Order Time Entry, use this field to record miscellaneous pay for an employee, such as piece rate bonus.

mnYTDAmountGPAYMATH_NUMERICOPTNONE

The actual gross pay amount for an employee. This amount is different from the distributed gross pay amount used for labour 
distribution. On Work Order Time Entry, use this field to record miscellaneous pay for an employee, such as piece rate bonus.

mnCurrentHoursPHRWMATH_NUMERICOPTNONE

The number of hours associated with each transaction.

mnYTDHoursPHRWMATH_NUMERICOPTNONE

The number of hours associated with each transaction.

mnCurrentExcludableBX01MATH_NUMERICOPTNONE

The amount of monthly gross pay excluded from the tax calculation. This amount includes deductions for retirement savings plans and 
other non-taxable accounts.

mnYTDExcludableBX01MATH_NUMERICOPTNONE

The amount of monthly gross pay excluded from the tax calculation. This amount includes deductions for retirement savings plans and 
other non-taxable accounts.

mnCurrentExcessBE01MATH_NUMERICOPTNONE

The amount of wages earned, but in excess of the annual limit, for tax calculation.

mnYTDExcessBE01MATH_NUMERICOPTNONE

The amount of wages earned, but in excess of the annual limit, for tax calculation.

mnCurrentTaxBY01MATH_NUMERICOPTNONE

The monthly amount of tax calculated.

mnYTDTaxBY01MATH_NUMERICOPTNONE

The monthly amount of tax calculated.

cCacheErrorCodeEV01charOPTNONE

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

jdPrintStartDateCKDTJDEDATEOPTNONE

The date associated with the various types of net pay instructions. This date relates to a payroll check, an interim payment, a bank 
automatic-deposit advice slip, a payslip (cash), or a claim reimbursement.

Related Functions

None

Related Tables

None