AddF77210BoxesToF77200

CA Year End Form Add, Subtract, Copy Amounts Functions

Minor Business Rule

Object Name: N7700085

Parent DLL: CPAY

Location: Client/Server

Language: NER

Data Structure

D7700085 - CA Year End Form Add, Subtract, Copy Amount Functions

Parameter NameData ItemData TypeReq/OptI/O/Both
szYearEndIdYEIDcharOPTNONE

A unique code that identifies a group of employees for whom you are processing year-end forms for a particular year. Use this ID to 
process each step of year-end processing.

mnTaxYearTAXYRMATH_NUMERICOPTNONE

The tax year, including the century.

mnAddressNumberAN8MATH_NUMERICOPTNONE

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

mnFormsIdFORMSIDMATH_NUMERICOPTNONE

A code that identifies the year-end form. Valid values are: 1 T4 2 Relevé 1 3 T4A 4 Relevé 2 5 NR4

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.

cAmendTypeAMNDTcharOPTNONE

The amend status of this record for this year-end ID. Valid values are: Blank Not amended 1 Amended

szTaxIdentificationNoTAXXcharOPTNONE

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.

szTaxAreaWorkTARAcharOPTNONE

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.

szFormDescriptionFORMDcharOPTNONE

The description or title of the form.

szSocialSecurityNumberSSNcharOPTNONE

A number that indicates the tax ID. In the United States, the tax ID is the social security number. In Canada, it is the social insurance number. 
If you add employee information for a non-US or non-Canadian company, you can leave this field blank. However, if the international code is 
set to Y and the default company is non-Canadian and non-United States, you can enter a 16-character number for the tax ID. The system 
does not permit duplicate tax ID numbers. Also, the number cannot include dashes. For example, if a social security number of nn-nn-nnnn is 
used, the number should be entered as follows: 123456789.

szNameAlphaALPHcharOPTNONE

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.

szCostCenterHomeHMCUcharOPTNONE

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

szProvOfEmplyT4PEcharOPTNONE

The 2-letter code indicating the Province of employment. Valid values are: AB Alberta BC British Columbia MB Manitoba NB New 
Brunswick NF Newfoundland NT Northwest Territories NS Nova Scotia ON Ontario PE Prince Edward Island QC Quebec SK Saskatchewan YT Yukon 
Territory ZZ Other Canadian Areas 

mnWagesFederalTaxableFDWGMATH_NUMERICOPTNONE

The amount of wages subject to Federal Income Tax.

mnAmountFederalTaxFDTXMATH_NUMERICOPTNONE

The amount of Federal Income Tax withheld for the employee.

mnProvincialTaxableWagesPRTXWMATH_NUMERICOPTNONE

The amount of provincial taxable wages.

mnProvincialIncomeTaxPRITXMATH_NUMERICOPTNONE

The amount of provincial income tax withheld from the employee's wages.

mnEiInsurableEarningsEIERMATH_NUMERICOPTNONE

The EI insurable earnings for T4 and Relevé 1 forms.

mnEiPremiumEIPMATH_NUMERICOPTNONE

The amount of Employment Insurance paid to the company by the employee.

mnPensionableEarningsCPPEMATH_NUMERICOPTNONE

Pensionable earnings that are calculated for T4/Releve forms.

mnCanadaPensionPlanCPPMATH_NUMERICOPTNONE

Employee contribution to the Canada Pension Plan.

mnQuebecPensionPlanQPPMATH_NUMERICOPTNONE

Employee contribution to the Quebec Pension Plan.

mnEiPremiumEmployerEIPRMATH_NUMERICOPTNONE

The amount of employment insurance paid by the company.

mnCppEmployerCPERMATH_NUMERICOPTNONE

Employer contribution to the Canadian Pension Plan.

mnQppEmployerQPERMATH_NUMERICOPTNONE

The employer contribution to the Quebec Pension Plan (QPP).

szEmploymentCodeT4ECcharOPTNONE

The employment code for the employee. Valid values are defined in user defined code table 77/EC.

cExemptCppQppECPPcharOPTNONE

A flag that shows if the employee was exempt from CPP/QPP for the ENTIRE year.    blank The employee was not exempt    X       The 
employee was exempt from CPP/QPP for the entire year.

cRecipientTypeNRCTcharOPTNONE

A code that classifies the recipient of the NR4 form. This code is printed on the NR4 form. Valid values are assigned by the Canada 
Customs and Revenue Agency (CCRA) and are defined in UDC 77Y/RT.

szCountryForPayrollCCPRcharOPTNONE

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

cExemptFromEiEEIcharOPTNONE

A flag that indicates whether the employee was exempt from EI for the entire year. Valid values are: Blank The employee was not 
exempt. X The employee was exempt from EI for the entire year.

cArchiveStatusARCScharOPTNONE

The archive status for this year-end ID. Valid values are: Blank Not executed A Active or in job queue 1 Completed

mnAdjustedFITWagesAFDWGMATH_NUMERICOPTNONE

The amount of adjusted wages subject to federal income tax.

mnAdjustedFederalIncomeTaxAFDTXMATH_NUMERICOPTNONE

The adjusted amount of federal income tax withheld from the employee's wages.

mnAdjustedProvincialTaxablAPRTXWMATH_NUMERICOPTNONE

The adjusted amount of provincial taxable wages.

mnAdjustedProvincialIncomeAPRITXMATH_NUMERICOPTNONE

The adjusted amount of provincial income tax withheld from the employee's wages.

mnAdjustedEiInsurableEarniAEIERMATH_NUMERICOPTNONE

The adjusted EI insurable earnings for T4 and Releve forms.

mnAdjustedEiPremiumAEIPMATH_NUMERICOPTNONE

The adjusted amount of employment insurance paid by the employee to the company.

mnAdjustedPensionableEarniACPPEMATH_NUMERICOPTNONE

The adjusted pensionable earnings that are calculated for T4/Relevé purposes.

mnAdjustedCanadaPensionPlanACPPMATH_NUMERICOPTNONE

Adjusted employee contribution to the Canada Pension Plan (CPP).

mnAdjustedQuebecPensionPlanAQPPMATH_NUMERICOPTNONE

The adjusted employee contribution to the Quebec Pension Plan (QPP).

mnTotAdjFITWagesAFDWGMATH_NUMERICOPTNONE

The amount of adjusted wages subject to federal income tax.

mnTotAdjFederalIncomeTaxAFDTXMATH_NUMERICOPTNONE

The adjusted amount of federal income tax withheld from the employee's wages.

mnTotAdjProvincTaxWagesAPRTXWMATH_NUMERICOPTNONE

The adjusted amount of provincial taxable wages.

mnTotAdjProvincIncomeTaxAPRITXMATH_NUMERICOPTNONE

The adjusted amount of provincial income tax withheld from the employee's wages.

mnTotAdjEiInsurableEarningsAEIERMATH_NUMERICOPTNONE

The adjusted EI insurable earnings for T4 and Releve forms.

mnTotAdjEiPremiumAEIPMATH_NUMERICOPTNONE

The adjusted amount of employment insurance paid by the employee to the company.

mnTotAdjPensionableEarningsACPPEMATH_NUMERICOPTNONE

The adjusted pensionable earnings that are calculated for T4/Relevé purposes.

mnTotAdjCPPACPPMATH_NUMERICOPTNONE

Adjusted employee contribution to the Canada Pension Plan (CPP).

mnTotAdjQPPAQPPMATH_NUMERICOPTNONE

The adjusted employee contribution to the Quebec Pension Plan (QPP).

szBoxNumber9BOXNcharOPTNONE

The number of the box as it appears on the year-end form.

mnAmount9AMNTMATH_NUMERICOPTNONE

An amount for a specific box on a year-end form.

mnAmountAdjustedAMTADJMATH_NUMERICOPTNONE

An adjusted amount. Enter the amount of the adjustment, not the amount after adjustment. For example, if an original amount of 400 should 
be corrected to 500, enter 100 in the Adjusted field.

mnTotAmountAdjustedAMTADJMATH_NUMERICOPTNONE

An adjusted amount. Enter the amount of the adjustment, not the amount after adjustment. For example, if an original amount of 400 should 
be corrected to 500, enter 100 in the Adjusted field.

szAdditionalTextATEXTcharOPTNONE

Text for a specific box on a year-end form. Use this field for boxes that require text rather than amounts.

cTableFlagEV01charOPTNONE

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

mnPrimaryFormControlNumberPFCNOMATH_NUMERICOPTNONE

A form control number.

mnSecondaryFormControlNumbSFCNOMATH_NUMERICOPTNONE

A secondary form control number.

mnGrossIncome1GI1MATH_NUMERICOPTNONE

The Gross Income for NR4 printing.

mnAdjustedGrossIncome1AGI1MATH_NUMERICOPTNONE

The adjusted amount of gross income for line 1 on the NR4 form.

mnGrossIncome2GI2MATH_NUMERICOPTNONE

The Gross Income for NR4 printing.

mnAdjustedGrossIncome2AGI2MATH_NUMERICOPTNONE

The adjusted amount of gross income for line 2 on the NR4 form.

mnTaxWithheld1TXW1MATH_NUMERICOPTNONE

The Tax Withheld for NR4 printing.

mnAdjustedTaxWithheld1ATXW1MATH_NUMERICOPTNONE

The adjusted amount of tax withheld for line 1 on the NR4 form.

mnAdjustedTaxWithheld2ATXW2MATH_NUMERICOPTNONE

The adjusted amount of tax withheld for line 2 on the NR4 form.

mnTaxWithheld2TXW2MATH_NUMERICOPTNONE

The Tax Withheld for NR4 printing.

mnTotAdjTaxWithheld2ATXW2MATH_NUMERICOPTNONE

The adjusted amount of tax withheld for line 2 on the NR4 form.

mnTotAdjTaxWithheld1ATXW1MATH_NUMERICOPTNONE

The adjusted amount of tax withheld for line 1 on the NR4 form.

mnTotAdjGrossIncome1AGI1MATH_NUMERICOPTNONE

The adjusted amount of gross income for line 1 on the NR4 form.

mnTotAdjGrossIncome2AGI2MATH_NUMERICOPTNONE

The adjusted amount of gross income for line 2 on the NR4 form.

Related Functions

None

Related Tables

None
AddTableAmountsForAdjControls

AddTableAmountsForAdjControls

CA Year End Form Add, Subtract, Copy Amounts Functions

Minor Business Rule

Object Name: N7700085

Parent DLL: CPAY

Location: Client/Server

Language: NER

Data Structure

D7700085 - CA Year End Form Add, Subtract, Copy Amount Functions

Parameter NameData ItemData TypeReq/OptI/O/Both
szYearEndIdYEIDcharOPTNONE

A unique code that identifies a group of employees for whom you are processing year-end forms for a particular year. Use this ID to 
process each step of year-end processing.

mnTaxYearTAXYRMATH_NUMERICOPTNONE

The tax year, including the century.

mnAddressNumberAN8MATH_NUMERICOPTNONE

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

mnFormsIdFORMSIDMATH_NUMERICOPTNONE

A code that identifies the year-end form. Valid values are: 1 T4 2 Relevé 1 3 T4A 4 Relevé 2 5 NR4

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.

cAmendTypeAMNDTcharOPTNONE

The amend status of this record for this year-end ID. Valid values are: Blank Not amended 1 Amended

szTaxIdentificationNoTAXXcharOPTNONE

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.

szTaxAreaWorkTARAcharOPTNONE

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.

szFormDescriptionFORMDcharOPTNONE

The description or title of the form.

szSocialSecurityNumberSSNcharOPTNONE

A number that indicates the tax ID. In the United States, the tax ID is the social security number. In Canada, it is the social insurance number. 
If you add employee information for a non-US or non-Canadian company, you can leave this field blank. However, if the international code is 
set to Y and the default company is non-Canadian and non-United States, you can enter a 16-character number for the tax ID. The system 
does not permit duplicate tax ID numbers. Also, the number cannot include dashes. For example, if a social security number of nn-nn-nnnn is 
used, the number should be entered as follows: 123456789.

szNameAlphaALPHcharOPTNONE

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.

szCostCenterHomeHMCUcharOPTNONE

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

szProvOfEmplyT4PEcharOPTNONE

The 2-letter code indicating the Province of employment. Valid values are: AB Alberta BC British Columbia MB Manitoba NB New 
Brunswick NF Newfoundland NT Northwest Territories NS Nova Scotia ON Ontario PE Prince Edward Island QC Quebec SK Saskatchewan YT Yukon 
Territory ZZ Other Canadian Areas 

mnWagesFederalTaxableFDWGMATH_NUMERICOPTNONE

The amount of wages subject to Federal Income Tax.

mnAmountFederalTaxFDTXMATH_NUMERICOPTNONE

The amount of Federal Income Tax withheld for the employee.

mnProvincialTaxableWagesPRTXWMATH_NUMERICOPTNONE

The amount of provincial taxable wages.

mnProvincialIncomeTaxPRITXMATH_NUMERICOPTNONE

The amount of provincial income tax withheld from the employee's wages.

mnEiInsurableEarningsEIERMATH_NUMERICOPTNONE

The EI insurable earnings for T4 and Relevé 1 forms.

mnEiPremiumEIPMATH_NUMERICOPTNONE

The amount of Employment Insurance paid to the company by the employee.

mnPensionableEarningsCPPEMATH_NUMERICOPTNONE

