| Parameter Name | Data Item | Data Type | Req/Opt | I/O/Both |
|---|
| mnAmountNetPay_NPAY | NPAY | MATH_NUMERIC | OPT | NONE |
The net amount of the payment.
Before the net-deduction phase of the pre-payroll process runs, this amount equals gross pay, less taxes,
less deductions that are based on gross pay.
After the net-deduction phase, this amount represents the true net pay.
For additional information
that is related to this calculation process, see data items NPY1 and DESQ.
|
| mnOverridePayType_PDBA | PDBA | MATH_NUMERIC | OPT | NONE |
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. |
| mnOverrideTaxRate_RTAM | RTAM | MATH_NUMERIC | OPT | NONE |
A value that is a percentage, a monetary amount, or an hourly rate, depending on where it is used. Valid values are:
1
For a deduction,
benefit, or accrual, the meaning of this value depends on the method of calculation. The method determines whether the deduction is a flat
monetary amount, a percentage, or a multiplication rate. Table method DBAs, depending on which table method they use, can either use this
amount in the calculation or ignore it. If there are exceptions to the table calculation, you can override the table code in the detail area, set up a
flat monetary DBA amount, or override the amount with a one-time override for a timecard.
2
For a pay type, amounts entered in this field
override the hourly rate.
|
| szCheckControlCache_PID | 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.
|
| szDBACache_PID1 | PID1 | char | OPT | NONE |
Program ID - 01
|
| mnAmountGrossPay_GPAY | GPAY | MATH_NUMERIC | OPT | NONE |
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.
|
| szVertexCache_PID2 | 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.
|
| mnAddressNumber_AN8 | 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.
|
| szTaxAreaWork_TARA | 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.
|
| szTaxAreaResidence_TARR | 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. |
| szPayPeriodNumber_PPNB | 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) |
| cPayFrequency_PFRQ | 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. |
| jdPayCheckDate_CKDT | 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. |
| cFedMaritalStatusTax_MSTX | MSTX | char | OPT | NONE |
A user defined code (system 06, type MS) that specifies the employees' federal marital status code as retrieved from the W-4 form. This
code is used in the computation of all federal income tax. You can add codes if needed. |
| cWorkMaritalStatusTax_MSTX | MSTX | char | OPT | NONE |
A user defined code (system 06, type MS) that specifies the employees' federal marital status code as retrieved from the W-4 form. This
code is used in the computation of all federal income tax. You can add codes if needed. |
| cResMaritalStatusTax_MSTX | MSTX | char | OPT | NONE |
A user defined code (system 06, type MS) that specifies the employees' federal marital status code as retrieved from the W-4 form. This
code is used in the computation of all federal income tax. You can add codes if needed. |
| cLocalMaritalStatusTax_MSTX | MSTX | char | OPT | NONE |
A user defined code (system 06, type MS) that specifies the employees' federal marital status code as retrieved from the W-4 form. This
code is used in the computation of all federal income tax. You can add codes if needed. |
| mnHoursWork_PHRW | PHRW | MATH_NUMERIC | OPT | NONE |
The number of hours associated with each transaction. |
| jdDatePayPeriodEnding_PPED | PPED | JDEDATE | OPT | NONE |
The last day of a processing period (pay period, month, quarter or year). |
| mnBatchNumber_ICU | ICU | MATH_NUMERIC | OPT | NONE |
A number that identifies a group of transactions that the system processes and balances as a unit. When you enter a batch, you can either
assign a batch number or let the system assign it using the Next Numbers program. |
| jdPayrollBegDate_EFTB | EFTB | JDEDATE | OPT | NONE |
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.
|
| jdPayrollEndDate_EFTE | EFTE | JDEDATE | OPT | NONE |
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.
|
| cPayPeriodWeekly_PPM1 | PPM1 | char | OPT | NONE |
The number of the pay period, within the month, for employees who are paid weekly. This field is used in conjunction with the Pay Period to
Calculate field on the DBA Setup form to determine which deductions, benefits, and accruals the system will calculate during the current
payroll cycle. |
| cPayPeriodBiWeekly_PPM2 | PPM2 | char | OPT | NONE |
The number of the pay period, within the month, for employees who are paid biweekly. The system uses this value and the Pay Period to
Calculate, from the DBA Setup form, to determine which deductions, benefits, and accruals to calculate during the current payroll cycle. |
| cPayPeriodSemi_PPM3 | PPM3 | char | OPT | NONE |
The number of the pay period, within the month, for employees paid semimonthly. The system uses this value and the Pay Period to
Calculate, from the DBA Setup form, to determine which deductions, benefits, and accruals to calculate for the current payroll processing cycle. |
| cPayPeriodMonthly_PPM4 | PPM4 | char | OPT | NONE |
The number of the pay period within the month, for employees who are paid monthly. This field is used in conjunction with the Pay Period to
Calculate field on the DBA Setup form to determine which deductions, benefits, and accruals are to be calculated during this payroll cycle. |
| cPayPeriodAnnual_PPM5 | PPM5 | char | OPT | NONE |
The number of the pay period for employees who are paid annually. This field is used in conjunction with the Pay Period to Calculate field
on the DBA Setup form to determine which deductions, benefits, and accruals are to be calculated during this payroll cycle. |
| cPayPeriodOther_PPM6 | PPM6 | char | OPT | NONE |
The number of the pay period, within the month, that is used in conjunction with the Pay Period to Calculate field on the DBA Setup form to
determine which deductions, benefits, and accruals are to be calculated during this payroll cycle. |
| szPayrollID_PAYD | 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. |
| szUserID_USER | USER | char | OPT | NONE |
The code that identifies a user profile.
|
| szWorkStationID_JOBN | JOBN | char | OPT | NONE |
The code that identifies the work station ID that executed a particular job.
|
| mnTimeLastUpdated_UPMT | UPMT | MATH_NUMERIC | OPT | NONE |
The time that specifies when the program executed the last update to this record. |
| jdDateUpdated_UPMJ | UPMJ | JDEDATE | OPT | NONE |
The date that specifies the last update to the file record. |
| szTimecardCache_PID | 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.
|
| szTaxDetailCache_PID | 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.
|
| szCountryCode_CCPR | CCPR | char | OPT | NONE |
A user defined code list 00/CN that indicates the country in which the employee resides. |
| cPrintVertexReport | EV01 | char | OPT | NONE |
An option that specifies the type of processing for an event.
|
| szCompanyHome_HMCO | HMCO | char | OPT | NONE |
The company number where the employee records generally reside. |
| cTaxCalcMethod_FICM | 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.
|
| jdDateOfBirth_DOB | DOB | JDEDATE | OPT | NONE |
The employee's date of birth. |
| mnOverrideTaxRateState_RTAM | RTAM | MATH_NUMERIC | OPT | NONE |
A value that is a percentage, a monetary amount, or an hourly rate, depending on where it is used. Valid values are:
1
For a deduction,
benefit, or accrual, the meaning of this value depends on the method of calculation. The method determines whether the deduction is a flat
monetary amount, a percentage, or a multiplication rate. Table method DBAs, depending on which table method they use, can either use this
amount in the calculation or ignore it. If there are exceptions to the table calculation, you can override the table code in the detail area, set up a
flat monetary DBA amount, or override the amount with a one-time override for a timecard.
2
For a pay type, amounts entered in this field
override the hourly rate.
|
| mnBillingRate | BLGRT | MATH_NUMERIC | OPT | NONE |
A rate used for the billing of labor services. This rate is often referred to as the billing or recharge rate. The extended amount based on this
rate will be charged to the primary distribution account on the timecard with an offset being made to an account derived from the Accounting
Rules table. This rate will not affect the employee's payroll. To allow billing rates in time entry,you must set the employee's record type as
either 2 or 3 on the Basic Employee Entry form.
Enter a rate on any of the following forms to override the rate in the Employee Primary Job table:
o Pay Rate Information
o Employee Labor Distribution
o Occupational Pay Rates
o Time Entry by Employee
o Time Entry by Job or
Business Unit
o Daily Timecard Entry
o Time Entry by Employee with Equipment
o Time Entry by Shop Floor Control |
| 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. |
| iNumberOfPayPeriods | INT01 | integer | OPT | NONE |
Number of Days in Future to Query for Responses Due.
|
| cLastPeriodOfMonth | EV01 | char | OPT | NONE |
An option that specifies the type of processing for an event.
|
| mnSchoolDistrictCode | SCDC | MATH_NUMERIC | OPT | NONE |
A user-defined code in UDC 06/SD that determines the school district tax for taxation purposes. Vertex automatically calculates the school
district tax. This feature is primarily used by the public sector.
|