F06017FetchCanadaTaxInfo

F06017 Fetch/Update Canadian Tax Info by EE

Minor Business Rule

Object Name: B0500132

Parent DLL: CHRM

Location: Client/Server

Language: C

Data Structure

D0500132 - F06017 Fetch Canadian Tax Information by EE Data Structure

Parameter NameData ItemData TypeReq/OptI/O/Both
mnNetTaxCreditOWNTCMATH_NUMERICOPTNONE

The Personal Tax Credit amount, which comes from the TD1 form for federal or the corresponding province.

mnAdditionalTaxOWATXMATH_NUMERICOPTNONE

For federal taxes, the amount of additional federal tax to be deducted per pay period. For provincial taxes, the amount of additional 
provincial tax to be deducted per pay period.

mnOtherTaxCreditOWOTXMATH_NUMERICOPTNONE

Federal tax credits, such as medical expenses and charitable donations,requested by an employee and authorized by the Canada 
Customs and Revenue Agency (CCRA) district office.

mnAdditionalDeductionOWADEMATH_NUMERICOPTNONE

Quebec additional deductions claimed on the MR-19-V (Exemptions and Reductions form) or other deductions authorized by the Ministere 
du Revenu du Quebec.

szStatutoryCode1SC01charOPTNONE

A code that allows you to override supplemental taxes for federal and state taxes and to add additional local residence taxes. Valid values 
are:    F Override the federal supplemental tax for this employee.    S Override the state supplemental tax for this employee.    R Add 
additional local residence tax. When you override supplemental taxes, you must leave the Tax Area and Tax Type fields blank.

mnEIRateUCRTMATH_NUMERICOPTNONE

The rate that the system uses to compute U.S. unemployment and Canadian employer-paid employment insurance premiums. This rate is 
represented as a decimal fraction.

mnPrescribedAreaDeductionOWPADMATH_NUMERICOPTNONE

An annual deduction for living in a prescribed area as listed on the TD1 (Personal Tax Credit Return).

mnChildCareAlimonyEtcOWCLDMATH_NUMERICOPTNONE

An annual deduction, such as child care expenses, alimony payments, maintenance payments, and so on.

mnFederalTaxOverridesOWTXOMATH_NUMERICOPTNONE

A flat percentage that overrides the standard tax rate.

cEIExemptOWEXEcharOPTNONE

An option that indicates whether the employee is exempt or non-exempt from tax deductions. Select one of the following options to indicate 
the proper exemptions: EI Employee is exempt from federal employment insurance deduction. EI/CPP/QPP Employee is exempt from 
employment insurance and Canada pension plan or Quebec pension plan deductions. CPP/QPP Employee is exempt from Canada pension plan or 
Quebec pension plan deductions. All Taxes  Employee is exempt from all tax deductions.

cPensionerNonResidentFlagFICPcharOPTNONE

This code indicates if the employee is a Non-Resident or a Pensioner of Canada. Valid values are: N Non-Resident of 
Canada P Pensioner Blank Regular employee

mnAddWithholding1AW01MATH_NUMERICOPTNONE

An additional amount to be withheld over and above the calculated withholding. This could represent a flat withholding amount in situations 
in which the employee elects to completely bypass the calculated amount. The authority to which each element relates is determined by the 
tier code of the tax authority. Whether the amount is to be an additional amount or a flat withholding is specified in the employee's master file 
record.

szCompanyHomeHMCOcharOPTNONE

The company number where the employee records generally reside.

cTaxCalcMethodFICMcharOPTNONE

A code that specifies the tax method that the Vertex payroll-tax calculation system uses to calculate certain taxes. The codes are defined in 
UDC 07/TM. This code can also determine the form that the employee receives for year-end tax reporting. For example, when you enter C, 
a contract employee receives IRS Form 1099-M rather than IRS Form W-2. If a form is not specified in Description 2, the system generates 
IRS Form W-2. For employees who are paid multiple times within one pay period, the system should review previous payments within the same 
pay period and then adjust tax amounts. To specify this function, enter S. If a tax method exists for an employee in addition to the normal tax 
method that is set up in the Employee Master Information table (F060116), the system can use the alternative tax method to interactively 
process interim payments. To specify this function, enter Z. Some values, such as S and Z, might require additional setup in the UDC table.

mnAddressNumberAN8MATH_NUMERICOPTNONE

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