Pensionable earnings that are calculated for T4/Releve forms.

mnCanadaPensionPlanCPPMATH_NUMERICOPTNONE

Employee contribution to the Canada Pension Plan.

mnQuebecPensionPlanQPPMATH_NUMERICOPTNONE

Employee contribution to the Quebec Pension Plan.

mnEiPremiumEmployerEIPRMATH_NUMERICOPTNONE

The amount of employment insurance paid by the company.

mnCppEmployerCPERMATH_NUMERICOPTNONE

Employer contribution to the Canadian Pension Plan.

mnQppEmployerQPERMATH_NUMERICOPTNONE

The employer contribution to the Quebec Pension Plan (QPP).

szEmploymentCodeT4ECcharOPTNONE

The employment code for the employee. Valid values are defined in user defined code table 77/EC.

cExemptCppQppECPPcharOPTNONE

A flag that shows if the employee was exempt from CPP/QPP for the ENTIRE year.    blank The employee was not exempt    X       The 
employee was exempt from CPP/QPP for the entire year.

cRecipientTypeNRCTcharOPTNONE

A code that classifies the recipient of the NR4 form. This code is printed on the NR4 form. Valid values are assigned by the Canada 
Customs and Revenue Agency (CCRA) and are defined in UDC 77Y/RT.

szCountryForPayrollCCPRcharOPTNONE

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

cExemptFromEiEEIcharOPTNONE

A flag that indicates whether the employee was exempt from EI for the entire year. Valid values are: Blank The employee was not 
exempt. X The employee was exempt from EI for the entire year.

cArchiveStatusARCScharOPTNONE

The archive status for this year-end ID. Valid values are: Blank Not executed A Active or in job queue 1 Completed

mnAdjustedFITWagesAFDWGMATH_NUMERICOPTNONE

The amount of adjusted wages subject to federal income tax.

mnAdjustedFederalIncomeTaxAFDTXMATH_NUMERICOPTNONE

The adjusted amount of federal income tax withheld from the employee's wages.

mnAdjustedProvincialTaxablAPRTXWMATH_NUMERICOPTNONE

The adjusted amount of provincial taxable wages.

mnAdjustedProvincialIncomeAPRITXMATH_NUMERICOPTNONE

The adjusted amount of provincial income tax withheld from the employee's wages.

mnAdjustedEiInsurableEarniAEIERMATH_NUMERICOPTNONE

The adjusted EI insurable earnings for T4 and Releve forms.

mnAdjustedEiPremiumAEIPMATH_NUMERICOPTNONE

The adjusted amount of employment insurance paid by the employee to the company.

mnAdjustedPensionableEarniACPPEMATH_NUMERICOPTNONE

The adjusted pensionable earnings that are calculated for T4/Relevé purposes.

mnAdjustedCanadaPensionPlanACPPMATH_NUMERICOPTNONE

Adjusted employee contribution to the Canada Pension Plan (CPP).

mnAdjustedQuebecPensionPlanAQPPMATH_NUMERICOPTNONE

The adjusted employee contribution to the Quebec Pension Plan (QPP).

mnTotAdjFITWagesAFDWGMATH_NUMERICOPTNONE

The amount of adjusted wages subject to federal income tax.

mnTotAdjFederalIncomeTaxAFDTXMATH_NUMERICOPTNONE

The adjusted amount of federal income tax withheld from the employee's wages.

mnTotAdjProvincTaxWagesAPRTXWMATH_NUMERICOPTNONE

The adjusted amount of provincial taxable wages.

mnTotAdjProvincIncomeTaxAPRITXMATH_NUMERICOPTNONE

The adjusted amount of provincial income tax withheld from the employee's wages.

mnTotAdjEiInsurableEarningsAEIERMATH_NUMERICOPTNONE

The adjusted EI insurable earnings for T4 and Releve forms.

mnTotAdjEiPremiumAEIPMATH_NUMERICOPTNONE

The adjusted amount of employment insurance paid by the employee to the company.

mnTotAdjPensionableEarningsACPPEMATH_NUMERICOPTNONE

The adjusted pensionable earnings that are calculated for T4/Relevé purposes.

mnTotAdjCPPACPPMATH_NUMERICOPTNONE

Adjusted employee contribution to the Canada Pension Plan (CPP).

mnTotAdjQPPAQPPMATH_NUMERICOPTNONE

The adjusted employee contribution to the Quebec Pension Plan (QPP).

szBoxNumber9BOXNcharOPTNONE

The number of the box as it appears on the year-end form.

mnAmount9AMNTMATH_NUMERICOPTNONE

An amount for a specific box on a year-end form.

mnAmountAdjustedAMTADJMATH_NUMERICOPTNONE

An adjusted amount. Enter the amount of the adjustment, not the amount after adjustment. For example, if an original amount of 400 should 
be corrected to 500, enter 100 in the Adjusted field.

mnTotAmountAdjustedAMTADJMATH_NUMERICOPTNONE

An adjusted amount. Enter the amount of the adjustment, not the amount after adjustment. For example, if an original amount of 400 should 
be corrected to 500, enter 100 in the Adjusted field.

szAdditionalTextATEXTcharOPTNONE

Text for a specific box on a year-end form. Use this field for boxes that require text rather than amounts.

cTableFlagEV01charOPTNONE

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

mnPrimaryFormControlNumberPFCNOMATH_NUMERICOPTNONE

A form control number.

mnSecondaryFormControlNumbSFCNOMATH_NUMERICOPTNONE

A secondary form control number.

mnGrossIncome1GI1MATH_NUMERICOPTNONE

The Gross Income for NR4 printing.

mnAdjustedGrossIncome1AGI1MATH_NUMERICOPTNONE

The adjusted amount of gross income for line 1 on the NR4 form.

mnGrossIncome2GI2MATH_NUMERICOPTNONE

The Gross Income for NR4 printing.

mnAdjustedGrossIncome2AGI2MATH_NUMERICOPTNONE

The adjusted amount of gross income for line 2 on the NR4 form.

mnTaxWithheld1TXW1MATH_NUMERICOPTNONE

The Tax Withheld for NR4 printing.

mnAdjustedTaxWithheld1ATXW1MATH_NUMERICOPTNONE

The adjusted amount of tax withheld for line 1 on the NR4 form.

mnAdjustedTaxWithheld2ATXW2MATH_NUMERICOPTNONE

The adjusted amount of tax withheld for line 2 on the NR4 form.

mnTaxWithheld2TXW2MATH_NUMERICOPTNONE

The Tax Withheld for NR4 printing.

mnTotAdjTaxWithheld2ATXW2MATH_NUMERICOPTNONE

The adjusted amount of tax withheld for line 2 on the NR4 form.

mnTotAdjTaxWithheld1ATXW1MATH_NUMERICOPTNONE

The adjusted amount of tax withheld for line 1 on the NR4 form.

mnTotAdjGrossIncome1AGI1MATH_NUMERICOPTNONE

The adjusted amount of gross income for line 1 on the NR4 form.

mnTotAdjGrossIncome2AGI2MATH_NUMERICOPTNONE

The adjusted amount of gross income for line 2 on the NR4 form.

Related Functions

None

Related Tables

None
AdjustmentNegativeAmountSearch

AdjustmentNegativeAmountSearch

CA Year End Form Add, Subtract, Copy Amounts Functions

Minor Business Rule

Object Name: N7700085

Parent DLL: CPAY

Location: Client/Server

Language: NER

Data Structure

D7700085D - CA Adjusted and Negative Amounts

Parameter NameData ItemData TypeReq/OptI/O/Both
szYearEndIdYEIDcharOPTNONE

A unique code that identifies a group of employees for whom you are processing year-end forms for a particular year. Use this ID to 
process each step of year-end processing.

mnTaxYearTAXYRMATH_NUMERICOPTNONE

The tax year, including the century.

mnAddressNumberAN8MATH_NUMERICOPTNONE

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

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.

szTaxAreaWorkTARAcharOPTNONE

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.

szTaxIdentificationNoTAXXcharOPTNONE

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.

mnFormsIdFORMSIDMATH_NUMERICOPTNONE

A code that identifies the year-end form. Valid values are: 1 T4 2 Relevé 1 3 T4A 4 Relevé 2 5 NR4

cAmendTypeAMNDTcharOPTNONE

The amend status of this record for this year-end ID. Valid values are: Blank Not amended 1 Amended

cAdjustmentFoundEV01charOPTNONE

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

cNegativeAmountFoundEV01charOPTNONE

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

szNERCalledFromProgamIdPIDcharOPTNONE

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.

Related Functions

None

Related Tables

None
CheckToSeeIfNegativeValuesinWF

CheckToSeeIfNegativeValuesinWF

CA Year End Form Add, Subtract, Copy Amounts Functions

Minor Business Rule

Object Name: N7700085

Parent DLL: CPAY

Location: Client/Server

Language: NER

Data Structure

D7700085 - CA Year End Form Add, Subtract, Copy Amount Functions

Parameter NameData ItemData TypeReq/OptI/O/Both
szYearEndIdYEIDcharOPTNONE

A unique code that identifies a group of employees for whom you are processing year-end forms for a particular year. Use this ID to 
process each step of year-end processing.

mnTaxYearTAXYRMATH_NUMERICOPTNONE

The tax year, including the century.

mnAddressNumberAN8MATH_NUMERICOPTNONE

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

mnFormsIdFORMSIDMATH_NUMERICOPTNONE

A code that identifies the year-end form. Valid values are: 1 T4 2 Relevé 1 3 T4A 4 Relevé 2 5 NR4

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.

cAmendTypeAMNDTcharOPTNONE

The amend status of this record for this year-end ID. Valid values are: Blank Not amended 1 Amended

szTaxIdentificationNoTAXXcharOPTNONE

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.

szTaxAreaWorkTARAcharOPTNONE

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.

szFormDescriptionFORMDcharOPTNONE

The description or title of the form.

szSocialSecurityNumberSSNcharOPTNONE

A number that indicates the tax ID. In the United States, the tax ID is the social security number. In Canada, it is the social insurance number. 
If you add employee information for a non-US or non-Canadian company, you can leave this field blank. However, if the international code is 
set to Y and the default company is non-Canadian and non-United States, you can enter a 16-character number for the tax ID. The system 
does not permit duplicate tax ID numbers. Also, the number cannot include dashes. For example, if a social security number of nn-nn-nnnn is 
used, the number should be entered as follows: 123456789.

szNameAlphaALPHcharOPTNONE

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.

szCostCenterHomeHMCUcharOPTNONE

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

szProvOfEmplyT4PEcharOPTNONE

The 2-letter code indicating the Province of employment. Valid values are: AB Alberta BC British Columbia MB Manitoba NB New 
Brunswick NF Newfoundland NT Northwest Territories NS Nova Scotia ON Ontario PE Prince Edward Island QC Quebec SK Saskatchewan YT Yukon 
Territory ZZ Other Canadian Areas 

mnWagesFederalTaxableFDWGMATH_NUMERICOPTNONE

The amount of wages subject to Federal Income Tax.

mnAmountFederalTaxFDTXMATH_NUMERICOPTNONE

The amount of Federal Income Tax withheld for the employee.

mnProvincialTaxableWagesPRTXWMATH_NUMERICOPTNONE

The amount of provincial taxable wages.

mnProvincialIncomeTaxPRITXMATH_NUMERICOPTNONE

The amount of provincial income tax withheld from the employee's wages.

mnEiInsurableEarningsEIERMATH_NUMERICOPTNONE

The EI insurable earnings for T4 and Relevé 1 forms.

mnEiPremiumEIPMATH_NUMERICOPTNONE

The amount of Employment Insurance paid to the company by the employee.

mnPensionableEarningsCPPEMATH_NUMERICOPTNONE

Pensionable earnings that are calculated for T4/Releve forms.

mnCanadaPensionPlanCPPMATH_NUMERICOPTNONE

Employee contribution to the Canada Pension Plan.

mnQuebecPensionPlanQPPMATH_NUMERICOPTNONE

Employee contribution to the Quebec Pension Plan.

mnEiPremiumEmployerEIPRMATH_NUMERICOPTNONE

The amount of employment insurance paid by the company.

mnCppEmployerCPERMATH_NUMERICOPTNONE

Employer contribution to the Canadian Pension Plan.

mnQppEmployerQPERMATH_NUMERICOPTNONE

The employer contribution to the Quebec Pension Plan (QPP).

szEmploymentCodeT4ECcharOPTNONE

The employment code for the employee. Valid values are defined in user defined code table 77/EC.

cExemptCppQppECPPcharOPTNONE

A flag that shows if the employee was exempt from CPP/QPP for the ENTIRE year.    blank The employee was not exempt    X       The 
employee was exempt from CPP/QPP for the entire year.

cRecipientTypeNRCTcharOPTNONE

A code that classifies the recipient of the NR4 form. This code is printed on the NR4 form. Valid values are assigned by the Canada 
Customs and Revenue Agency (CCRA) and are defined in UDC 77Y/RT.

szCountryForPayrollCCPRcharOPTNONE

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

cExemptFromEiEEIcharOPTNONE

A flag that indicates whether the employee was exempt from EI for the entire year. Valid values are: Blank The employee was not 
exempt. X The employee was exempt from EI for the entire year.

cArchiveStatusARCScharOPTNONE

The archive status for this year-end ID. Valid values are: Blank Not executed A Active or in job queue 1 Completed

