Parameter Name | Data Item | Data Type | Req/Opt | I/O/Both |
mnCheckControlNumber | 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. |
mnAddressNumber | AN8 | MATH_NUMERIC | OPT | NONE |
A number that identifies an entry in the Address Book system, such as employee, applicant, participant, customer, supplier, tenant, or
location.
|
szCheckControlNoCacheName | PID | char | OPT | NONE |
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.
|
jdDateUpdated | UPMJ | JDEDATE | OPT | NONE |
The date that specifies the last update to the file record. |
mnTimeLastUpdated | UPMT | MATH_NUMERIC | OPT | NONE |
The time that specifies when the program executed the last update to this record. |
szProgramId | PID1 | char | OPT | NONE |
Program ID - 01
|
szWorkStationId | JOBN | char | OPT | NONE |
The code that identifies the work station ID that executed a particular job.
|
szUserId | USER | char | OPT | NONE |
The code that identifies a user profile.
|
szTimecardCacheName | PID2 | char | OPT | NONE |
Program ID - 02
|
szCompanyHome | HMCO | char | OPT | NONE |
The company number where the employee records generally reside. |
vDataHandle | PID3 | char | OPT | NONE |
Program ID - 03
|
szPayrollIDOW | 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. |
szTaxAreaResidence | TARR | char | OPT | NONE |
A code that identifies both the geographical location and the tax authorities for the employee's residence. Authorities include employee
and employer statutory requirements. This code is synonymous with GeoCode. Refer to Vertex System's Master GeoCode File for valid codes
for your locations. |
szTaxAreaWork | TARA | char | OPT | NONE |
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.
|
jdDatePayCheck | CKDT | JDEDATE | OPT | NONE |
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. |
cWorkTaxAreaSource | NS | char | OPT | NONE |
This code is used to determine the source for obtaining the tax area code for the employee's work location.
N Use time entry, job master,
employee labor rules or employee master to determine Tax Area.
E Always use the Work Tax Area from the employee master on time
record.
When blank the system assumes N. |
cResidencyStatus | WSPS | char | OPT | NONE |
A value that identifies out-of-state employees for whom an employer must withhold tax for the state of residence. Valid values are:
N
(Default)
The system uses the employee residence state to calculate taxes. Because the work state has a reciprocal agreement with the employee
state of residence, the system uses the employee residence state from the Employee Master Information table (F060116).
W
The system
uses only the work state to calculate taxes.
|
cSourceofSUI | SUI | char | OPT | NONE |
Use this field to specify the work tax area that is used for SUI reporting.
You can specify that the system use either the resident state or the
work state, regardless of where the employee worked. FUI is calculated in the same state where SUI is calculated. Weeks Worked are the
number of weeks the employee worked in the taxed state. Valid values are:
N Use the work tax area in the time entry record to determine
SUI. This is the default value.
R Always use residence tax area from Employee Master table even if the time entry record is different.
W
Always use work tax area from Employee Master table even if the time entry record is different. |
szTimecardCompanyHome | HMCO | char | OPT | NONE |
The company number where the employee records generally reside. |
idEmployeeHandle | GENLNG | ID | OPT | NONE |
General purpose ID variable. |
iTimecardCount | INT01 | integer | OPT | NONE |
Number of Days in Future to Query for Responses Due.
|
szCountryCode | CCPR | char | OPT | NONE |
A user defined code list 00/CN that indicates the country in which the employee resides. |
szUnemploymentRatesCacheName | PID | char | OPT | NONE |
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.
|
szTaxDetailCacheName | PID | char | OPT | NONE |
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.
|
szTaxOverrideCacheName | PID | char | OPT | NONE |
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.
|
jdDateWorked | DWK | JDEDATE | OPT | NONE |
The date used as the actual work date or pay-period ending date. |
szPayPeriodNumber | PPNB | char | OPT | NONE |
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) |
jdDatePayPeriodEnding | PPED | JDEDATE | OPT | NONE |
The last day of a processing period (pay period, month, quarter or year). |
cTaxCalcMethod | FICM | char | OPT | NONE |
A code that specifies the tax method that the Vertex payroll-tax calculation system uses to calculate certain taxes. The codes are defined in
UDC 07/TM.
This code can also determine the form that the employee receives for year-end tax reporting. For example, when you enter C,
a contract employee receives IRS Form 1099-M rather than IRS Form W-2. If a form is not specified in Description 2, the system generates
IRS Form W-2.
For employees who are paid multiple times within one pay period, the system should review previous payments within the same
pay period and then adjust tax amounts. To specify this function, enter S.
If a tax method exists for an employee in addition to the normal tax
method that is set up in the Employee Master Information table (F060116), the system can use the alternative tax method to interactively
process interim payments. To specify this function, enter Z.
Some values, such as S and Z, might require additional setup in the UDC table.
|
szTaxIdentificationNo | TAXX | char | OPT | NONE |
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. |
szStatutoryCode | SC01 | char | OPT | NONE |
A code that allows you to override supplemental taxes for federal and state taxes and to add additional local residence taxes. Valid values
are:
F Override the federal supplemental tax for this employee.
S Override the state supplemental tax for this employee.
R Add
additional local residence tax.
When you override supplemental taxes, you must leave the Tax Area and Tax Type fields blank. |
cEarnIncomeCredStatus | EIC | char | OPT | NONE |
A code that specifies whether the employee qualifies for the earned income credit and elects for the employer to give him or her the
advance. Valid values are:
N The employee does not qualify (default).
Y The employee qualifies and the employee is single/head of
household.
M The employee qualifies and is married without spouse filing certificate.
B The employee qualifies and his or her spouse also
qualifies. |
cPayFrequency | PFRQ | char | OPT | NONE |
A user defined code (07/PF) that indicates how often an employee is paid. Valid codes are:
B
Biweekly
W
Weekly
S
Semimonthly
M
Monthly
A
Annually
C
European Annualized
The system uses the value in the Description-2 field on user defined codes to calculate the amount per
pay period for a salaried employee. |
cBypassVoidwithSpecialTaxes | BPVD | char | OPT | NONE |
A code that indicates whether you want to bypass or process voided payments if those payments contain special taxes. Valid values
are:
0
Process voided payments with special taxes.
1
Bypass voided payments with special taxes.
|
cHistoryConversion | EV01 | char | OPT | NONE |
An option that specifies the type of processing for an event.
|
szDBADetailCacheName | PID | char | OPT | NONE |
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.
|
szDBACacheName | PID | char | OPT | NONE |
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.
|
cVertexTaxAreaFlag | FLG | char | OPT | NONE |
|