mnQuebecNetTaxCreditOWNTCMATH_NUMERICOPTNONE

The Personal Tax Credit amount, which comes from the TD1 form for federal or the corresponding province.

mnQuebecAdditionalTaxOWATXMATH_NUMERICOPTNONE

For federal taxes, the amount of additional federal tax to be deducted per pay period. For provincial taxes, the amount of additional 
provincial tax to be deducted per pay period.

mnCPPQPPTaxOverridesOWTXOMATH_NUMERICOPTNONE

A flat percentage that overrides the standard tax rate.

mnQuebecTaxOverridesOWTXOMATH_NUMERICOPTNONE

A flat percentage that overrides the standard tax rate.

cCPPQPPExemptOWEXEcharOPTNONE

An option that indicates whether the employee is exempt or non-exempt from tax deductions. Select one of the following options to indicate 
the proper exemptions: EI Employee is exempt from federal employment insurance deduction. EI/CPP/QPP Employee is exempt from 
employment insurance and Canada pension plan or Quebec pension plan deductions. CPP/QPP Employee is exempt from Canada pension plan or 
Quebec pension plan deductions. All Taxes  Employee is exempt from all tax deductions.

cEICPPQPPExemptOWEXEcharOPTNONE

An option that indicates whether the employee is exempt or non-exempt from tax deductions. Select one of the following options to indicate 
the proper exemptions: EI Employee is exempt from federal employment insurance deduction. EI/CPP/QPP Employee is exempt from 
employment insurance and Canada pension plan or Quebec pension plan deductions. CPP/QPP Employee is exempt from Canada pension plan or 
Quebec pension plan deductions. All Taxes  Employee is exempt from all tax deductions.

cAllTaxesExemptOWEXEcharOPTNONE

An option that indicates whether the employee is exempt or non-exempt from tax deductions. Select one of the following options to indicate 
the proper exemptions: EI Employee is exempt from federal employment insurance deduction. EI/CPP/QPP Employee is exempt from 
employment insurance and Canada pension plan or Quebec pension plan deductions. CPP/QPP Employee is exempt from Canada pension plan or 
Quebec pension plan deductions. All Taxes  Employee is exempt from all tax deductions.

szHoldEIRateCodeSC01charOPTNONE

A code that allows you to override supplemental taxes for federal and state taxes and to add additional local residence taxes. Valid values 
are:    F Override the federal supplemental tax for this employee.    S Override the state supplemental tax for this employee.    R Add 
additional local residence tax. When you override supplemental taxes, you must leave the Tax Area and Tax Type fields blank.

mnEstimatedSalaryESALMATH_NUMERICOPTNONE

The amount of estimated salary recorded on the employee's TDIX form. The system uses this amount and the estimated expenses, to 
determine the taxable gross income for commission taxation.

jdDatePayPeriodEndingPPEDJDEDATEOPTNONE

The last day of a processing period (pay period, month, quarter or year).

mnAmtGrossPayGPAMATH_NUMERICOPTNONE

The actual gross pay amount for an employee. This amount is to be distinguished from the distributed gross pay amount used for labor 
distribution. See data item DPAY. When using Work Order Time Entry, this field is used to record miscellaneous pay for an employee, (for 
example, piece rate bonus).

mnPayDeductBenAccTypePDBAMATH_NUMERICOPTNONE

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

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.

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.

mnYTDUnionDuesAAMATH_NUMERICOPTNONE

A number that identifies the amount that the system will add to the account balance of the associated account number.  Enter credits with a 
minus sign (-) either before or after the amount. 

mnYTDRegPenPlanAA1MATH_NUMERICOPTNONE

A number that identifies the actual amount.

cEarnIncomeCredStatusEICcharOPTNONE

A code that specifies whether the employee qualifies for the earned income credit and elects for the employer to give him or her the 
advance. Valid values are:    N The employee does not qualify (default).    Y The employee qualifies and the employee is single/head of 
household.    M The employee qualifies and is married without spouse filing certificate.     B The employee qualifies and his or her spouse also 
qualifies.

mnFedCanadaStockAmtT4STMATH_NUMERICOPTNONE

Amount of Stock Options.

mnProvCanadaStockAmtT4STMATH_NUMERICOPTNONE

Amount of Stock Options.

Related Functions

None

Related Tables

None
F06017UpdateCanadaTaxInf