mnAdjustedFITWagesAFDWGMATH_NUMERICOPTNONE

The amount of adjusted wages subject to federal income tax.

mnAdjustedFederalIncomeTaxAFDTXMATH_NUMERICOPTNONE

The adjusted amount of federal income tax withheld from the employee's wages.

mnAdjustedProvincialTaxablAPRTXWMATH_NUMERICOPTNONE

The adjusted amount of provincial taxable wages.

mnAdjustedProvincialIncomeAPRITXMATH_NUMERICOPTNONE

The adjusted amount of provincial income tax withheld from the employee's wages.

mnAdjustedEiInsurableEarniAEIERMATH_NUMERICOPTNONE

The adjusted EI insurable earnings for T4 and Releve forms.

mnAdjustedEiPremiumAEIPMATH_NUMERICOPTNONE

The adjusted amount of employment insurance paid by the employee to the company.

mnAdjustedPensionableEarniACPPEMATH_NUMERICOPTNONE

The adjusted pensionable earnings that are calculated for T4/Relevé purposes.

mnAdjustedCanadaPensionPlanACPPMATH_NUMERICOPTNONE

Adjusted employee contribution to the Canada Pension Plan (CPP).

mnAdjustedQuebecPensionPlanAQPPMATH_NUMERICOPTNONE

The adjusted employee contribution to the Quebec Pension Plan (QPP).

mnTotAdjFITWagesAFDWGMATH_NUMERICOPTNONE

The amount of adjusted wages subject to federal income tax.

mnTotAdjFederalIncomeTaxAFDTXMATH_NUMERICOPTNONE

The adjusted amount of federal income tax withheld from the employee's wages.

mnTotAdjProvincTaxWagesAPRTXWMATH_NUMERICOPTNONE

The adjusted amount of provincial taxable wages.

mnTotAdjProvincIncomeTaxAPRITXMATH_NUMERICOPTNONE

The adjusted amount of provincial income tax withheld from the employee's wages.

mnTotAdjEiInsurableEarningsAEIERMATH_NUMERICOPTNONE

The adjusted EI insurable earnings for T4 and Releve forms.

mnTotAdjEiPremiumAEIPMATH_NUMERICOPTNONE

The adjusted amount of employment insurance paid by the employee to the company.

mnTotAdjPensionableEarningsACPPEMATH_NUMERICOPTNONE

The adjusted pensionable earnings that are calculated for T4/Relevé purposes.

mnTotAdjCPPACPPMATH_NUMERICOPTNONE

Adjusted employee contribution to the Canada Pension Plan (CPP).

mnTotAdjQPPAQPPMATH_NUMERICOPTNONE

The adjusted employee contribution to the Quebec Pension Plan (QPP).

szBoxNumber9BOXNcharOPTNONE

The number of the box as it appears on the year-end form.

mnAmount9AMNTMATH_NUMERICOPTNONE

An amount for a specific box on a year-end form.

mnAmountAdjustedAMTADJMATH_NUMERICOPTNONE

An adjusted amount. Enter the amount of the adjustment, not the amount after adjustment. For example, if an original amount of 400 should 
be corrected to 500, enter 100 in the Adjusted field.

mnTotAmountAdjustedAMTADJMATH_NUMERICOPTNONE

An adjusted amount. Enter the amount of the adjustment, not the amount after adjustment. For example, if an original amount of 400 should 
be corrected to 500, enter 100 in the Adjusted field.

szAdditionalTextATEXTcharOPTNONE

Text for a specific box on a year-end form. Use this field for boxes that require text rather than amounts.

cTableFlagEV01charOPTNONE

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

mnPrimaryFormControlNumberPFCNOMATH_NUMERICOPTNONE

A form control number.

mnSecondaryFormControlNumbSFCNOMATH_NUMERICOPTNONE

A secondary form control number.

mnGrossIncome1GI1MATH_NUMERICOPTNONE

The Gross Income for NR4 printing.

mnAdjustedGrossIncome1AGI1MATH_NUMERICOPTNONE

The adjusted amount of gross income for line 1 on the NR4 form.

mnGrossIncome2GI2MATH_NUMERICOPTNONE

The Gross Income for NR4 printing.

mnAdjustedGrossIncome2AGI2MATH_NUMERICOPTNONE

The adjusted amount of gross income for line 2 on the NR4 form.

mnTaxWithheld1TXW1MATH_NUMERICOPTNONE

The Tax Withheld for NR4 printing.

mnAdjustedTaxWithheld1ATXW1MATH_NUMERICOPTNONE

The adjusted amount of tax withheld for line 1 on the NR4 form.

mnAdjustedTaxWithheld2ATXW2MATH_NUMERICOPTNONE

The adjusted amount of tax withheld for line 2 on the NR4 form.

mnTaxWithheld2TXW2MATH_NUMERICOPTNONE

The Tax Withheld for NR4 printing.

mnTotAdjTaxWithheld2ATXW2MATH_NUMERICOPTNONE

The adjusted amount of tax withheld for line 2 on the NR4 form.

mnTotAdjTaxWithheld1ATXW1MATH_NUMERICOPTNONE

The adjusted amount of tax withheld for line 1 on the NR4 form.

mnTotAdjGrossIncome1AGI1MATH_NUMERICOPTNONE

The adjusted amount of gross income for line 1 on the NR4 form.

mnTotAdjGrossIncome2AGI2MATH_NUMERICOPTNONE

The adjusted amount of gross income for line 2 on the NR4 form.

Related Functions

None

Related Tables

None
CopyOldRecordToNewAmendRecord

CopyOldRecordToNewAmendRecord

CA Year End Form Add, Subtract, Copy Amounts Functions

Minor Business Rule

Object Name: N7700085

Parent DLL: CPAY

Location: Client/Server

Language: NER

Data Structure

D7700085 - CA Year End Form Add, Subtract, Copy Amount Functions

Parameter NameData ItemData TypeReq/OptI/O/Both
szYearEndIdYEIDcharOPTNONE

A unique code that identifies a group of employees for whom you are processing year-end forms for a particular year. Use this ID to 
process each step of year-end processing.

mnTaxYearTAXYRMATH_NUMERICOPTNONE

The tax year, including the century.

mnAddressNumberAN8MATH_NUMERICOPTNONE

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

mnFormsIdFORMSIDMATH_NUMERICOPTNONE

A code that identifies the year-end form. Valid values are: 1 T4 2 Relevé 1 3 T4A 4 Relevé 2 5 NR4

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.

cAmendTypeAMNDTcharOPTNONE

The amend status of this record for this year-end ID. Valid values are: Blank Not amended 1 Amended

szTaxIdentificationNoTAXXcharOPTNONE

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.

szTaxAreaWorkTARAcharOPTNONE

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.

szFormDescriptionFORMDcharOPTNONE

The description or title of the form.

szSocialSecurityNumberSSNcharOPTNONE

A number that indicates the tax ID. In the United States, the tax ID is the social security number. In Canada, it is the social insurance number. 
If you add employee information for a non-US or non-Canadian company, you can leave this field blank. However, if the international code is 
set to Y and the default company is non-Canadian and non-United States, you can enter a 16-character number for the tax ID. The system 
does not permit duplicate tax ID numbers. Also, the number cannot include dashes. For example, if a social security number of nn-nn-nnnn is 
used, the number should be entered as follows: 123456789.

szNameAlphaALPHcharOPTNONE

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.

szCostCenterHomeHMCUcharOPTNONE

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

szProvOfEmplyT4PEcharOPTNONE

The 2-letter code indicating the Province of employment. Valid values are: AB Alberta BC British Columbia MB Manitoba NB New 
Brunswick NF Newfoundland NT Northwest Territories NS Nova Scotia ON Ontario PE Prince Edward Island QC Quebec SK Saskatchewan YT Yukon 
Territory ZZ Other Canadian Areas 

mnWagesFederalTaxableFDWGMATH_NUMERICOPTNONE

The amount of wages subject to Federal Income Tax.

mnAmountFederalTaxFDTXMATH_NUMERICOPTNONE

The amount of Federal Income Tax withheld for the employee.

mnProvincialTaxableWagesPRTXWMATH_NUMERICOPTNONE

The amount of provincial taxable wages.

mnProvincialIncomeTaxPRITXMATH_NUMERICOPTNONE

The amount of provincial income tax withheld from the employee's wages.

mnEiInsurableEarningsEIERMATH_NUMERICOPTNONE

The EI insurable earnings for T4 and Relevé 1 forms.

mnEiPremiumEIPMATH_NUMERICOPTNONE

The amount of Employment Insurance paid to the company by the employee.

mnPensionableEarningsCPPEMATH_NUMERICOPTNONE

Pensionable earnings that are calculated for T4/Releve forms.

mnCanadaPensionPlanCPPMATH_NUMERICOPTNONE

Employee contribution to the Canada Pension Plan.

mnQuebecPensionPlanQPPMATH_NUMERICOPTNONE

Employee contribution to the Quebec Pension Plan.

mnEiPremiumEmployerEIPRMATH_NUMERICOPTNONE

The amount of employment insurance paid by the company.

mnCppEmployerCPERMATH_NUMERICOPTNONE

Employer contribution to the Canadian Pension Plan.

mnQppEmployerQPERMATH_NUMERICOPTNONE

The employer contribution to the Quebec Pension Plan (QPP).

szEmploymentCodeT4ECcharOPTNONE

The employment code for the employee. Valid values are defined in user defined code table 77/EC.

cExemptCppQppECPPcharOPTNONE

A flag that shows if the employee was exempt from CPP/QPP for the ENTIRE year.    blank The employee was not exempt    X       The 
employee was exempt from CPP/QPP for the entire year.

cRecipientTypeNRCTcharOPTNONE

A code that classifies the recipient of the NR4 form. This code is printed on the NR4 form. Valid values are assigned by the Canada 
Customs and Revenue Agency (CCRA) and are defined in UDC 77Y/RT.

szCountryForPayrollCCPRcharOPTNONE

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

cExemptFromEiEEIcharOPTNONE

A flag that indicates whether the employee was exempt from EI for the entire year. Valid values are: Blank The employee was not 
exempt. X The employee was exempt from EI for the entire year.

cArchiveStatusARCScharOPTNONE

The archive status for this year-end ID. Valid values are: Blank Not executed A Active or in job queue 1 Completed

mnAdjustedFITWagesAFDWGMATH_NUMERICOPTNONE

The amount of adjusted wages subject to federal income tax.

mnAdjustedFederalIncomeTaxAFDTXMATH_NUMERICOPTNONE

The adjusted amount of federal income tax withheld from the employee's wages.

mnAdjustedProvincialTaxablAPRTXWMATH_NUMERICOPTNONE

The adjusted amount of provincial taxable wages.

mnAdjustedProvincialIncomeAPRITXMATH_NUMERICOPTNONE

The adjusted amount of provincial income tax withheld from the employee's wages.

mnAdjustedEiInsurableEarniAEIERMATH_NUMERICOPTNONE

The adjusted EI insurable earnings for T4 and Releve forms.

mnAdjustedEiPremiumAEIPMATH_NUMERICOPTNONE

The adjusted amount of employment insurance paid by the employee to the company.

mnAdjustedPensionableEarniACPPEMATH_NUMERICOPTNONE

The adjusted pensionable earnings that are calculated for T4/Relevé purposes.

mnAdjustedCanadaPensionPlanACPPMATH_NUMERICOPTNONE

Adjusted employee contribution to the Canada Pension Plan (CPP).

mnAdjustedQuebecPensionPlanAQPPMATH_NUMERICOPTNONE

The adjusted employee contribution to the Quebec Pension Plan (QPP).

mnTotAdjFITWagesAFDWGMATH_NUMERICOPTNONE

The amount of adjusted wages subject to federal income tax.

mnTotAdjFederalIncomeTaxAFDTXMATH_NUMERICOPTNONE

The adjusted amount of federal income tax withheld from the employee's wages.

mnTotAdjProvincTaxWagesAPRTXWMATH_NUMERICOPTNONE

The adjusted amount of provincial taxable wages.

mnTotAdjProvincIncomeTaxAPRITXMATH_NUMERICOPTNONE

The adjusted amount of provincial income tax withheld from the employee's wages.

mnTotAdjEiInsurableEarningsAEIERMATH_NUMERICOPTNONE

The adjusted EI insurable earnings for T4 and Releve forms.

mnTotAdjEiPremiumAEIPMATH_NUMERICOPTNONE

The adjusted amount of employment insurance paid by the employee to the company.

mnTotAdjPensionableEarningsACPPEMATH_NUMERICOPTNONE

The adjusted pensionable earnings that are calculated for T4/Relevé purposes.

mnTotAdjCPPACPPMATH_NUMERICOPTNONE

Adjusted employee contribution to the Canada Pension Plan (CPP).

mnTotAdjQPPAQPPMATH_NUMERICOPTNONE

The adjusted employee contribution to the Quebec Pension Plan (QPP).

szBoxNumber9BOXNcharOPTNONE

The number of the box as it appears on the year-end form.

mnAmount9AMNTMATH_NUMERICOPTNONE

An amount for a specific box on a year-end form.

mnAmountAdjustedAMTADJMATH_NUMERICOPTNONE

An adjusted amount. Enter the amount of the adjustment, not the amount after adjustment. For example, if an original amount of 400 should 
be corrected to 500, enter 100 in the Adjusted field.

