N7000930_PlugAndPlay_P0801

P0801 - Plug and Play - 08

Minor Business Rule

Object Name: N7000930

Parent DLL: CALLBSFN

Location: Client

Language: NER

Data Structure

D7000930 - P0801 - Plug and Play                                 - 08

Parameter NameData ItemData TypeReq/OptI/O/Both
szCompanyCOcharOPTNONE

A code that identifies a specific organization, fund, or other reporting entity. The company code must already exist in the Company 
Constants table (F0010) and must identify a reporting entity that has a complete balance sheet. At this level, you can have intercompany 
transactions. Note: You can use company 00000 for default values such as dates and automatic accounting instructions. You cannot use company 00000 
for transaction entries.

szCountryCTRcharOPTNONE

A user defined code (00/CN) that identifies a country. The country code has no effect on currency conversion. The Address Book system 
uses the country code for data selection and address formatting.

szCallingApplPIDcharOPTNONE

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.

szCallingFormFIDcharOPTNONE

The Form ID refers to the report (R), form (V), or table number (F).

szCallingVersVERScharOPTNONE

A user-defined set of specifications that control how applications and reports run. You use versions to group and save a set of user-defined 
processing option values and data selection and sequencing options. Interactive versions are associated with applications (usually as a 
menu selection). Batch versions are associated with batch jobs or reports. To run a batch process, you must choose a version.

szFormActionFATNcharOPTNONE

Form Action for Localization Exits UDC 00/FA    1   ADD Add    2   CHG Change    3   DEL Delete    4   XIT Hypercontrol Exit

mnAddressNumberAN8MATH_NUMERICOPTNONE

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

cStatusFlagEV02charOPTNONE

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

szEmployeeNoDescDL30charOPTNONE

A description, remark, name or address.

szEmployeeNoDisplayDL20charOPTNONE

A description, remark, name or address.

szTaxAreaResidenceTARRcharOPTNONE

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.

mnNetCanadianFederalTaxCreditMATH01MATH_NUMERICOPTNONE

- - - Good Performance Low Value. 

mnNetQuebecTaxCreditMATH01MATH_NUMERICOPTNONE

- - - Good Performance Low Value. 

cCanadianTaxCreditAddEV01charOPTNONE

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

cCanadianTaxCreditChangeEV01charOPTNONE

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

cTaxAreaPOEV01charOPTNONE

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

szNextAddFormVC03AcharOPTNONE

This is a generic field used as a work field in Everest.

szNewAlphaNameALPHcharOPTNONE

The text that names or describes an address. This 40-character alphabetic field appears on a number of forms and reports. You can enter 
dashes, commas, and other special characters, but the system cannot search on them when you use this field to search for a name.

szNewTaxAreaWorkTARAcharOPTNONE

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.

cNewMaritalStatusFedMSTXcharOPTNONE

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.

cNewMaritalStatusStateMSTIcharOPTNONE

The employee's "Work" state marital status code as retrieved from the state W-4. This code is used in the computation of all state payroll 
taxes associated with the state in which the employee performed work. If you leave this field blank, the Federal status is used.

cNewMaritalStatusLocalLMSTcharOPTNONE

The employee's Local marital status code as retrieved from the locality's W-4. This code is used in the computation of all local (city, county) 
payroll taxes associated with the state in which the employee performed work. If you leave this field blank, the Federal status is used.

cNewDisabilityHM04charOPTNONE

A code indicating whether this employee has a mental or physical disability. Valid codes are: Y Yes, this employee has a mental or 
physical disability. N No, this employee does not have a mental or physical disability. U Unknown

cNewDisabledVeteranHM03charOPTNONE

A code indicating whether this employee is a disabled veteran.  Valid codes are: Y Yes, this employee is a disabled veteran. N No, this 
employee is not a disabled veteran. This field is used to generate the Veterans Employee (VETS-100) report.

cNewVeteranHM02charOPTNONE

A code that indicates the veteran status of the employee for EEO reporting purposes.  Valid values are: N This employee is not a 
veteran. Y This employee is a veteran. V This employee is a Vietnam veteran. O This employee is a veteran, classified as Other as defined by the U.S. 
Department of Labor.  

cNewI9StatusHM01charOPTNONE

A code indicating the method used to verify that this employee is eligible to work in the United States. Valid codes are:    Y I9 form on file    P 
Passport used for verification    L Driver's license and Social Security card    V Visa (worker's permit)    B Birth certificate    N Waiting for 
verification

cNewFirstNameInitialIFNcharOPTNONE

The first letter of the employee's first (given) name. This is primarily used to facilitate certain statutory reporting requirements.

cNewMiddleNameInitialIMNcharOPTNONE

The first letter of the individual's middle name. This is primarily used to facilitate certain statutory reporting requirements.

szChangeReasonTRScharOPTNONE

A code that indicates the reason for one of the following:   o  Changing an active employee's record   o  Terminating an employee   o  
Recommending a change in salary or rate This is a user defined code (06/T). If you are reactivating an employee, the code must be numeric. The 
code for new hires is the default reason code.

jdDateEffectiveOnEFTOJDEDATEOPTNONE

A future date when all changes will take effect or the date when the changes went into effect. If you do not enter a date in this field, the system 
uses the current date as the effective date.

cNewResidencyStatusWSPScharOPTNONE

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.

cNewEICStatusEICcharOPTNONE

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.

szNewWorkersCompWCMPcharOPTNONE

A user defined code (00/W) that represents a workers' compensation insurance (WCI) code. This code should correspond to the 
classifications on your periodic workers' compensation insurance reports.