F06017UpdateCanadaTaxInf

F06017 Fetch/Update Canadian Tax Info by EE

Minor Business Rule

Object Name: B0500132

Parent DLL: CHRM

Location: Client/Server

Language: C

Data Structure

D0500132 - F06017 Fetch Canadian Tax Information by EE Data Structure

Parameter NameData ItemData TypeReq/OptI/O/Both
mnNetTaxCreditOWNTCMATH_NUMERICOPTNONE

The Personal Tax Credit amount, which comes from the TD1 form for federal or the corresponding province.

mnAdditionalTaxOWATXMATH_NUMERICOPTNONE

For federal taxes, the amount of additional federal tax to be deducted per pay period. For provincial taxes, the amount of additional 
provincial tax to be deducted per pay period.

mnOtherTaxCreditOWOTXMATH_NUMERICOPTNONE

Federal tax credits, such as medical expenses and charitable donations,requested by an employee and authorized by the Canada 
Customs and Revenue Agency (CCRA) district office.

mnAdditionalDeductionOWADEMATH_NUMERICOPTNONE

Quebec additional deductions claimed on the MR-19-V (Exemptions and Reductions form) or other deductions authorized by the Ministere 
du Revenu du Quebec.

szStatutoryCode1SC01charOPTNONE

A code that allows you to override supplemental taxes for federal and state taxes and to add additional local residence taxes. Valid values 
are:    F Override the federal supplemental tax for this employee.    S Override the state supplemental tax for this employee.    R Add 
additional local residence tax. When you override supplemental taxes, you must leave the Tax Area and Tax Type fields blank.

mnEIRateUCRTMATH_NUMERICOPTNONE

The rate that the system uses to compute U.S. unemployment and Canadian employer-paid employment insurance premiums. This rate is 
represented as a decimal fraction.

mnPrescribedAreaDeductionOWPADMATH_NUMERICOPTNONE

An annual deduction for living in a prescribed area as listed on the TD1 (Personal Tax Credit Return).

mnChildCareAlimonyEtcOWCLDMATH_NUMERICOPTNONE

An annual deduction, such as child care expenses, alimony payments, maintenance payments, and so on.

mnFederalTaxOverridesOWTXOMATH_NUMERICOPTNONE

A flat percentage that overrides the standard tax rate.

cEIExemptOWEXEcharOPTNONE

An option that indicates whether the employee is exempt or non-exempt from tax deductions. Select one of the following options to indicate 
the proper exemptions: EI Employee is exempt from federal employment insurance deduction. EI/CPP/QPP Employee is exempt from 
employment insurance and Canada pension plan or Quebec pension plan deductions. CPP/QPP Employee is exempt from Canada pension plan or 
Quebec pension plan deductions. All Taxes  Employee is exempt from all tax deductions.

cPensionerNonResidentFlagFICPcharOPTNONE

This code indicates if the employee is a Non-Resident or a Pensioner of Canada. Valid values are: N Non-Resident of 
Canada P Pensioner Blank Regular employee

mnAddWithholding1AW01MATH_NUMERICOPTNONE

An additional amount to be withheld over and above the calculated withholding. This could represent a flat withholding amount in situations 
in which the employee elects to completely bypass the calculated amount. The authority to which each element relates is determined by the 
tier code of the tax authority. Whether the amount is to be an additional amount or a flat withholding is specified in the employee's master file 
record.

szCompanyHomeHMCOcharOPTNONE

The company number where the employee records generally reside.

cTaxCalcMethodFICMcharOPTNONE

A code that specifies the tax method that the Vertex payroll-tax calculation system uses to calculate certain taxes. The codes are defined in 
UDC 07/TM. This code can also determine the form that the employee receives for year-end tax reporting. For example, when you enter C, 
a contract employee receives IRS Form 1099-M rather than IRS Form W-2. If a form is not specified in Description 2, the system generates 
IRS Form W-2. For employees who are paid multiple times within one pay period, the system should review previous payments within the same 
pay period and then adjust tax amounts. To specify this function, enter S. If a tax method exists for an employee in addition to the normal tax 
method that is set up in the Employee Master Information table (F060116), the system can use the alternative tax method to interactively 
process interim payments. To specify this function, enter Z. Some values, such as S and Z, might require additional setup in the UDC table.