mnTotAmountAdjustedAMTADJMATH_NUMERICOPTNONE

An adjusted amount. Enter the amount of the adjustment, not the amount after adjustment. For example, if an original amount of 400 should 
be corrected to 500, enter 100 in the Adjusted field.

szAdditionalTextATEXTcharOPTNONE

Text for a specific box on a year-end form. Use this field for boxes that require text rather than amounts.

cTableFlagEV01charOPTNONE

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

mnPrimaryFormControlNumberPFCNOMATH_NUMERICOPTNONE

A form control number.

mnSecondaryFormControlNumbSFCNOMATH_NUMERICOPTNONE

A secondary form control number.

mnGrossIncome1GI1MATH_NUMERICOPTNONE

The Gross Income for NR4 printing.

mnAdjustedGrossIncome1AGI1MATH_NUMERICOPTNONE

The adjusted amount of gross income for line 1 on the NR4 form.

mnGrossIncome2GI2MATH_NUMERICOPTNONE

The Gross Income for NR4 printing.

mnAdjustedGrossIncome2AGI2MATH_NUMERICOPTNONE

The adjusted amount of gross income for line 2 on the NR4 form.

mnTaxWithheld1TXW1MATH_NUMERICOPTNONE

The Tax Withheld for NR4 printing.

mnAdjustedTaxWithheld1ATXW1MATH_NUMERICOPTNONE

The adjusted amount of tax withheld for line 1 on the NR4 form.

mnAdjustedTaxWithheld2ATXW2MATH_NUMERICOPTNONE

The adjusted amount of tax withheld for line 2 on the NR4 form.

mnTaxWithheld2TXW2MATH_NUMERICOPTNONE

The Tax Withheld for NR4 printing.

mnTotAdjTaxWithheld2ATXW2MATH_NUMERICOPTNONE

The adjusted amount of tax withheld for line 2 on the NR4 form.

mnTotAdjTaxWithheld1ATXW1MATH_NUMERICOPTNONE

The adjusted amount of tax withheld for line 1 on the NR4 form.

mnTotAdjGrossIncome1AGI1MATH_NUMERICOPTNONE

The adjusted amount of gross income for line 1 on the NR4 form.

mnTotAdjGrossIncome2AGI2MATH_NUMERICOPTNONE

The adjusted amount of gross income for line 2 on the NR4 form.

Related Functions

None

Related Tables

None
CreateAmendedRecord

CreateAmendedRecord

CA Year End Form Add, Subtract, Copy Amounts Functions

Minor Business Rule

Object Name: N7700085

Parent DLL: CPAY

Location: Client/Server

Language: NER

Data Structure

D7700085C - CA Year End Amend

Parameter NameData ItemData TypeReq/OptI/O/Both
szYearEndIdYEIDcharOPTNONE

A unique code that identifies a group of employees for whom you are processing year-end forms for a particular year. Use this ID to 
process each step of year-end processing.

mnTaxYearTAXYRMATH_NUMERICOPTNONE

The tax year, including the century.

mnFormsIdFORMSIDMATH_NUMERICOPTNONE

A code that identifies the year-end form. Valid values are: 1 T4 2 Relevé 1 3 T4A 4 Relevé 2 5 NR4

mnAddressNumberAN8MATH_NUMERICOPTNONE

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

szTaxIdentificationNoTAXXcharOPTNONE

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.

szTaxAreaWorkTARAcharOPTNONE

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.

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.

cAmendedNotAmendedEV01charOPTNONE

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

Related Functions

None

Related Tables

None
F77200Insert

F77200Insert

CA Year End Form Add, Subtract, Copy Amounts Functions

Minor Business Rule

Object Name: N7700085

Parent DLL: CPAY

Location: Client/Server

Language: NER

Data Structure

D7700085 - CA Year End Form Add, Subtract, Copy Amount Functions

Parameter NameData ItemData TypeReq/OptI/O/Both
szYearEndIdYEIDcharOPTNONE

A unique code that identifies a group of employees for whom you are processing year-end forms for a particular year. Use this ID to 
process each step of year-end processing.

mnTaxYearTAXYRMATH_NUMERICOPTNONE

The tax year, including the century.

mnAddressNumberAN8MATH_NUMERICOPTNONE

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

mnFormsIdFORMSIDMATH_NUMERICOPTNONE

A code that identifies the year-end form. Valid values are: 1 T4 2 Relevé 1 3 T4A 4 Relevé 2 5 NR4

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.

cAmendTypeAMNDTcharOPTNONE

The amend status of this record for this year-end ID. Valid values are: Blank Not amended 1 Amended

szTaxIdentificationNoTAXXcharOPTNONE

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.

szTaxAreaWorkTARAcharOPTNONE

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.

szFormDescriptionFORMDcharOPTNONE

The description or title of the form.

szSocialSecurityNumberSSNcharOPTNONE

A number that indicates the tax ID. In the United States, the tax ID is the social security number. In Canada, it is the social insurance number. 
If you add employee information for a non-US or non-Canadian company, you can leave this field blank. However, if the international code is 
set to Y and the default company is non-Canadian and non-United States, you can enter a 16-character number for the tax ID. The system 
does not permit duplicate tax ID numbers. Also, the number cannot include dashes. For example, if a social security number of nn-nn-nnnn is 
used, the number should be entered as follows: 123456789.

szNameAlphaALPHcharOPTNONE

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.

szCostCenterHomeHMCUcharOPTNONE

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

szProvOfEmplyT4PEcharOPTNONE

The 2-letter code indicating the Province of employment. Valid values are: AB Alberta BC British Columbia MB Manitoba NB New 
Brunswick NF Newfoundland NT Northwest Territories NS Nova Scotia ON Ontario PE Prince Edward Island QC Quebec SK Saskatchewan YT Yukon 
Territory ZZ Other Canadian Areas 

mnWagesFederalTaxableFDWGMATH_NUMERICOPTNONE

The amount of wages subject to Federal Income Tax.

mnAmountFederalTaxFDTXMATH_NUMERICOPTNONE

The amount of Federal Income Tax withheld for the employee.

mnProvincialTaxableWagesPRTXWMATH_NUMERICOPTNONE

The amount of provincial taxable wages.

mnProvincialIncomeTaxPRITXMATH_NUMERICOPTNONE

The amount of provincial income tax withheld from the employee's wages.

mnEiInsurableEarningsEIERMATH_NUMERICOPTNONE

The EI insurable earnings for T4 and Relevé 1 forms.

mnEiPremiumEIPMATH_NUMERICOPTNONE

The amount of Employment Insurance paid to the company by the employee.

mnPensionableEarningsCPPEMATH_NUMERICOPTNONE

Pensionable earnings that are calculated for T4/Releve forms.

mnCanadaPensionPlanCPPMATH_NUMERICOPTNONE

Employee contribution to the Canada Pension Plan.

mnQuebecPensionPlanQPPMATH_NUMERICOPTNONE

Employee contribution to the Quebec Pension Plan.

mnEiPremiumEmployerEIPRMATH_NUMERICOPTNONE

The amount of employment insurance paid by the company.

mnCppEmployerCPERMATH_NUMERICOPTNONE

Employer contribution to the Canadian Pension Plan.

mnQppEmployerQPERMATH_NUMERICOPTNONE

The employer contribution to the Quebec Pension Plan (QPP).

szEmploymentCodeT4ECcharOPTNONE

The employment code for the employee. Valid values are defined in user defined code table 77/EC.

cExemptCppQppECPPcharOPTNONE

A flag that shows if the employee was exempt from CPP/QPP for the ENTIRE year.    blank The employee was not exempt    X       The 
employee was exempt from CPP/QPP for the entire year.

cRecipientTypeNRCTcharOPTNONE

A code that classifies the recipient of the NR4 form. This code is printed on the NR4 form. Valid values are assigned by the Canada 
Customs and Revenue Agency (CCRA) and are defined in UDC 77Y/RT.

szCountryForPayrollCCPRcharOPTNONE

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

cExemptFromEiEEIcharOPTNONE

A flag that indicates whether the employee was exempt from EI for the entire year. Valid values are: Blank The employee was not 
exempt. X The employee was exempt from EI for the entire year.

cArchiveStatusARCScharOPTNONE

The archive status for this year-end ID. Valid values are: Blank Not executed A Active or in job queue 1 Completed

mnAdjustedFITWagesAFDWGMATH_NUMERICOPTNONE

The amount of adjusted wages subject to federal income tax.

mnAdjustedFederalIncomeTaxAFDTXMATH_NUMERICOPTNONE

The adjusted amount of federal income tax withheld from the employee's wages.

mnAdjustedProvincialTaxablAPRTXWMATH_NUMERICOPTNONE

The adjusted amount of provincial taxable wages.

mnAdjustedProvincialIncomeAPRITXMATH_NUMERICOPTNONE

The adjusted amount of provincial income tax withheld from the employee's wages.

mnAdjustedEiInsurableEarniAEIERMATH_NUMERICOPTNONE

The adjusted EI insurable earnings for T4 and Releve forms.

mnAdjustedEiPremiumAEIPMATH_NUMERICOPTNONE

The adjusted amount of employment insurance paid by the employee to the company.

mnAdjustedPensionableEarniACPPEMATH_NUMERICOPTNONE

The adjusted pensionable earnings that are calculated for T4/Relevé purposes.

mnAdjustedCanadaPensionPlanACPPMATH_NUMERICOPTNONE

Adjusted employee contribution to the Canada Pension Plan (CPP).

mnAdjustedQuebecPensionPlanAQPPMATH_NUMERICOPTNONE

The adjusted employee contribution to the Quebec Pension Plan (QPP).

mnTotAdjFITWagesAFDWGMATH_NUMERICOPTNONE

The amount of adjusted wages subject to federal income tax.

mnTotAdjFederalIncomeTaxAFDTXMATH_NUMERICOPTNONE

The adjusted amount of federal income tax withheld from the employee's wages.

mnTotAdjProvincTaxWagesAPRTXWMATH_NUMERICOPTNONE

The adjusted amount of provincial taxable wages.

mnTotAdjProvincIncomeTaxAPRITXMATH_NUMERICOPTNONE

The adjusted amount of provincial income tax withheld from the employee's wages.

mnTotAdjEiInsurableEarningsAEIERMATH_NUMERICOPTNONE

The adjusted EI insurable earnings for T4 and Releve forms.

mnTotAdjEiPremiumAEIPMATH_NUMERICOPTNONE

The adjusted amount of employment insurance paid by the employee to the company.

mnTotAdjPensionableEarningsACPPEMATH_NUMERICOPTNONE

The adjusted pensionable earnings that are calculated for T4/Relevé purposes.

mnTotAdjCPPACPPMATH_NUMERICOPTNONE

Adjusted employee contribution to the Canada Pension Plan (CPP).

mnTotAdjQPPAQPPMATH_NUMERICOPTNONE

The adjusted employee contribution to the Quebec Pension Plan (QPP).

szBoxNumber9BOXNcharOPTNONE

The number of the box as it appears on the year-end form.

mnAmount9AMNTMATH_NUMERICOPTNONE

An amount for a specific box on a year-end form.

mnAmountAdjustedAMTADJMATH_NUMERICOPTNONE

An adjusted amount. Enter the amount of the adjustment, not the amount after adjustment. For example, if an original amount of 400 should 
be corrected to 500, enter 100 in the Adjusted field.

mnTotAmountAdjustedAMTADJMATH_NUMERICOPTNONE

An adjusted amount. Enter the amount of the adjustment, not the amount after adjustment. For example, if an original amount of 400 should 
be corrected to 500, enter 100 in the Adjusted field.

szAdditionalTextATEXTcharOPTNONE

Text for a specific box on a year-end form. Use this field for boxes that require text rather than amounts.

cTableFlagEV01charOPTNONE

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

mnPrimaryFormControlNumberPFCNOMATH_NUMERICOPTNONE

A form control number.

mnSecondaryFormControlNumbSFCNOMATH_NUMERICOPTNONE

A secondary form control number.

mnGrossIncome1GI1MATH_NUMERICOPTNONE

The Gross Income for NR4 printing.

mnAdjustedGrossIncome1AGI1MATH_NUMERICOPTNONE

The adjusted amount of gross income for line 1 on the NR4 form.

mnGrossIncome2GI2MATH_NUMERICOPTNONE

The Gross Income for NR4 printing.

mnAdjustedGrossIncome2AGI2MATH_NUMERICOPTNONE

The adjusted amount of gross income for line 2 on the NR4 form.

mnTaxWithheld1TXW1MATH_NUMERICOPTNONE

The Tax Withheld for NR4 printing.

mnAdjustedTaxWithheld1ATXW1MATH_NUMERICOPTNONE

The adjusted amount of tax withheld for line 1 on the NR4 form.

mnAdjustedTaxWithheld2ATXW2MATH_NUMERICOPTNONE

The adjusted amount of tax withheld for line 2 on the NR4 form.

mnTaxWithheld2TXW2MATH_NUMERICOPTNONE

The Tax Withheld for NR4 printing.

mnTotAdjTaxWithheld2ATXW2MATH_NUMERICOPTNONE

The adjusted amount of tax withheld for line 2 on the NR4 form.

mnTotAdjTaxWithheld1ATXW1MATH_NUMERICOPTNONE

The adjusted amount of tax withheld for line 1 on the NR4 form.