szRegnREGNcharOPTNONE

A region within a state.  This field is intended for use in preparation of unemployment reports for some states.

szStOccupClassCodeSOCCcharOPTNONE

A series of codes that identify occupational titles and their definitions. These codes are used in one or more states in the preparation of 
unemployment reports.

cNewWorkTaxAreaSrceNScharOPTNONE

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.

cNewTaxMethodFICMcharOPTNONE

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.

cNewSubClassWorkersCompWETcharOPTNONE

A code that specifies any special circumstances associated with the workers compensation insurance (WCI) code, resulting in multiple 
rates for the same WCI code due to location or risk, for example. The subclass should remain blank if multiple rates do not exist. Default codes 
are: Blank There are no special circumstances associated with this code. F There are special circumstances associated with this code.

cNewSourceofSUIReportingSUIcharOPTNONE

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.

jdDateEmploymentStartDSTJDEDATEOPTNONE

The date on which the employee actually reported to work for the most recent period of hire. When an employee initially begins working, 
the default is the original hire date. If no original hire date exists, the system uses the current date. This field can be updated multiple times if, for 
example, an employee is a seasonal worker. For the calculation tables in the Payroll system and the eligibility tables and date codes in the 
Human Resources system, the system also uses this date as a start date when it calculates deductions, benefits, and accruals.

mnSchoolDistrictCodeSCDCMATH_NUMERICOPTNONE

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.

cTippedEmployeeTIPEcharOPTNONE

A code that specifies whether this employee receives or claims tips and should be included in any necessary Tip Processing programs. 
This field applies to U.S. Payroll Only. This field must contain Y for tip processing.

cNewMaritalStatusResidentRMSTcharOPTNONE

A user defined code (system 06, type MS) that specifies the marital status code for the state of residence. It is used for tax computations. 
This code is related to specific VERTEX system codes (see the VERTEX Tax Manual for their explanation). Also, two special codes have 
been provided: one designates single for Federal and married for State, and the other designates married for Federal and single for State.

szNewMedicalPlanIDHIPNcharOPTNONE

A unique identifier for secondary employee numbers, such as an employee's health insurance plan ID number.

szNewNOCCENCcharOPTNONE

A code that identifies the National Occupational Classification (NOC) for a job or employee. The Canadian government defines NOC 
codes. See the Canadian Federal Employment Equity documentation for more information about NOC codes.

szNewSICCESIcharOPTNONE

A code that identifies the Sector Industrial Code. These codes are defined by the Canadian government and can be found in the Canadian 
Federal Employment Equity documentation.

szNewCensusMetroAreaCECMcharOPTNONE

A code that identifies the Census Metropolitan Area code of work. Valid codes are defined by the Canadian government and can be found 
in the Canadian Federal Employment Equity documentation.

szEmployeeNumberDescriptioENDSOWcharOPTNONE

This field holds the description of the employee ID being displayed.

szEmployeeIdentificationENDYOWcharOPTNONE

The employee number, TAX ID, or Alternate number, depending on the employee number mode that is set up in the Payroll Constants for 
company 00000.

szCountryForPayrollCCPRcharOPTNONE

A user defined code list 00/CN that indicates the country in which the employee resides.

cEmployeeStatusFlagESTSOWcharOPTNONE

A color in the box at the top right corner of the form that indicates the current payroll status of an employee. The following colors indicate:        
Green - Active employee not included in the current payroll cycle.        Fuchsia - Active employee included in the current payroll cycle.        Red 
- Terminated employee. The employee's termination date does not equal zero.        Yellow - Employee on leave of absence. The employee 
has a leave of absence begin date less than today's date and an end date that is greater than or equal to today's date.

cEmployeePayStatusPASTcharOPTNONE

The code used to indicate whether an employee's pay status is active or inactive. Codes for active pay status employees are numeric, 
and codes for inactive pay status employees are alphabetic. The system omits all employees with alphabetic pay status codes from the 
payroll run. See also Employment Status (EST) and Change Reason (TRS).

mnYukonTerritoryTaxCreditMATH01MATH_NUMERICOPTNONE

- - - Good Performance Low Value. 

mnSaskatchewanTaxCreditMATH01MATH_NUMERICOPTNONE

- - - Good Performance Low Value. 

mnPrinceEdIslandTaxCreditMATH01MATH_NUMERICOPTNONE

- - - Good Performance Low Value. 

mnOnterioTaxCreditMATH01MATH_NUMERICOPTNONE

- - - Good Performance Low Value. 

mnNovaScotiaTaxCreditMATH01MATH_NUMERICOPTNONE

- - - Good Performance Low Value. 

mnNortwestTerritorieTaxCreditMATH01MATH_NUMERICOPTNONE

- - - Good Performance Low Value. 

mnNewfoundlandTaxCreditMATH01MATH_NUMERICOPTNONE

- - - Good Performance Low Value. 

mnNewBrunswickTaxCreditMATH01MATH_NUMERICOPTNONE

- - - Good Performance Low Value. 

mnManitobaTaxCreditMATH01MATH_NUMERICOPTNONE

- - - Good Performance Low Value. 

mnBritishColumbiaTaxCreditMATH01MATH_NUMERICOPTNONE

- - - Good Performance Low Value. 

mnAlbertaTaxCreditMATH01MATH_NUMERICOPTNONE

- - - Good Performance Low Value. 

szCostCenterHomeHMCUcharOPTNONE

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

Related Functions

None

Related Tables

None