mnAddressNumberAN8MATH_NUMERICOPTNONE

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

mnQuebecNetTaxCreditOWNTCMATH_NUMERICOPTNONE

The Personal Tax Credit amount, which comes from the TD1 form for federal or the corresponding province.

mnQuebecAdditionalTaxOWATXMATH_NUMERICOPTNONE

For federal taxes, the amount of additional federal tax to be deducted per pay period. For provincial taxes, the amount of additional 
provincial tax to be deducted per pay period.

mnCPPQPPTaxOverridesOWTXOMATH_NUMERICOPTNONE

A flat percentage that overrides the standard tax rate.

mnQuebecTaxOverridesOWTXOMATH_NUMERICOPTNONE

A flat percentage that overrides the standard tax rate.

cCPPQPPExemptOWEXEcharOPTNONE

An option that indicates whether the employee is exempt or non-exempt from tax deductions. Select one of the following options to indicate 
the proper exemptions: EI Employee is exempt from federal employment insurance deduction. EI/CPP/QPP Employee is exempt from 
employment insurance and Canada pension plan or Quebec pension plan deductions. CPP/QPP Employee is exempt from Canada pension plan or 
Quebec pension plan deductions. All Taxes  Employee is exempt from all tax deductions.

cEICPPQPPExemptOWEXEcharOPTNONE

An option that indicates whether the employee is exempt or non-exempt from tax deductions. Select one of the following options to indicate 
the proper exemptions: EI Employee is exempt from federal employment insurance deduction. EI/CPP/QPP Employee is exempt from 
employment insurance and Canada pension plan or Quebec pension plan deductions. CPP/QPP Employee is exempt from Canada pension plan or 
Quebec pension plan deductions. All Taxes  Employee is exempt from all tax deductions.

cAllTaxesExemptOWEXEcharOPTNONE

An option that indicates whether the employee is exempt or non-exempt from tax deductions. Select one of the following options to indicate 
the proper exemptions: EI Employee is exempt from federal employment insurance deduction. EI/CPP/QPP Employee is exempt from 
employment insurance and Canada pension plan or Quebec pension plan deductions. CPP/QPP Employee is exempt from Canada pension plan or 
Quebec pension plan deductions. All Taxes  Employee is exempt from all tax deductions.

szHoldEIRateCodeSC01charOPTNONE

A code that allows you to override supplemental taxes for federal and state taxes and to add additional local residence taxes. Valid values 
are:    F Override the federal supplemental tax for this employee.    S Override the state supplemental tax for this employee.    R Add 
additional local residence tax. When you override supplemental taxes, you must leave the Tax Area and Tax Type fields blank.

mnEstimatedSalaryESALMATH_NUMERICOPTNONE

The amount of estimated salary recorded on the employee's TDIX form. The system uses this amount and the estimated expenses, to 
determine the taxable gross income for commission taxation.

jdDatePayPeriodEndingPPEDJDEDATEOPTNONE

The last day of a processing period (pay period, month, quarter or year).

mnAmtGrossPayGPAMATH_NUMERICOPTNONE

The actual gross pay amount for an employee. This amount is to be distinguished from the distributed gross pay amount used for labor 
distribution. See data item DPAY. When using Work Order Time Entry, this field is used to record miscellaneous pay for an employee, (for 
example, piece rate bonus).

mnPayDeductBenAccTypePDBAMATH_NUMERICOPTNONE

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

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.

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.

mnYTDUnionDuesAAMATH_NUMERICOPTNONE

A number that identifies the amount that the system will add to the account balance of the associated account number.  Enter credits with a 
minus sign (-) either before or after the amount. 

mnYTDRegPenPlanAA1MATH_NUMERICOPTNONE

A number that identifies the actual amount.

cEarnIncomeCredStatusEICcharOPTNONE

A code that specifies whether the employee qualifies for the earned income credit and elects for the employer to give him or her the 
advance. Valid values are:    N The employee does not qualify (default).    Y The employee qualifies and the employee is single/head of 
household.    M The employee qualifies and is married without spouse filing certificate.     B The employee qualifies and his or her spouse also 
qualifies.

mnFedCanadaStockAmtT4STMATH_NUMERICOPTNONE

Amount of Stock Options.

mnProvCanadaStockAmtT4STMATH_NUMERICOPTNONE

Amount of Stock Options.

Related Functions

None

Related Tables

None