mnTotAdjGrossIncome1AGI1MATH_NUMERICOPTNONE

The adjusted amount of gross income for line 1 on the NR4 form.

mnTotAdjGrossIncome2AGI2MATH_NUMERICOPTNONE

The adjusted amount of gross income for line 2 on the NR4 form.

Related Functions

None

Related Tables

None
F77200Update

F77200Update

CA Year End Form Add, Subtract, Copy Amounts Functions

Minor Business Rule

Object Name: N7700085

Parent DLL: CPAY

Location: Client/Server

Language: NER

Data Structure

D7700085 - CA Year End Form Add, Subtract, Copy Amount Functions

Parameter NameData ItemData TypeReq/OptI/O/Both
szYearEndIdYEIDcharOPTNONE

A unique code that identifies a group of employees for whom you are processing year-end forms for a particular year. Use this ID to 
process each step of year-end processing.

mnTaxYearTAXYRMATH_NUMERICOPTNONE

The tax year, including the century.

mnAddressNumberAN8MATH_NUMERICOPTNONE

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

mnFormsIdFORMSIDMATH_NUMERICOPTNONE

A code that identifies the year-end form. Valid values are: 1 T4 2 Relevé 1 3 T4A 4 Relevé 2 5 NR4

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.

cAmendTypeAMNDTcharOPTNONE

The amend status of this record for this year-end ID. Valid values are: Blank Not amended 1 Amended

szTaxIdentificationNoTAXXcharOPTNONE

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.

szTaxAreaWorkTARAcharOPTNONE

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.

szFormDescriptionFORMDcharOPTNONE

The description or title of the form.

szSocialSecurityNumberSSNcharOPTNONE

A number that indicates the tax ID. In the United States, the tax ID is the social security number. In Canada, it is the social insurance number. 
If you add employee information for a non-US or non-Canadian company, you can leave this field blank. However, if the international code is 
set to Y and the default company is non-Canadian and non-United States, you can enter a 16-character number for the tax ID. The system 
does not permit duplicate tax ID numbers. Also, the number cannot include dashes. For example, if a social security number of nn-nn-nnnn is 
used, the number should be entered as follows: 123456789.

szNameAlphaALPHcharOPTNONE

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.

szCostCenterHomeHMCUcharOPTNONE

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

szProvOfEmplyT4PEcharOPTNONE

The 2-letter code indicating the Province of employment. Valid values are: AB Alberta BC British Columbia MB Manitoba NB New 
Brunswick NF Newfoundland NT Northwest Territories NS Nova Scotia ON Ontario PE Prince Edward Island QC Quebec SK Saskatchewan YT Yukon 
Territory ZZ Other Canadian Areas 

mnWagesFederalTaxableFDWGMATH_NUMERICOPTNONE

The amount of wages subject to Federal Income Tax.

mnAmountFederalTaxFDTXMATH_NUMERICOPTNONE

The amount of Federal Income Tax withheld for the employee.

mnProvincialTaxableWagesPRTXWMATH_NUMERICOPTNONE

The amount of provincial taxable wages.

mnProvincialIncomeTaxPRITXMATH_NUMERICOPTNONE

The amount of provincial income tax withheld from the employee's wages.

mnEiInsurableEarningsEIERMATH_NUMERICOPTNONE

The EI insurable earnings for T4 and Relevé 1 forms.

mnEiPremiumEIPMATH_NUMERICOPTNONE

The amount of Employment Insurance paid to the company by the employee.

mnPensionableEarningsCPPEMATH_NUMERICOPTNONE

Pensionable earnings that are calculated for T4/Releve forms.

mnCanadaPensionPlanCPPMATH_NUMERICOPTNONE

Employee contribution to the Canada Pension Plan.

mnQuebecPensionPlanQPPMATH_NUMERICOPTNONE

Employee contribution to the Quebec Pension Plan.

mnEiPremiumEmployerEIPRMATH_NUMERICOPTNONE

The amount of employment insurance paid by the company.

mnCppEmployerCPERMATH_NUMERICOPTNONE

Employer contribution to the Canadian Pension Plan.

mnQppEmployerQPERMATH_NUMERICOPTNONE

The employer contribution to the Quebec Pension Plan (QPP).

szEmploymentCodeT4ECcharOPTNONE

The employment code for the employee. Valid values are defined in user defined code table 77/EC.

cExemptCppQppECPPcharOPTNONE

A flag that shows if the employee was exempt from CPP/QPP for the ENTIRE year.    blank The employee was not exempt    X       The 
employee was exempt from CPP/QPP for the entire year.

cRecipientTypeNRCTcharOPTNONE

A code that classifies the recipient of the NR4 form. This code is printed on the NR4 form. Valid values are assigned by the Canada 
Customs and Revenue Agency (CCRA) and are defined in UDC 77Y/RT.

szCountryForPayrollCCPRcharOPTNONE

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

cExemptFromEiEEIcharOPTNONE

A flag that indicates whether the employee was exempt from EI for the entire year. Valid values are: Blank The employee was not 
exempt. X The employee was exempt from EI for the entire year.

cArchiveStatusARCScharOPTNONE

The archive status for this year-end ID. Valid values are: Blank Not executed A Active or in job queue 1 Completed

mnAdjustedFITWagesAFDWGMATH_NUMERICOPTNONE

The amount of adjusted wages subject to federal income tax.

mnAdjustedFederalIncomeTaxAFDTXMATH_NUMERICOPTNONE

The adjusted amount of federal income tax withheld from the employee's wages.

mnAdjustedProvincialTaxablAPRTXWMATH_NUMERICOPTNONE

The adjusted amount of provincial taxable wages.

mnAdjustedProvincialIncomeAPRITXMATH_NUMERICOPTNONE

The adjusted amount of provincial income tax withheld from the employee's wages.

mnAdjustedEiInsurableEarniAEIERMATH_NUMERICOPTNONE

The adjusted EI insurable earnings for T4 and Releve forms.

mnAdjustedEiPremiumAEIPMATH_NUMERICOPTNONE

The adjusted amount of employment insurance paid by the employee to the company.

mnAdjustedPensionableEarniACPPEMATH_NUMERICOPTNONE

The adjusted pensionable earnings that are calculated for T4/Relevé purposes.

mnAdjustedCanadaPensionPlanACPPMATH_NUMERICOPTNONE

Adjusted employee contribution to the Canada Pension Plan (CPP).

mnAdjustedQuebecPensionPlanAQPPMATH_NUMERICOPTNONE

The adjusted employee contribution to the Quebec Pension Plan (QPP).

mnTotAdjFITWagesAFDWGMATH_NUMERICOPTNONE

The amount of adjusted wages subject to federal income tax.

mnTotAdjFederalIncomeTaxAFDTXMATH_NUMERICOPTNONE

The adjusted amount of federal income tax withheld from the employee's wages.

mnTotAdjProvincTaxWagesAPRTXWMATH_NUMERICOPTNONE

The adjusted amount of provincial taxable wages.

mnTotAdjProvincIncomeTaxAPRITXMATH_NUMERICOPTNONE

The adjusted amount of provincial income tax withheld from the employee's wages.

mnTotAdjEiInsurableEarningsAEIERMATH_NUMERICOPTNONE

The adjusted EI insurable earnings for T4 and Releve forms.

mnTotAdjEiPremiumAEIPMATH_NUMERICOPTNONE

The adjusted amount of employment insurance paid by the employee to the company.

mnTotAdjPensionableEarningsACPPEMATH_NUMERICOPTNONE

The adjusted pensionable earnings that are calculated for T4/Relevé purposes.

mnTotAdjCPPACPPMATH_NUMERICOPTNONE

Adjusted employee contribution to the Canada Pension Plan (CPP).

mnTotAdjQPPAQPPMATH_NUMERICOPTNONE

The adjusted employee contribution to the Quebec Pension Plan (QPP).

szBoxNumber9BOXNcharOPTNONE

The number of the box as it appears on the year-end form.

mnAmount9AMNTMATH_NUMERICOPTNONE

An amount for a specific box on a year-end form.

mnAmountAdjustedAMTADJMATH_NUMERICOPTNONE

An adjusted amount. Enter the amount of the adjustment, not the amount after adjustment. For example, if an original amount of 400 should 
be corrected to 500, enter 100 in the Adjusted field.

mnTotAmountAdjustedAMTADJMATH_NUMERICOPTNONE

An adjusted amount. Enter the amount of the adjustment, not the amount after adjustment. For example, if an original amount of 400 should 
be corrected to 500, enter 100 in the Adjusted field.

szAdditionalTextATEXTcharOPTNONE

Text for a specific box on a year-end form. Use this field for boxes that require text rather than amounts.

cTableFlagEV01charOPTNONE

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

mnPrimaryFormControlNumberPFCNOMATH_NUMERICOPTNONE

A form control number.

mnSecondaryFormControlNumbSFCNOMATH_NUMERICOPTNONE

A secondary form control number.

mnGrossIncome1GI1MATH_NUMERICOPTNONE

The Gross Income for NR4 printing.

mnAdjustedGrossIncome1AGI1MATH_NUMERICOPTNONE

The adjusted amount of gross income for line 1 on the NR4 form.

mnGrossIncome2GI2MATH_NUMERICOPTNONE

The Gross Income for NR4 printing.

mnAdjustedGrossIncome2AGI2MATH_NUMERICOPTNONE

The adjusted amount of gross income for line 2 on the NR4 form.

mnTaxWithheld1TXW1MATH_NUMERICOPTNONE

The Tax Withheld for NR4 printing.

mnAdjustedTaxWithheld1ATXW1MATH_NUMERICOPTNONE

The adjusted amount of tax withheld for line 1 on the NR4 form.

mnAdjustedTaxWithheld2ATXW2MATH_NUMERICOPTNONE

The adjusted amount of tax withheld for line 2 on the NR4 form.

mnTaxWithheld2TXW2MATH_NUMERICOPTNONE

The Tax Withheld for NR4 printing.

mnTotAdjTaxWithheld2ATXW2MATH_NUMERICOPTNONE

The adjusted amount of tax withheld for line 2 on the NR4 form.

mnTotAdjTaxWithheld1ATXW1MATH_NUMERICOPTNONE

The adjusted amount of tax withheld for line 1 on the NR4 form.

mnTotAdjGrossIncome1AGI1MATH_NUMERICOPTNONE

The adjusted amount of gross income for line 1 on the NR4 form.

mnTotAdjGrossIncome2AGI2MATH_NUMERICOPTNONE

The adjusted amount of gross income for line 2 on the NR4 form.

Related Functions

None

Related Tables

None
F77210Insert

F77210Insert

CA Year End Form Add, Subtract, Copy Amounts Functions

Minor Business Rule

Object Name: N7700085

Parent DLL: CPAY

Location: Client/Server

Language: NER

Data Structure

D7700085 - CA Year End Form Add, Subtract, Copy Amount Functions

Parameter NameData ItemData TypeReq/OptI/O/Both
szYearEndIdYEIDcharOPTNONE

A unique code that identifies a group of employees for whom you are processing year-end forms for a particular year. Use this ID to 
process each step of year-end processing.

mnTaxYearTAXYRMATH_NUMERICOPTNONE

The tax year, including the century.

mnAddressNumberAN8MATH_NUMERICOPTNONE

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

mnFormsIdFORMSIDMATH_NUMERICOPTNONE

A code that identifies the year-end form. Valid values are: 1 T4 2 Relevé 1 3 T4A 4 Relevé 2 5 NR4

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.

cAmendTypeAMNDTcharOPTNONE

The amend status of this record for this year-end ID. Valid values are: Blank Not amended 1 Amended

szTaxIdentificationNoTAXXcharOPTNONE

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.

szTaxAreaWorkTARAcharOPTNONE

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.

szFormDescriptionFORMDcharOPTNONE

The description or title of the form.

szSocialSecurityNumberSSNcharOPTNONE

A number that indicates the tax ID. In the United States, the tax ID is the social security number. In Canada, it is the social insurance number. 
If you add employee information for a non-US or non-Canadian company, you can leave this field blank. However, if the international code is 
set to Y and the default company is non-Canadian and non-United States, you can enter a 16-character number for the tax ID. The system 
does not permit duplicate tax ID numbers. Also, the number cannot include dashes. For example, if a social security number of nn-nn-nnnn is 
used, the number should be entered as follows: 123456789.

szNameAlphaALPHcharOPTNONE

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.

szCostCenterHomeHMCUcharOPTNONE

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

szProvOfEmplyT4PEcharOPTNONE

The 2-letter code indicating the Province of employment. Valid values are: AB Alberta BC British Columbia MB Manitoba NB New 
Brunswick NF Newfoundland NT Northwest Territories NS Nova Scotia ON Ontario PE Prince Edward Island QC Quebec SK Saskatchewan YT Yukon 
Territory ZZ Other Canadian Areas 

mnWagesFederalTaxableFDWGMATH_NUMERICOPTNONE

The amount of wages subject to Federal Income Tax.

mnAmountFederalTaxFDTXMATH_NUMERICOPTNONE

The amount of Federal Income Tax withheld for the employee.

mnProvincialTaxableWagesPRTXWMATH_NUMERICOPTNONE

The amount of provincial taxable wages.

mnProvincialIncomeTaxPRITXMATH_NUMERICOPTNONE

The amount of provincial income tax withheld from the employee's wages.

mnEiInsurableEarningsEIERMATH_NUMERICOPTNONE

The EI insurable earnings for T4 and Relevé 1 forms.

mnEiPremiumEIPMATH_NUMERICOPTNONE

The amount of Employment Insurance paid to the company by the employee.

mnPensionableEarningsCPPEMATH_NUMERICOPTNONE

Pensionable earnings that are calculated for T4/Releve forms.

mnCanadaPensionPlanCPPMATH_NUMERICOPTNONE

Employee contribution to the Canada Pension Plan.

mnQuebecPensionPlanQPPMATH_NUMERICOPTNONE

Employee contribution to the Quebec Pension Plan.

mnEiPremiumEmployerEIPRMATH_NUMERICOPTNONE

The amount of employment insurance paid by the company.

mnCppEmployerCPERMATH_NUMERICOPTNONE

Employer contribution to the Canadian Pension Plan.

mnQppEmployerQPERMATH_NUMERICOPTNONE

The employer contribution to the Quebec Pension Plan (QPP).

szEmploymentCodeT4ECcharOPTNONE

The employment code for the employee. Valid values are defined in user defined code table 77/EC.

cExemptCppQppECPPcharOPTNONE

A flag that shows if the employee was exempt from CPP/QPP for the ENTIRE year.    blank The employee was not exempt    X       The 
employee was exempt from CPP/QPP for the entire year.

cRecipientTypeNRCTcharOPTNONE

A code that classifies the recipient of the NR4 form. This code is printed on the NR4 form. Valid values are assigned by the Canada 
Customs and Revenue Agency (CCRA) and are defined in UDC 77Y/RT.

szCountryForPayrollCCPRcharOPTNONE

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

cExemptFromEiEEIcharOPTNONE

A flag that indicates whether the employee was exempt from EI for the entire year. Valid values are: Blank The employee was not 
exempt. X The employee was exempt from EI for the entire year.

cArchiveStatusARCScharOPTNONE

The archive status for this year-end ID. Valid values are: Blank Not executed A Active or in job queue 1 Completed

mnAdjustedFITWagesAFDWGMATH_NUMERICOPTNONE

The amount of adjusted wages subject to federal income tax.

mnAdjustedFederalIncomeTaxAFDTXMATH_NUMERICOPTNONE

The adjusted amount of federal income tax withheld from the employee's wages.

mnAdjustedProvincialTaxablAPRTXWMATH_NUMERICOPTNONE

The adjusted amount of provincial taxable wages.

mnAdjustedProvincialIncomeAPRITXMATH_NUMERICOPTNONE

The adjusted amount of provincial income tax withheld from the employee's wages.

mnAdjustedEiInsurableEarniAEIERMATH_NUMERICOPTNONE

The adjusted EI insurable earnings for T4 and Releve forms.

mnAdjustedEiPremiumAEIPMATH_NUMERICOPTNONE

The adjusted amount of employment insurance paid by the employee to the company.

mnAdjustedPensionableEarniACPPEMATH_NUMERICOPTNONE

The adjusted pensionable earnings that are calculated for T4/Relevé purposes.

mnAdjustedCanadaPensionPlanACPPMATH_NUMERICOPTNONE

Adjusted employee contribution to the Canada Pension Plan (CPP).

mnAdjustedQuebecPensionPlanAQPPMATH_NUMERICOPTNONE

The adjusted employee contribution to the Quebec Pension Plan (QPP).

mnTotAdjFITWagesAFDWGMATH_NUMERICOPTNONE

The amount of adjusted wages subject to federal income tax.

mnTotAdjFederalIncomeTaxAFDTXMATH_NUMERICOPTNONE

The adjusted amount of federal income tax withheld from the employee's wages.

mnTotAdjProvincTaxWagesAPRTXWMATH_NUMERICOPTNONE

The adjusted amount of provincial taxable wages.

mnTotAdjProvincIncomeTaxAPRITXMATH_NUMERICOPTNONE

The adjusted amount of provincial income tax withheld from the employee's wages.

mnTotAdjEiInsurableEarningsAEIERMATH_NUMERICOPTNONE

The adjusted EI insurable earnings for T4 and Releve forms.

mnTotAdjEiPremiumAEIPMATH_NUMERICOPTNONE

The adjusted amount of employment insurance paid by the employee to the company.

mnTotAdjPensionableEarningsACPPEMATH_NUMERICOPTNONE

The adjusted pensionable earnings that are calculated for T4/Relevé purposes.

mnTotAdjCPPACPPMATH_NUMERICOPTNONE

Adjusted employee contribution to the Canada Pension Plan (CPP).

mnTotAdjQPPAQPPMATH_NUMERICOPTNONE

The adjusted employee contribution to the Quebec Pension Plan (QPP).

szBoxNumber9BOXNcharOPTNONE

The number of the box as it appears on the year-end form.

mnAmount9AMNTMATH_NUMERICOPTNONE

An amount for a specific box on a year-end form.

mnAmountAdjustedAMTADJMATH_NUMERICOPTNONE

An adjusted amount. Enter the amount of the adjustment, not the amount after adjustment. For example, if an original amount of 400 should 
be corrected to 500, enter 100 in the Adjusted field.

mnTotAmountAdjustedAMTADJMATH_NUMERICOPTNONE

An adjusted amount. Enter the amount of the adjustment, not the amount after adjustment. For example, if an original amount of 400 should 
be corrected to 500, enter 100 in the Adjusted field.

szAdditionalTextATEXTcharOPTNONE

Text for a specific box on a year-end form. Use this field for boxes that require text rather than amounts.

cTableFlagEV01charOPTNONE

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

mnPrimaryFormControlNumberPFCNOMATH_NUMERICOPTNONE

A form control number.

mnSecondaryFormControlNumbSFCNOMATH_NUMERICOPTNONE

A secondary form control number.

mnGrossIncome1GI1MATH_NUMERICOPTNONE

The Gross Income for NR4 printing.

mnAdjustedGrossIncome1AGI1MATH_NUMERICOPTNONE

The adjusted amount of gross income for line 1 on the NR4 form.

mnGrossIncome2GI2MATH_NUMERICOPTNONE

The Gross Income for NR4 printing.

mnAdjustedGrossIncome2AGI2MATH_NUMERICOPTNONE

The adjusted amount of gross income for line 2 on the NR4 form.

mnTaxWithheld1TXW1MATH_NUMERICOPTNONE

The Tax Withheld for NR4 printing.

mnAdjustedTaxWithheld1ATXW1MATH_NUMERICOPTNONE

The adjusted amount of tax withheld for line 1 on the NR4 form.

mnAdjustedTaxWithheld2ATXW2MATH_NUMERICOPTNONE

The adjusted amount of tax withheld for line 2 on the NR4 form.

mnTaxWithheld2TXW2MATH_NUMERICOPTNONE

The Tax Withheld for NR4 printing.

mnTotAdjTaxWithheld2ATXW2MATH_NUMERICOPTNONE

The adjusted amount of tax withheld for line 2 on the NR4 form.

mnTotAdjTaxWithheld1ATXW1MATH_NUMERICOPTNONE

The adjusted amount of tax withheld for line 1 on the NR4 form.

mnTotAdjGrossIncome1AGI1MATH_NUMERICOPTNONE

The adjusted amount of gross income for line 1 on the NR4 form.

mnTotAdjGrossIncome2AGI2MATH_NUMERICOPTNONE

The adjusted amount of gross income for line 2 on the NR4 form.

Related Functions

None

Related Tables

None
F77210Update

F77210Update

CA Year End Form Add, Subtract, Copy Amounts Functions

Minor Business Rule

Object Name: N7700085

Parent DLL: CPAY

Location: Client/Server

Language: NER

Data Structure

D7700085 - CA Year End Form Add, Subtract, Copy Amount Functions

Parameter NameData ItemData TypeReq/OptI/O/Both
szYearEndIdYEIDcharOPTNONE

A unique code that identifies a group of employees for whom you are processing year-end forms for a particular year. Use this ID to 
process each step of year-end processing.

mnTaxYearTAXYRMATH_NUMERICOPTNONE

The tax year, including the century.

mnAddressNumberAN8MATH_NUMERICOPTNONE

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

mnFormsIdFORMSIDMATH_NUMERICOPTNONE

A code that identifies the year-end form. Valid values are: 1 T4 2 Relevé 1 3 T4A 4 Relevé 2 5 NR4

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.

cAmendTypeAMNDTcharOPTNONE

The amend status of this record for this year-end ID. Valid values are: Blank Not amended 1 Amended

szTaxIdentificationNoTAXXcharOPTNONE

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.

szTaxAreaWorkTARAcharOPTNONE

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.

szFormDescriptionFORMDcharOPTNONE

The description or title of the form.

szSocialSecurityNumberSSNcharOPTNONE

A number that indicates the tax ID. In the United States, the tax ID is the social security number. In Canada, it is the social insurance number. 
If you add employee information for a non-US or non-Canadian company, you can leave this field blank. However, if the international code is 
set to Y and the default company is non-Canadian and non-United States, you can enter a 16-character number for the tax ID. The system 
does not permit duplicate tax ID numbers. Also, the number cannot include dashes. For example, if a social security number of nn-nn-nnnn is 
used, the number should be entered as follows: 123456789.

szNameAlphaALPHcharOPTNONE

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.

szCostCenterHomeHMCUcharOPTNONE

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

szProvOfEmplyT4PEcharOPTNONE

The 2-letter code indicating the Province of employment. Valid values are: AB Alberta BC British Columbia MB Manitoba NB New 
Brunswick NF Newfoundland NT Northwest Territories NS Nova Scotia ON Ontario PE Prince Edward Island QC Quebec SK Saskatchewan YT Yukon 
Territory ZZ Other Canadian Areas 

mnWagesFederalTaxableFDWGMATH_NUMERICOPTNONE

The amount of wages subject to Federal Income Tax.

mnAmountFederalTaxFDTXMATH_NUMERICOPTNONE

The amount of Federal Income Tax withheld for the employee.

mnProvincialTaxableWagesPRTXWMATH_NUMERICOPTNONE

The amount of provincial taxable wages.

mnProvincialIncomeTaxPRITXMATH_NUMERICOPTNONE

The amount of provincial income tax withheld from the employee's wages.

mnEiInsurableEarningsEIERMATH_NUMERICOPTNONE

The EI insurable earnings for T4 and Relevé 1 forms.

mnEiPremiumEIPMATH_NUMERICOPTNONE

The amount of Employment Insurance paid to the company by the employee.

mnPensionableEarningsCPPEMATH_NUMERICOPTNONE

Pensionable earnings that are calculated for T4/Releve forms.

mnCanadaPensionPlanCPPMATH_NUMERICOPTNONE

Employee contribution to the Canada Pension Plan.

mnQuebecPensionPlanQPPMATH_NUMERICOPTNONE

Employee contribution to the Quebec Pension Plan.

mnEiPremiumEmployerEIPRMATH_NUMERICOPTNONE

The amount of employment insurance paid by the company.

mnCppEmployerCPERMATH_NUMERICOPTNONE

Employer contribution to the Canadian Pension Plan.

mnQppEmployerQPERMATH_NUMERICOPTNONE

The employer contribution to the Quebec Pension Plan (QPP).

szEmploymentCodeT4ECcharOPTNONE

The employment code for the employee. Valid values are defined in user defined code table 77/EC.

cExemptCppQppECPPcharOPTNONE

A flag that shows if the employee was exempt from CPP/QPP for the ENTIRE year.    blank The employee was not exempt    X       The 
employee was exempt from CPP/QPP for the entire year.

cRecipientTypeNRCTcharOPTNONE

A code that classifies the recipient of the NR4 form. This code is printed on the NR4 form. Valid values are assigned by the Canada 
Customs and Revenue Agency (CCRA) and are defined in UDC 77Y/RT.

szCountryForPayrollCCPRcharOPTNONE

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

cExemptFromEiEEIcharOPTNONE

A flag that indicates whether the employee was exempt from EI for the entire year. Valid values are: Blank The employee was not 
exempt. X The employee was exempt from EI for the entire year.

cArchiveStatusARCScharOPTNONE

The archive status for this year-end ID. Valid values are: Blank Not executed A Active or in job queue 1 Completed

mnAdjustedFITWagesAFDWGMATH_NUMERICOPTNONE

The amount of adjusted wages subject to federal income tax.

mnAdjustedFederalIncomeTaxAFDTXMATH_NUMERICOPTNONE

The adjusted amount of federal income tax withheld from the employee's wages.

mnAdjustedProvincialTaxablAPRTXWMATH_NUMERICOPTNONE

The adjusted amount of provincial taxable wages.

mnAdjustedProvincialIncomeAPRITXMATH_NUMERICOPTNONE

The adjusted amount of provincial income tax withheld from the employee's wages.

mnAdjustedEiInsurableEarniAEIERMATH_NUMERICOPTNONE

The adjusted EI insurable earnings for T4 and Releve forms.

mnAdjustedEiPremiumAEIPMATH_NUMERICOPTNONE

The adjusted amount of employment insurance paid by the employee to the company.

mnAdjustedPensionableEarniACPPEMATH_NUMERICOPTNONE

The adjusted pensionable earnings that are calculated for T4/Relevé purposes.

mnAdjustedCanadaPensionPlanACPPMATH_NUMERICOPTNONE

Adjusted employee contribution to the Canada Pension Plan (CPP).

mnAdjustedQuebecPensionPlanAQPPMATH_NUMERICOPTNONE

The adjusted employee contribution to the Quebec Pension Plan (QPP).

mnTotAdjFITWagesAFDWGMATH_NUMERICOPTNONE

The amount of adjusted wages subject to federal income tax.

mnTotAdjFederalIncomeTaxAFDTXMATH_NUMERICOPTNONE

The adjusted amount of federal income tax withheld from the employee's wages.

mnTotAdjProvincTaxWagesAPRTXWMATH_NUMERICOPTNONE

The adjusted amount of provincial taxable wages.

mnTotAdjProvincIncomeTaxAPRITXMATH_NUMERICOPTNONE

The adjusted amount of provincial income tax withheld from the employee's wages.

mnTotAdjEiInsurableEarningsAEIERMATH_NUMERICOPTNONE

The adjusted EI insurable earnings for T4 and Releve forms.

mnTotAdjEiPremiumAEIPMATH_NUMERICOPTNONE

The adjusted amount of employment insurance paid by the employee to the company.

mnTotAdjPensionableEarningsACPPEMATH_NUMERICOPTNONE

The adjusted pensionable earnings that are calculated for T4/Relevé purposes.

mnTotAdjCPPACPPMATH_NUMERICOPTNONE

Adjusted employee contribution to the Canada Pension Plan (CPP).

mnTotAdjQPPAQPPMATH_NUMERICOPTNONE

The adjusted employee contribution to the Quebec Pension Plan (QPP).

szBoxNumber9BOXNcharOPTNONE

The number of the box as it appears on the year-end form.

mnAmount9AMNTMATH_NUMERICOPTNONE

An amount for a specific box on a year-end form.

mnAmountAdjustedAMTADJMATH_NUMERICOPTNONE

An adjusted amount. Enter the amount of the adjustment, not the amount after adjustment. For example, if an original amount of 400 should 
be corrected to 500, enter 100 in the Adjusted field.

mnTotAmountAdjustedAMTADJMATH_NUMERICOPTNONE

An adjusted amount. Enter the amount of the adjustment, not the amount after adjustment. For example, if an original amount of 400 should 
be corrected to 500, enter 100 in the Adjusted field.

szAdditionalTextATEXTcharOPTNONE

Text for a specific box on a year-end form. Use this field for boxes that require text rather than amounts.

cTableFlagEV01charOPTNONE

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

mnPrimaryFormControlNumberPFCNOMATH_NUMERICOPTNONE

A form control number.

mnSecondaryFormControlNumbSFCNOMATH_NUMERICOPTNONE

A secondary form control number.

mnGrossIncome1GI1MATH_NUMERICOPTNONE

The Gross Income for NR4 printing.

mnAdjustedGrossIncome1AGI1MATH_NUMERICOPTNONE

The adjusted amount of gross income for line 1 on the NR4 form.

mnGrossIncome2GI2MATH_NUMERICOPTNONE

The Gross Income for NR4 printing.

mnAdjustedGrossIncome2AGI2MATH_NUMERICOPTNONE

The adjusted amount of gross income for line 2 on the NR4 form.

mnTaxWithheld1TXW1MATH_NUMERICOPTNONE

The Tax Withheld for NR4 printing.

mnAdjustedTaxWithheld1ATXW1MATH_NUMERICOPTNONE

The adjusted amount of tax withheld for line 1 on the NR4 form.

mnAdjustedTaxWithheld2ATXW2MATH_NUMERICOPTNONE

The adjusted amount of tax withheld for line 2 on the NR4 form.

mnTaxWithheld2TXW2MATH_NUMERICOPTNONE

The Tax Withheld for NR4 printing.

mnTotAdjTaxWithheld2ATXW2MATH_NUMERICOPTNONE

The adjusted amount of tax withheld for line 2 on the NR4 form.

mnTotAdjTaxWithheld1ATXW1MATH_NUMERICOPTNONE

The adjusted amount of tax withheld for line 1 on the NR4 form.

mnTotAdjGrossIncome1AGI1MATH_NUMERICOPTNONE

The adjusted amount of gross income for line 1 on the NR4 form.

mnTotAdjGrossIncome2AGI2MATH_NUMERICOPTNONE

The adjusted amount of gross income for line 2 on the NR4 form.

Related Functions

None

Related Tables

None
SubtractControlAmountsForTable

SubtractControlAmountsForTable

CA Year End Form Add, Subtract, Copy Amounts Functions

Minor Business Rule

Object Name: N7700085

Parent DLL: CPAY

Location: Client/Server

Language: NER

Data Structure

D7700085 - CA Year End Form Add, Subtract, Copy Amount Functions

Parameter NameData ItemData TypeReq/OptI/O/Both
szYearEndIdYEIDcharOPTNONE

A unique code that identifies a group of employees for whom you are processing year-end forms for a particular year. Use this ID to 
process each step of year-end processing.

mnTaxYearTAXYRMATH_NUMERICOPTNONE

The tax year, including the century.

mnAddressNumberAN8MATH_NUMERICOPTNONE

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

mnFormsIdFORMSIDMATH_NUMERICOPTNONE

A code that identifies the year-end form. Valid values are: 1 T4 2 Relevé 1 3 T4A 4 Relevé 2 5 NR4

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.

cAmendTypeAMNDTcharOPTNONE

The amend status of this record for this year-end ID. Valid values are: Blank Not amended 1 Amended

szTaxIdentificationNoTAXXcharOPTNONE

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.

szTaxAreaWorkTARAcharOPTNONE

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.

szFormDescriptionFORMDcharOPTNONE

The description or title of the form.

szSocialSecurityNumberSSNcharOPTNONE

A number that indicates the tax ID. In the United States, the tax ID is the social security number. In Canada, it is the social insurance number. 
If you add employee information for a non-US or non-Canadian company, you can leave this field blank. However, if the international code is 
set to Y and the default company is non-Canadian and non-United States, you can enter a 16-character number for the tax ID. The system 
does not permit duplicate tax ID numbers. Also, the number cannot include dashes. For example, if a social security number of nn-nn-nnnn is 
used, the number should be entered as follows: 123456789.

szNameAlphaALPHcharOPTNONE

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.

szCostCenterHomeHMCUcharOPTNONE

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

szProvOfEmplyT4PEcharOPTNONE

The 2-letter code indicating the Province of employment. Valid values are: AB Alberta BC British Columbia MB Manitoba NB New 
Brunswick NF Newfoundland NT Northwest Territories NS Nova Scotia ON Ontario PE Prince Edward Island QC Quebec SK Saskatchewan YT Yukon 
Territory ZZ Other Canadian Areas 

mnWagesFederalTaxableFDWGMATH_NUMERICOPTNONE

The amount of wages subject to Federal Income Tax.

mnAmountFederalTaxFDTXMATH_NUMERICOPTNONE

The amount of Federal Income Tax withheld for the employee.

mnProvincialTaxableWagesPRTXWMATH_NUMERICOPTNONE

The amount of provincial taxable wages.

mnProvincialIncomeTaxPRITXMATH_NUMERICOPTNONE

The amount of provincial income tax withheld from the employee's wages.

mnEiInsurableEarningsEIERMATH_NUMERICOPTNONE

The EI insurable earnings for T4 and Relevé 1 forms.

mnEiPremiumEIPMATH_NUMERICOPTNONE

The amount of Employment Insurance paid to the company by the employee.

mnPensionableEarningsCPPEMATH_NUMERICOPTNONE

Pensionable earnings that are calculated for T4/Releve forms.

mnCanadaPensionPlanCPPMATH_NUMERICOPTNONE

Employee contribution to the Canada Pension Plan.

mnQuebecPensionPlanQPPMATH_NUMERICOPTNONE

Employee contribution to the Quebec Pension Plan.

mnEiPremiumEmployerEIPRMATH_NUMERICOPTNONE

The amount of employment insurance paid by the company.

mnCppEmployerCPERMATH_NUMERICOPTNONE

Employer contribution to the Canadian Pension Plan.

mnQppEmployerQPERMATH_NUMERICOPTNONE

The employer contribution to the Quebec Pension Plan (QPP).

szEmploymentCodeT4ECcharOPTNONE

The employment code for the employee. Valid values are defined in user defined code table 77/EC.

cExemptCppQppECPPcharOPTNONE

A flag that shows if the employee was exempt from CPP/QPP for the ENTIRE year.    blank The employee was not exempt    X       The 
employee was exempt from CPP/QPP for the entire year.

cRecipientTypeNRCTcharOPTNONE

A code that classifies the recipient of the NR4 form. This code is printed on the NR4 form. Valid values are assigned by the Canada 
Customs and Revenue Agency (CCRA) and are defined in UDC 77Y/RT.

szCountryForPayrollCCPRcharOPTNONE

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

cExemptFromEiEEIcharOPTNONE

A flag that indicates whether the employee was exempt from EI for the entire year. Valid values are: Blank The employee was not 
exempt. X The employee was exempt from EI for the entire year.

cArchiveStatusARCScharOPTNONE

The archive status for this year-end ID. Valid values are: Blank Not executed A Active or in job queue 1 Completed

mnAdjustedFITWagesAFDWGMATH_NUMERICOPTNONE

The amount of adjusted wages subject to federal income tax.

mnAdjustedFederalIncomeTaxAFDTXMATH_NUMERICOPTNONE

The adjusted amount of federal income tax withheld from the employee's wages.

mnAdjustedProvincialTaxablAPRTXWMATH_NUMERICOPTNONE

The adjusted amount of provincial taxable wages.

mnAdjustedProvincialIncomeAPRITXMATH_NUMERICOPTNONE

The adjusted amount of provincial income tax withheld from the employee's wages.

mnAdjustedEiInsurableEarniAEIERMATH_NUMERICOPTNONE

The adjusted EI insurable earnings for T4 and Releve forms.

mnAdjustedEiPremiumAEIPMATH_NUMERICOPTNONE

The adjusted amount of employment insurance paid by the employee to the company.

mnAdjustedPensionableEarniACPPEMATH_NUMERICOPTNONE

The adjusted pensionable earnings that are calculated for T4/Relevé purposes.

mnAdjustedCanadaPensionPlanACPPMATH_NUMERICOPTNONE

Adjusted employee contribution to the Canada Pension Plan (CPP).

mnAdjustedQuebecPensionPlanAQPPMATH_NUMERICOPTNONE

The adjusted employee contribution to the Quebec Pension Plan (QPP).

mnTotAdjFITWagesAFDWGMATH_NUMERICOPTNONE

The amount of adjusted wages subject to federal income tax.

mnTotAdjFederalIncomeTaxAFDTXMATH_NUMERICOPTNONE

The adjusted amount of federal income tax withheld from the employee's wages.

mnTotAdjProvincTaxWagesAPRTXWMATH_NUMERICOPTNONE

The adjusted amount of provincial taxable wages.

mnTotAdjProvincIncomeTaxAPRITXMATH_NUMERICOPTNONE

The adjusted amount of provincial income tax withheld from the employee's wages.

mnTotAdjEiInsurableEarningsAEIERMATH_NUMERICOPTNONE

The adjusted EI insurable earnings for T4 and Releve forms.

mnTotAdjEiPremiumAEIPMATH_NUMERICOPTNONE

The adjusted amount of employment insurance paid by the employee to the company.

mnTotAdjPensionableEarningsACPPEMATH_NUMERICOPTNONE

The adjusted pensionable earnings that are calculated for T4/Relevé purposes.

mnTotAdjCPPACPPMATH_NUMERICOPTNONE

Adjusted employee contribution to the Canada Pension Plan (CPP).

mnTotAdjQPPAQPPMATH_NUMERICOPTNONE

The adjusted employee contribution to the Quebec Pension Plan (QPP).

szBoxNumber9BOXNcharOPTNONE

The number of the box as it appears on the year-end form.

mnAmount9AMNTMATH_NUMERICOPTNONE

An amount for a specific box on a year-end form.

mnAmountAdjustedAMTADJMATH_NUMERICOPTNONE

An adjusted amount. Enter the amount of the adjustment, not the amount after adjustment. For example, if an original amount of 400 should 
be corrected to 500, enter 100 in the Adjusted field.

mnTotAmountAdjustedAMTADJMATH_NUMERICOPTNONE

An adjusted amount. Enter the amount of the adjustment, not the amount after adjustment. For example, if an original amount of 400 should 
be corrected to 500, enter 100 in the Adjusted field.

szAdditionalTextATEXTcharOPTNONE

Text for a specific box on a year-end form. Use this field for boxes that require text rather than amounts.

cTableFlagEV01charOPTNONE

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

mnPrimaryFormControlNumberPFCNOMATH_NUMERICOPTNONE

A form control number.

mnSecondaryFormControlNumbSFCNOMATH_NUMERICOPTNONE

A secondary form control number.

mnGrossIncome1GI1MATH_NUMERICOPTNONE

The Gross Income for NR4 printing.

mnAdjustedGrossIncome1AGI1MATH_NUMERICOPTNONE

The adjusted amount of gross income for line 1 on the NR4 form.

mnGrossIncome2GI2MATH_NUMERICOPTNONE

The Gross Income for NR4 printing.

mnAdjustedGrossIncome2AGI2MATH_NUMERICOPTNONE

The adjusted amount of gross income for line 2 on the NR4 form.

mnTaxWithheld1TXW1MATH_NUMERICOPTNONE

The Tax Withheld for NR4 printing.

mnAdjustedTaxWithheld1ATXW1MATH_NUMERICOPTNONE

The adjusted amount of tax withheld for line 1 on the NR4 form.

mnAdjustedTaxWithheld2ATXW2MATH_NUMERICOPTNONE

The adjusted amount of tax withheld for line 2 on the NR4 form.

mnTaxWithheld2TXW2MATH_NUMERICOPTNONE

The Tax Withheld for NR4 printing.

mnTotAdjTaxWithheld2ATXW2MATH_NUMERICOPTNONE

The adjusted amount of tax withheld for line 2 on the NR4 form.

mnTotAdjTaxWithheld1ATXW1MATH_NUMERICOPTNONE

The adjusted amount of tax withheld for line 1 on the NR4 form.

mnTotAdjGrossIncome1AGI1MATH_NUMERICOPTNONE

The adjusted amount of gross income for line 1 on the NR4 form.

mnTotAdjGrossIncome2AGI2MATH_NUMERICOPTNONE

The adjusted amount of gross income for line 2 on the NR4 form.

Related Functions

None

Related Tables

None
UpdateYearEndStatusFields

UpdateYearEndStatusFields

CA Year End Form Add, Subtract, Copy Amounts Functions

Minor Business Rule

Object Name: N7700085

Parent DLL: CPAY

Location: Client/Server

Language: NER

Data Structure

D7700085B - Data Structure for Update Year End Status Fields

Parameter NameData ItemData TypeReq/OptI/O/Both
szYearEndIdYEIDcharOPTNONE

A unique code that identifies a group of employees for whom you are processing year-end forms for a particular year. Use this ID to 
process each step of year-end processing.

mnTaxYearTAXYRMATH_NUMERICOPTNONE

The tax year, including the century.

cWorkFileBuildStatusT4WBT4charOPTNONE

The status for the T4 work file build for this year-end ID. Valid values are: Blank Not executed A Active or in the job queue 1 Completed 

cWorkFileBuildStatusReleve1WBR1charOPTNONE

The status of the Releve1 work file build for this year-end ID. Valid values are: Blank Not executed A Active or in job queue 1 Completed 

cWorkFileBuildStatusT4AWBT4AcharOPTNONE

The status of the T4A work file build for this year-end ID. Valid values are:    Blank Not executed    A       Active or in job queue    1       
Completed 

cWorkFileBuildStatusReleve2WBR2charOPTNONE

The status of the Releve2 work file build for this year-end ID. Valid values are: Blank Not executed A Active or in job queue 1 Completed 

cWorkFileBuildStatusNR4WBNR4charOPTNONE

The status of the NR4 work file build for this year-end ID. Valid values are: Blank Not executed A Active or in job queue 1 Completed 

cCanadaT4FormPrintStatusT4PRTScharOPTNONE

The print status of the T4 form for this year-end ID. Valid values are: Blank Not executed A Active or in job queue 1 Completed 

cCanadaReleve1FormPrintStaREL1ScharOPTNONE

The print status of the Releve1 form for this year-end ID. Valid values are: Blank Not executed A Active or in job queue 1 Completed 

cCanadaT4AFormPrintStatusT4AScharOPTNONE

The print status of the T4A form for this year-end ID. Valid values are: Blank Not executed A Active or in job queue 1 Completed 

cCanadaReleve2FormPrintStaRELS2charOPTNONE

The print status of the Releve2 form for this year-end ID. Valid values are: Blank Not executed A Active or in job queue 1 Completed 

cCanadaNR4FormPrintStatusNR4ScharOPTNONE

The print status of the NR4 form for this year-end ID. Valid values are: Blank Not executed A Active or in job queue 1 Completed 

cMagMediaBuildStatusT4MBT4charOPTNONE

The status of the T4 magmetic media build for this year-end ID. Valid values are: Blank Not executed A Active or in job queue 1 Completed 

cMagMediaBuildStatusReleve1MBR1charOPTNONE

The status of the Releve1 magnetic media build for this year-end ID. Valid values are: Blank Not executed A Active or in job 
queue 1 Completed 

cMagMediaBuildStatusT4AMBT4AcharOPTNONE

The status of the T4A Mag Media Build for this year-end ID. Valid values are: Blank Not executed A Active or in job queue 1 Completed 

cMagMediaBuildStatusReleve2MBR2charOPTNONE

The status of the Releve 2 magnetic media build for this year-end ID. Valid values are: Blank Not executed A Active or in job 
queue 1 Completed 

cMagMediaBuildStatusNR4MBNR4charOPTNONE

The status of the NR4 magnetic media build for this year-end ID. Valid values are: Blank Not executed A Active or in job queue 1 Completed 

cAuditReportStatusT4ART4charOPTNONE

The status of the T4 audit report for this year-end ID. Valid values are: Blank Not executed A Active or in job queue 1 Completed

cAuditReportStatusReleve1ARR1charOPTNONE

The status of the Releve 1 audit report for this year-end ID. Valid values are: Blank Not executed A Active or in job queue 1 Completed

cAuditReportStatusT4AART4AcharOPTNONE

The status of the T4A Audit report for this year-end ID. Valid values are: Blank Not executed A Active or in job queue 1 Completed

cAuditReportStatusReleve2ARR2charOPTNONE

The status of the Releve 2 audit report for this year-end ID. Valid values are: Blank Not executed A Active or in job queue 1 Completed

cAuditReportStatusNR4ARNR4charOPTNONE

The status of the NR4 audit report for this year-end ID. Valid values are: Blank Not executed A Active or in job queue 1 Completed

cProcessingFlag_EV01EV01charOPTNONE

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

cReturnCode_EV02EV02charOPTNONE

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

szNERCalledFromPIDcharOPTNONE

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.

Related Functions

None

Related Tables

None
r line 2 on the NR4 form.

mnTaxWithheld1TXW1MATH_NUMERICOPTNONE

The Tax Withheld for NR4 printing.

mnAdjustedTaxWithheld1ATXW1MATH_NUMERICOPTNONE

The adjusted amount of tax withheld for line 1 on the NR4 form.

mnAdjustedTaxWithheld2ATXW2MATH_NUMERICOPTNONE

The adjusted amount of tax withheld for line 2 on the NR4 form.

mnTaxWithheld2TXW2MATH_NUMERICOPTNONE

The Tax Withheld for NR4 printing.

mnTotAdjTaxWithheld2ATXW2MATH_NUMERICOPTNONE

The adjusted amount of tax withheld for line 2 on the NR4 form.

mnTotAdjTaxWithheld1ATXW1MATH_NUMERICOPTNONE

The adjusted amount of tax withheld for line 1 on the NR4 form.

mnTotAdjGrossIncome1AGI1MATH_NUMERICOPTNONE

The adjusted amount of gross income for line 1 on the NR4 form.

mnTotAdjGrossIncome2AGI2MATH_NUMERICOPTNONE

The adjusted amount of gross income for line 2 on the NR4 form.

Related Functions

None

Related Tables

None
F77210Insert

F77210Insert

CA Year End Form Add, Subtract, Copy Amounts Functions

Minor Business Rule

Object Name: N7700085

Parent DLL: CPAY

Location: Client/Server

Language: NER

Data Structure

D7700085 - CA Year End Form Add, Subtract, Copy Amount Functions

Parameter NameData ItemData TypeReq/OptI/O/Both
szYearEndIdYEIDcharOPTNONE

A unique code that identifies a group of employees for whom you are processing year-end forms for a particular year. Use this ID to 
process each step of year-end processing.

mnTaxYearTAXYRMATH_NUMERICOPTNONE

The tax year, including the century.

mnAddressNumberAN8MATH_NUMERICOPTNONE

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

mnFormsIdFORMSIDMATH_NUMERICOPTNONE

A code that identifies the year-end form. Valid values are: 1 T4 2 Relevé 1 3 T4A 4 Relevé 2 5 NR4

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.

cAmendTypeAMNDTcharOPTNONE

The amend status of this record for this year-end ID. Valid values are: Blank Not amended 1 Amended

szTaxIdentificationNoTAXXcharOPTNONE

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.

szTaxAreaWorkTARAcharOPTNONE

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.

szFormDescriptionFORMDcharOPTNONE

The description or title of the form.

szSocialSecurityNumberSSNcharOPTNONE

A number that indicates the tax ID. In the United States, the tax ID is the social security number. In Canada, it is the social insurance number. 
If you add employee information for a non-US or non-Canadian company, you can leave this field blank. However, if the international code is 
set to Y and the default company is non-Canadian and non-United States, you can enter a 16-character number for the tax ID. The system 
does not permit duplicate tax ID numbers. Also, the number cannot include dashes. For example, if a social security number of nn-nn-nnnn is 
used, the number should be entered as follows: 123456789.

szNameAlphaALPHcharOPTNONE

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.

szCostCenterHomeHMCUcharOPTNONE

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

szProvOfEmplyT4PEcharOPTNONE

The 2-letter code indicating the Province of employment. Valid values are: AB Alberta BC British Columbia MB Manitoba NB New 
Brunswick NF Newfoundland NT Northwest Territories NS Nova Scotia ON Ontario PE Prince Edward Island QC Quebec SK Saskatchewan YT Yukon 
Territory ZZ Other Canadian Areas 

mnWagesFederalTaxableFDWGMATH_NUMERICOPTNONE

The amount of wages subject to Federal Income Tax.

mnAmountFederalTaxFDTXMATH_NUMERICOPTNONE

The amount of Federal Income Tax withheld for the employee.

mnProvincialTaxableWagesPRTXWMATH_NUMERICOPTNONE

The amount of provincial taxable wages.

mnProvincialIncomeTaxPRITXMATH_NUMERICOPTNONE

The amount of provincial income tax withheld from the employee's wages.

mnEiInsurableEarningsEIERMATH_NUMERICOPTNONE

The EI insurable earnings for T4 and Relevé 1 forms.

mnEiPremiumEIPMATH_NUMERICOPTNONE

The amount of Employment Insurance paid to the company by the employee.

mnPensionableEarningsCPPEMATH_NUMERICOPTNONE

Pensionable earnings that are calculated for T4/Releve forms.

mnCanadaPensionPlanCPPMATH_NUMERICOPTNONE

Employee contribution to the Canada Pension Plan.

mnQuebecPensionPlanQPPMATH_NUMERICOPTNONE

Employee contribution to the Quebec Pension Plan.

mnEiPremiumEmployerEIPRMATH_NUMERICOPTNONE

The amount of employment insurance paid by the company.

mnCppEmployerCPERMATH_NUMERICOPTNONE

Employer contribution to the Canadian Pension Plan.

mnQppEmployerQPERMATH_NUMERICOPTNONE

The employer contribution to the Quebec Pension Plan (QPP).

szEmploymentCodeT4ECcharOPTNONE

The employment code for the employee. Valid values are defined in user defined code table 77/EC.

cExemptCppQppECPPcharOPTNONE

A flag that shows if the employee was exempt from CPP/QPP for the ENTIRE year.    blank The employee was not exempt    X       The 
employee was exempt from CPP/QPP for the entire year.

cRecipientTypeNRCTcharOPTNONE

A code that classifies the recipient of the NR4 form. This code is printed on the NR4 form. Valid values are assigned by the Canada 
Customs and Revenue Agency (CCRA) and are defined in UDC 77Y/RT.

szCountryForPayrollCCPRcharOPTNONE

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

cExemptFromEiEEIcharOPTNONE

A flag that indicates whether the employee was exempt from EI for the entire year. Valid values are: Blank The employee was not 
exempt. X The employee was exempt from EI for the entire year.

cArchiveStatusARCScharOPTNONE

The archive status for this year-end ID. Valid values are: Blank Not executed A Active or in job queue 1 Completed

mnAdjustedFITWagesAFDWGMATH_NUMERICOPTNONE

The amount of adjusted wages subject to federal income tax.

mnAdjustedFederalIncomeTaxAFDTXMATH_NUMERICOPTNONE

The adjusted amount of federal income tax withheld from the employee's wages.

mnAdjustedProvincialTaxablAPRTXWMATH_NUMERICOPTNONE

The adjusted amount of provincial taxable wages.

mnAdjustedProvincialIncomeAPRITXMATH_NUMERICOPTNONE

The adjusted amount of provincial income tax withheld from the employee's wages.

mnAdjustedEiInsurableEarniAEIERMATH_NUMERICOPTNONE

The adjusted EI insurable earnings for T4 and Releve forms.

mnAdjustedEiPremiumAEIPMATH_NUMERICOPTNONE

The adjusted amount of employment insurance paid by the employee to the company.

mnAdjustedPensionableEarniACPPEMATH_NUMERICOPTNONE

The adjusted pensionable earnings that are calculated for T4/Relevé purposes.

mnAdjustedCanadaPensionPlanACPPMATH_NUMERICOPTNONE

Adjusted employee contribution to the Canada Pension Plan (CPP).

mnAdjustedQuebecPensionPlanAQPPMATH_NUMERICOPTNONE

The adjusted employee contribution to the Quebec Pension Plan (QPP).

mnTotAdjFITWagesAFDWGMATH_NUMERICOPTNONE

The amount of adjusted wages subject to federal income tax.

mnTotAdjFederalIncomeTaxAFDTXMATH_NUMERICOPTNONE

The adjusted amount of federal income tax withheld from the em