Nothing Special   »   [go: up one dir, main page]

Loading Tax Credit Information For Canada Using HCM Data Loader

Download as pdf or txt
Download as pdf or txt
You are on page 1of 47
At a glance
Powered by AI
The key takeaways of this document are that it provides an overview of bulk loading calculation card data for Canada tax withholding in Oracle Payroll and discusses maintaining different tax components like Canadian taxation, federal tax, employment insurance, etc.

The purpose of this document is to provide an overview of bulk loading calculation card data for Canada in Oracle Payroll Release 13.

This document provides information on considerations and prerequisites for maintaining calculation cards, details on tax credit information calculation card record types, and discusses components for Canadian taxation, federal tax, employment insurance, Canada pension plan, provincial tax, payroll tax, and Quebec taxes.

Loading Tax Withholding

Information for Canada


Using HCM Data Loader
Oracle Payroll Cloud Release 19B

WHITE PAPER / JULY 2, 2019


PURPOSE STATEMENT
This document provides an overview of bulk loading Calculation Card data for Canada in Release 13.

DISCLAIMER
This document in any form, software or printed matter, contains proprietary information that is the exclusive property of Oracle. Your
access to and use of this confidential material is subject to the terms and conditions of your Oracle software license and service
agreement, which has been executed and with which you agree to comply. This document and information contained herein may
not be disclosed, copied, reproduced or distributed to anyone outside Oracle without prior written consent of Oracle. This document
is not part of your license agreement nor can it be incorporated into any contractual agreement with Oracle or its subsidiaries or
affiliates.

This document is for informational purposes only and is intended solely to assist you in planning for the implementation and
upgrade of the product features described. It is not a commitment to deliver any material, code, or functionality, and should not be
relied upon in making purchasing decisions. The development, release, and timing of any features or functionality described in this
document remains at the sole discretion of Oracle.

Due to the nature of the product architecture, it may not be possible to safely include all features described in this document without
risking significant destabilization of the code.

2 W HITE PAPER / Loading Tax Withholding Information for Canada


Using HCM Data Loader
TABLE OF CONTENTS

Introduction 5
How to Use The Information in this Document 5

Example Dat Files 5

Reviewing HCM Data Loader File Examples 6

Calculation Cards 7
Considerations and Prerequisites for Maintaining Calculation Cards 7

Tax Credit Information Calculation Card 7


Considerations and Prerequisites 7

Tax Credit Information Calculation Card Record Types 8

Calculation Card: Tax Credit Information 10

Card Component: Canadian Taxation 10

Card Component: Federal Tax 14

Card Component: Employment Insurance 20

Card Component: Canada Pension Plan 23

Card Component: Provincial Tax 26

Card Component: Payroll Tax 31

Card Component: Quebec Taxes 34

Card Association: Tax Credit Information 37

Example Files 39

Appendix A – Province Codes 46

FILE EXAMPLES
Example File 1: Maintaining Canadian Taxation ....................................................................................................................................... 13
Example File 2: Maintaining Federal Tax.................................................................................................................................................. 19
Example File 3: Maintaining Canada Pension Plan .................................................................................................................................. 25
Example File 4: Creating Provincial Tax ................................................................................................................................................... 30
Example File 5: Creating Quebec Taxes .................................................................................................................................................. 36
Example File 6: Creating the Card Association ........................................................................................................................................ 38
Example File 7: Creating Tax Credit Information for Northwest Territories and Nunavut.......................................................................... 39
Example File 8: Creating Tax Credit Infomration for Quebec ................................................................................................................... 40
Example File 9: Creating Tax Credit Information for other Provinces ....................................................................................................... 43

3 W HITE PAPER / Loading Tax Withholding Information for Canada


Using HCM Data Loader
4 W HITE PAPER / Loading Tax Withholding Information for Canada
Using HCM Data Loader
INTRODUCTION

Whether implementing Oracle Payroll Cloud for the first time, or providing regular updates, you can
create and maintain calculation cards using HCM Data Loader.

For general information about preparing data for loading using HCM Data Loader or the HCM Data
Loader file format, refer to the Integrating with Oracle HCM Cloud guide, available on the Oracle
Help Center.

HOW TO USE THE INFORMATION IN THIS DOCUMENT

This document provides a separate section for each calculation card that it describes. Each section
covers the following topics:

Calculation Card Hierarchy - Describes the hierarchical shape of the localization calculation card.

Component Information - Describes how the localization calculation card uses the component in
the generic Calculation Card object hierarchy, explains the attributes to supply and provides
example file lines for the record type.

Example Dat Files - Provides complete but simple dat file examples for the localization card.

For each Card Component and Card Association you will find:

Object Information - Describes how the global Calculation Card object is used by the localization
card, explains the attributes to supply and where appropriate, provides sample HCM Data Loader
file lines for the record type.

EXAMPLE DAT FILES

This document provides sample CalculationCard.dat files for loading Canada Localization
calculation card data using HCM Data Loader. To use the source key examples, change the source
system owner to a lookup code you have preconfigured in the HRC_SOURCE_SYSTEM_OWNER
lookup.

For both user key and source key examples ensure any references to foreign objects refer to data
that exists in your test environment.

5 W HITE PAPER / Loading Tax Withholding Information for Canada


Using HCM Data Loader
REVIEW ING HCM DATA LOADER FILE EXAMPLES

To review the shape of the file, it is recommended that you copy and paste the examples into Excel,
converting each line into individual columns with the Text to Columns capability.

6 W HITE PAPER / Loading Tax Withholding Information for Canada


Using HCM Data Loader
CALCULATION CARDS
Calculation cards capture values required for payroll calculations for certain earnings and deductions, such as absence payments,
statutory deductions, and involuntary deductions. Additionally, Canada captures values required for Record of Employment processing.

For Canada, the following type of calculation card is supported for bulk loading using HCM Data Loader (HDL):

– Tax Credit Information

CONSIDERATIONS AND PREREQUISITES FOR MAINTAINING CALCULATION CARDS

Identifying Auto-generated Calculation Cards


Some calculation cards are auto-generated and you are unlikely to know the source key values that uniquely identify the calculation
card records.

You can supply user key values to identify these records, but this relies on you knowing the assignment number of your employee’s
assignment. If you do not know this you can:

– Extract the auto-generated source key values using the Integration Object User Key Map extract. Reference the HCM Data
Loader Extracts: Explained topic in the Integrating with Oracle HCM Cloud guide, available on the Oracle Help Center.

– Optionally update the auto-generated source key. Reference the Updating Source Keys: Explained topic in the Integrating with
Oracle HCM Cloud guide, available on the Oracle Help Center.

Creating New Calculation Cards


If you are creating a new Calculation Card you are recommended to use source keys to uniquely identify the records being loaded. This
will simplify the file shape and allow you to more easily identify your calculation card records when you need to maintain them.

Updating Existing Calculation Cards

If you know your source key values it is recommended that they are used to reference the records to be updated, but user keys are also
supported.

If required, the Integration Object User Key Map Extract can be used to extract all key values for existing calculation card records.

TAX CREDIT INFORMATION CALCULATION CARD


Tax Credit Information calculation cards store all the information required to accurately calculate federal and provincial taxes for an
employee.

CONSIDERATIONS AND PREREQUISITES


If the product license is set to Payroll or Payroll Interface, Tax Credit Information calculation cards are auto-generated for your
Canadian new hires. You then need to:

– Update the Canadian Taxation, Federal Tax, Employment Insurance, and Canada Pension Plan
card components, if applicable.

– Create a Provincial Tax card component, if applicable.

– Create a Payroll Tax card component, if applicable.

– Create a Quebec Tax card component, if applicable.

– Create a tax reporting unit association for the Canadian Taxation card component.

7 W HITE PAPER / Loading Tax Withholding Information for Canada


Using HCM Data Loader
If your employees were created in the Oracle Human Capital Management Cloud without a Payroll or Payroll Interface license then you
need to create the complete Tax Credit Information calculation card.

Generating the Surrogate ID of the Tax Reporting Unit


The component sequence for the Canadian Taxation card component is the surrogate ID of the employee's tax reporting unit. It is an
application-generated value to uniquely identify the tax reporting unit. You may use the Tax Reporting Unit BI Publisher report to extract
your tax reporting units and their surrogate ID values. For details on how to import and execute this report, please refer to the
attachment “Calculation Cards – Supporting BI Publisher Reports” document under the MOS document “Loading Canada Data using
HCM Data Loader” on My Oracle Support.

TAX CREDIT INFORMATION CALCULATION CARD RECORD TYPES


The Tax Credit Information card is uploaded with HCM Data Loader using the Global Payroll Calculation Card business object. This
generic object hierarchy provides record types to support the various localization requirements. The Tax Credit Information card
utilizes the following record types:

Calculation Card Record Types for Tax Credit Information

COMPONENT FUNCTIONAL DESCRIPTION DISCRIMINATOR

Calculation Card Defines the calculation card type and which employee assignment it captures CalculationCard
information for.

Card Component Used to group and segregate data required by the calculation card. CardComponent
The following sections describe the card components applicable to this
calculation card and which child records are required for each card component.

Component Detail Supply a component detail record for each flexfield context required by each ComponentDetail
card component.

Calculation Value Allows the creation of value definitions so that overriding values can be CalculationValueDefinition
Definition specified on the card component.
Details of the specific value definitions are provided in the following sections.

Enterable For each calculation value definition an overriding value can be specified using EnterableCalculationValue
Calculation Value the Enterable Calculation Value record type.

Card Association Associates the calculation card with the Tax Reporting Unit the employee CardAssociation
reports to.

Card Association Associates card components with the employee’s assignments. CardAssociationDetails
Detail

Calculation Card Hierarchy


The hierarchy of Calculation Card components applicable to Tax Credit Information are described in this diagram:

8 W HITE PAPER / Loading Tax Withholding Information for Canada


Using HCM Data Loader
The card components can have flexfield segments and override values.

A separate section follows to describe how to provide data for each card component and the card association.

9 W HITE PAPER / Loading Tax Withholding Information for Canada


Using HCM Data Loader
CALCULATION CARD: TAX CREDIT INFORMATION
Supply one Calculation Card record for every Canadian employee you are maintaining Tax Credit Information for.

Even if you are updating an existing calculation card and the calculation card itself is not being updated, still include the calculation card
record to group other related data supplied in the file.

Calculation Card
The Tax Credit Information calculation card uses these attributes:

Calculation Card Attributes for Tax Credit Information

HCM DATA LOADER


ATTRIBUTE ALTERNATIVE USER KEY ATTRIBUTES FUNCTIONAL DESCRIPTION

SourceSystemId CardSequence, AssignmentNumber, The value that uniquely identifies the Tax Credit Information
DirCardDefinitionName, calculation card. For new calculation card supply the source key
LegislativeDataGroupName attributes. You can also identify calculation cards with the user
key attributes.

Source System Owner The name of the source system used to generate the source
system ID.

LegislativeDataGroupName The name of the Legislative Data Group for the calculation
card.

DirCardDefinitionName The name of the card definition. Specify ‘Tax Credit


Information’.

CardSequence A number to uniquely identify this card when multiple


calculation cards for the same card definition exist for the
employee. Not required when source keys are used.

AssignmentId(SourceSyste AssignmentNumber The employee assignment the calculation card is for. Either the
mId) source system ID or assignment number can be used to identify
the employee assignment.

EffectiveStartDate The start date of the calculation card, typically the employee’s
start date.

CARD COMPONENT: CANADIAN TAXATION


Supply a Canadian Taxation card component and detail values for each tax reporting unit for the employee.

Card Component Hierarchy

The Canadian Taxation card component utilizes the Taxation Context flexfield context and data for this is loaded using the
Component Detail record type. The employee’s tax reporting unit is associated with the Canadian Taxation card component, this
association is described in the Card Association section.

10 W HITE PAPER / Loading Tax Withholding Information for Canada


Using HCM Data Loader
The following sections describe how to supply valid file lines for these record types.

Card Component
The Canadian Taxation card component uses these attributes:

Card Component Attributes for Canadian Taxation

HCM DATA LOADER


ATTRIBUTE ALTERNATIVE USER KEY ATTRIBUTES FUNCTIONAL DESCRIPTION

SourceSystemId CardSequence, ComponentSequence, The value that uniquely identifies the Canadian Taxation card
AssignmentNumber, component. For new card components supply the source key
DirCardDefinitionName, attributes. You can also identify card component records using
LegislativeDataGroupName, the user key attributes.
DirCardCompDefName

Source System Owner The name of the source system used to generate the source
system ID.

LegislativeDataGroupName The name of the legislative data group for the card component
definition.

DirCardId(SourceSystemId) CardSequence, AssignmentNumber, The parent Tax Credit Information calculation card. Use the
DirCardDefinitionName, same key type used to identify the calculation card.
LegislativeDataGroupName When using source keys supply this attribute with the value
supplied for the calculation card’s SourceSystemId attribute.
Otherwise supply the user key attributes with the same values
as the parent calculation card.

EffectiveStartDate The start date of the card component. This must be after or
equal to the EffectiveStartDate on the Tax Credit Information
calculation card.

EffectiveEndDate An optional end date for the card component.

DirCardCompDefName The name of the card component definition. Specify ‘Canadian


Taxation’’

ComponentSequence The component sequence for the Canadian Taxation card


component is the surrogate ID of the employee's tax reporting
unit. It is an application-generated value to uniquely identify the
tax reporting unit.
Note: You may use the Tax Reporting Unit BI Publisher report
to extract your tax reporting units and their surrogate ID values.
For details on how to import and execute this report, please
refer to the attachment “Calculation Cards – Supporting BI
Publisher Reports” document under the MOS document
“Loading Canada Data using HCM Data Loader” on My Oracle
Support.

Context1 The surrogate ID of the employee's tax reporting unit. Supply


the same value as provided for the ComponentSequence

11 W HITE PAPER / Loading Tax Withholding Information for Canada


Using HCM Data Loader
Component Detail
In addition to the attributes defined here, include the necessary flexfield Finding Flexfield Segment Attributes
segment attribute values for the flexfield context: You can find the flexfield segment attributes for the
flexfield context using the View Business Object task.
– Taxation Context (HRX_CA_WTH_TAXATION)

Component Detail Attributes for Canadian Taxation

HCM DATA LOADER


ATTRIBUTE ALTERNATIVE USER KEY ATTRIBUTES FUNCTIONAL DESCRIPTION

SourceSystemId CardSequence, ComponentSequence, The value that uniquely identifies the Canadian Taxation
DirInformationCategory, component detail. For new component detail records supply the
LegislativeDataGroupName, source key attributes. You can also identify component detail
AssignmentNumber, records using the user key attributes.
DirCardDefinitionName,
DirCardCompDefName

Source System Owner The name of the source system used to generate the source
system ID.

LegislativeDataGroupName The name of the legislative data group. Required to identify the
component flexfield.

DirCardCompId CardSequence, ComponentSequence, The parent Canadian Taxation card component. Use the same
(SourceSystemId) AssignmentNumber, key type used to identify the card component.
DirCardDefinitionName, When using source keys supply this attribute with the value
LegislativeDataGroupName, supplied for the card component’s SourceSystemId attribute.
DirCardCompDefName Otherwise supply the user key attributes with the same values
as the parent card component.

EffectiveStartDate The start date of the component detail, or update to the


component detail if you are providing date-effective history. This
must be after or equal to the EffectiveStartDate provided for the
Canadian Taxation card component.

EffectiveEndDate The optional end date of the component detail, or if you are
providing date-effective history the last day of the date-effective
changes.

DirCompFlexId DirInformationCategory, The component flexfield ID. Provide the user key attributes
LegislativeDataGroupName, listed to identify the component flexfield.
DirCardCompDefName

DirInformationCategory The code for the flexfield context data is provided for. Supply
‘HRX_CA_WTH_TAXATION’.

FLEX:Deduction Developer The flexfield context code. Supply the same value as for the
DF DirInformationCategory attribute.

Example File Lines


These file lines can be used to update an auto-generated Canadian Taxation card component of the Tax Credit Information
calculation card.

12 W HITE PAPER / Loading Tax Withholding Information for Canada


Using HCM Data Loader
Example File 1: Maintaining Canadian Taxation

METADATA|CalculationCard|LegislativeDataGroupName|DirCardDefinitionName|AssignmentNumber|CardSequence|Effe
ctiveStartDate
MERGE|CalculationCard|CA LDG|Tax Credit Information|E816423|1|2019/05/02

METADATA|CardComponent|LegislativeDataGroupName|DirCardDefinitionName|AssignmentNumber|CardSequence|Effect
iveStartDate|DirCardCompDefName|ComponentSequence|Context1
MERGE|CardComponent|CA LDG|Tax Credit Information|E816423|1|2019/05/02|Canadian
Taxation|300100044131319|300100044131319

METADATA|ComponentDetail|LegislativeDataGroupName|DirCardDefinitionName|AssignmentNumber|CardSequence|Effe
ctiveStartDate|DirCardCompDefName|ComponentSequence|DirInformationCategory|FLEX:Deduction Developer
DF|provinceOfEmployement(Deduction Developer DF=HRX_CA_WTH_TAXATION)|oraHrxCaVlPlan(Deduction Developer
DF=HRX_CA_WTH_TAXATION)|oraHrxCaVacServDate(Deduction Developer DF=HRX_CA_WTH_TAXATION)
MERGE|ComponentDetail|CA LDG|Tax Credit Information|E816423|1|2019/05/02|Canadian
Taxation|300100044131319|HRX_CA_WTH_TAXATION|HRX_CA_WTH_TAXATION|19||

13 W HITE PAPER / Loading Tax Withholding Information for Canada


Using HCM Data Loader
CARD COMPONENT: FEDERAL TAX
The Federal Tax card component is used to capture information that will impact Federal Tax calculations for the employee.

Each Tax Credit Information calculation card should have one Federal Tax card component.

Card Component Hierarchy

The Federal Tax card component utilizes the Federal Tax Context flexfield context and data for this is loaded using the Component
Detail record type. It has multiple overrides, values which are supplied using the Calculation Value Definition and Enterable Calculation
Value record types.

14 W HITE PAPER / Loading Tax Withholding Information for Canada


Using HCM Data Loader
The following sections describe how to supply valid file lines for these record types.

Card Component
The Federal Tax card component uses these attributes:

Card Component Attributes for Federal Tax

HCM DATA LOADER


ATTRIBUTE ALTERNATIVE USER KEY ATTRIBUTES FUNCTIONAL DESCRIPTION

SourceSystemId CardSequence, ComponentSequence, The value that uniquely identifies the Federal Tax card
AssignmentNumber, component. For new card components supply the source key
DirCardDefinitionName, attributes. You can also identify card component records using
LegislativeDataGroupName, the user key attributes.
DirCardCompDefName

Source System Owner The name of the source system used to generate the source
system ID.

LegislativeDataGroupName The name of the legislative data group for the card component
definition.

DirCardId(SourceSystemId) CardSequence, AssignmentNumber, The parent Tax Credit Information calculation card. Use the
DirCardDefinitionName, same key type used to identify the calculation card.
LegislativeDataGroupName When using source keys supply this attribute with the value
supplied for the calculation card’s SourceSystemId attribute.
Otherwise supply the user key attributes with the same values
as the parent calculation card.

EffectiveStartDate The start date of the card component. This must be after or
equal to the EffectiveStartDate on the Tax Credit Information
calculation card.

EffectiveEndDate An optional end date for the card component.

DirCardCompDefName The name of the card component definition. Specify ‘Federal


Tax’.

ComponentSequence A number to uniquely identify this card component when


multiple card components for the same card component
definition exist on the same card. Not required when source
keys are used.

Component Detail Finding Flexfield Segment Attributes


In addition to the attributes defined here, include the necessary flexfield segment You can find the flexfield segment attributes for the
attribute values for the flexfield contexts: flexfield context using the View Business Object task.

– Federal Tax Context (HRX_CA_WTH_FEDERAL_INCOME_TAX)

– Canadian Taxation Context (HRX_CA_WTH_TAXATION)

– Employment Insurance Context (HRX_CA_WTH_FEDERAL_EMPLOYMENT_INSURANCE)

– Canada Pension Plan Context (HRX_CA_WTH_FEDERAL_PENSION_PLAN)

The subsequent sections describe each flexfield segments.

15 W HITE PAPER / Loading Tax Withholding Information for Canada


Using HCM Data Loader
Component Detail Attributes for Federal Tax

HCM DATA LOADER


ATTRIBUTE ALTERNATIVE USER KEY ATTRIBUTES FUNCTIONAL DESCRIPTION

SourceSystemId CardSequence, ComponentSequence, The value that uniquely identifies the Federal Tax component
DirInformationCategory, detail. For new component detail records supply the source key
LegislativeDataGroupName, attributes. You can also identify component detail records using
AssignmentNumber, the user key attributes.
DirCardDefinitionName,
DirCardCompDefName

Source System Owner The name of the source system used to generate the source
system ID.

LegislativeDataGroupName The name of the legislative data group. Required to identify the
component flexfield.

DirCardCompId CardSequence, ComponentSequence, The parent Federal Tax card component. Use the same key
(SourceSystemId) AssignmentNumber, type used to identify the card component.
DirCardDefinitionName, When using source keys supply this attribute with the value
LegislativeDataGroupName, supplied for the card component’s SourceSystemId attribute.
DirCardCompDefName Otherwise supply the user key attributes with the same values
as the parent card component.

EffectiveStartDate The start date of the component detail, or update to the


component detail if you are providing date-effective history. This
must be after or equal to the EffectiveStartDate provided for the
Federal Tax card component.

EffectiveEndDate The optional end date of the component detail, or if you are
providing date-effective history the last day of the date-effective
changes.

DirCompFlexId DirInformationCategory, The component flexfield ID. Provide the user key attributes
LegislativeDataGroupName, listed to identify the component flexfield.
DirCardCompDefName

DirInformationCategory The code for the flexfield context data is provided for. Specify
‘HRX_CA_WTH_FEDERAL_INCOME_TAX’.

FLEX:Deduction Developer The flexfield context code. Supply the same value as for the
DF DirInformationCategory attribute.

Calculation Value Definition


The Federal Tax card component utilizes value definitions to supply override values.

Value Definitions for Federal Tax

VALUE DEFINITION NAME FUNCTIONAL DESCRIPTION

Additional Tax This value represents the amount an employee elects to have deducted as extra tax, in addition
to the tax calculation. The amount is entered in dollars.

16 W HITE PAPER / Loading Tax Withholding Information for Canada


Using HCM Data Loader
VALUE DEFINITION NAME FUNCTIONAL DESCRIPTION

Annual Deduction This value represents a tax reduction relating to child care and alimony expenses that is
authorized by a tax services office.

Commission Expenses The amount of expenses a commissioned employee is expected to have in the calendar year.

Commission Remuneration The amount of income a commissioned employee is expected to earn in the calendar year.

Federal Tax Amount This is an override for the federal income tax amount.
Note: If an Additional Tax value is entered for the employee, it is deducted in addition to the
Federal Tax Amount.

Federal Tax Rate This is an override for federal income tax rate.

Labour Fund Contributions A tax calculation reduction applicable only when the employee has deductions related to labour-
sponsored funds.

Prescribed Zone Deduction A federal tax calculation reduction for those employees that live in a prescribed zone.

Total Claim Amount This value represents the federal tax exemption amount.
Note: This value defaults to the basic amount populated from the Load Payroll Tax Information
process. For employees with the basic amount, do not populate the Total Claim Amount, as the
value will be read as an override and will not be updated by the Load Payroll Tax Information
process when the basic amounts change.
If the employee has a total claim amount greater than the basic amount, the higher amount
should be entered here. This override is not reset to the basic amount or updated at the
beginning of the year. It will remain the same until modified by the user, or reset using the Tax
Overrides Report.

Other Tax Credits An additional tax credit used to reduce the income tax amount, as authorized by the
government.

The Calculation Value Definition record type specifies the value definition name.

Calculation Value Definition Attributes for Federal Tax

HCM DATA LOADER


ATTRIBUTE ALTERNATIVE USER KEY ATTRIBUTES FUNCTIONAL DESCRIPTION

SourceSystemId CardSequence, ComponentSequence, The value that uniquely identifies the Calculation Value
AssignmentNumber, Definition. For new records supply the source key attributes.
DirCardDefinitionName, You can also identify calculation value definition records using
LegislativeDataGroupName, the user key attributes.
DirCardCompDefName,
ValueDefinitionName

Source System Owner The name of the source system used to generate the source
system ID.

LegislativeDataGroupName The name of the legislative data group for the value definition.

SourceId(SourceSystemId) CardSequence, ComponentSequence, The parent Federal Tax card component. Use the same key
AssignmentNumber, type used to identify the card component.
DirCardDefinitionName, When using source keys supply this attribute with the value
LegislativeDataGroupName, supplied for the card component’s SourceSystemId attribute.
DirCardCompDefName

17 W HITE PAPER / Loading Tax Withholding Information for Canada


Using HCM Data Loader
HCM DATA LOADER
ATTRIBUTE ALTERNATIVE USER KEY ATTRIBUTES FUNCTIONAL DESCRIPTION

Otherwise supply the user key attributes with the same values
as the parent card component.

EffectiveStartDate The start date of the Federal Tax card component, or the date
the calculation value definition starts if later.

DirCardCompDefName

ValueDefinitionName The name of the value being overridden. The list of value
definitions applicable to this card component are listed above.

Enterable Calculation Value


The Enterable Calculation Value details the override value for the value definition. You reference the Calculation Value Definition record
the override value is for.

Enterable Calculation Value Attributes for Federal Tax

HCM DATA LOADER


ATTRIBUTE ALTERNATIVE USER KEY ATTRIBUTES FUNCTIONAL DESCRIPTION

SourceSystemId CardSequence, ComponentSequence, The value that uniquely identifies Enterable Calculation Value.
AssignmentNumber, For new records supply the source key attributes. You can also
DirCardDefinitionName, identify enterable calculation value records using the user key
LegislativeDataGroupName, attributes.
DirCardCompDefName, .
ValueDefinitionName

Source System Owner The name of the source system owner used to generate the
source system ID.

ValueDefnIdSourceSystemI CardSequence, ComponentSequence, The parent Calculation Value Definition record. Use the same
d) AssignmentNumber, key type used to identify the calculation value definition.
DirCardDefinitionName, When using source keys supply this attribute with the value
LegislativeDataGroupName, supplied for the calculation value definition’s SourceSystemId
DirCardCompDefName, attribute. Otherwise supply the user key attributes with the
ValueDefinitionName same values as the parent record.

EffectiveStartDate The EffectiveStartDate of the parent calculation value definition


record, or the update to the override value if supplying date-
effective history.

EffectiveEndDate The optional end date of the component detail, or if you are
providing date-effective history the last day of the date-effective
changes.

LegislativeDataGroupName The name of the legislative data group for the override value.

Value1 The value for the value definition identified by the parent
calculation value definition record.
Supply -999999999 to indicate a null (blank) value.

18 W HITE PAPER / Loading Tax Withholding Information for Canada


Using HCM Data Loader
Example File Lines
These file lines can be used to update the auto-generated Federal Tax card component of the Tax Credit Information calculation
card.

Example File 2: Maintaining Federal Tax

METADATA|CalculationCard|LegislativeDataGroupName|DirCardDefinitionName|AssignmentNumber|CardSequence|Effe
ctiveStartDate
MERGE|CalculationCard|CA LDG|Tax Credit Information|E816423|1|2019/05/02

METADATA|CardComponent|LegislativeDataGroupName|DirCardDefinitionName|AssignmentNumber|CardSequence|Effect
iveStartDate|DirCardCompDefName|ComponentSequence
MERGE|CardComponent|CA LDG|Tax Credit Information|E816423|1|2019/05/02|Federal Tax|1

METADATA|ComponentDetail|LegislativeDataGroupName|DirCardDefinitionName|AssignmentNumber|CardSequence|Effe
ctiveStartDate|DirCardCompDefName|ComponentSequence|DirInformationCategory|FLEX:Deduction Developer
DF|federalTaxExempt(Deduction Developer DF=HRX_CA_WTH_FEDERAL_INCOME_TAX)
MERGE|ComponentDetail|CA LDG|Tax Credit Information|E816423|1|2019/05/02|Federal
Tax|1|HRX_CA_WTH_FEDERAL_INCOME_TAX|HRX_CA_WTH_FEDERAL_INCOME_TAX|Y

METADATA|CalculationValueDefinition|LegislativeDataGroupName|DirCardDefinitionName|AssignmentNumber|CardSe
quence|EffectiveStartDate|DirCardCompDefName|ComponentSequence|ValueDefinitionName
MERGE|CalculationValueDefinition|CA LDG|Tax Credit Information|E816423|1|2019/05/02|Federal
Tax|1|Additional Tax
MERGE|CalculationValueDefinition|CA LDG|Tax Credit Information|E816423|1|2019/05/02|Federal Tax|1|Annual
Deduction
MERGE|CalculationValueDefinition|CA LDG|Tax Credit Information|E816423|1|2019/05/02|Federal
Tax|1|Commission Expenses
MERGE|CalculationValueDefinition|CA LDG|Tax Credit Information|E816423|1|2019/05/02|Federal
Tax|1|Commission Remuneration
MERGE|CalculationValueDefinition|CA LDG|Tax Credit Information|E816423|1|2019/05/02|Federal Tax|1|Federal
Tax Amount
MERGE|CalculationValueDefinition|CA LDG|Tax Credit Information|E816423|1|2019/05/02|Federal Tax|1|Federal
Tax Rate
MERGE|CalculationValueDefinition|CA LDG|Tax Credit Information|E816423|1|2019/05/02|Federal Tax|1|Labour
Fund Contributions
MERGE|CalculationValueDefinition|CA LDG|Tax Credit Information|E816423|1|2019/05/02|Federal
Tax|1|Prescribed Zone Deduction
MERGE|CalculationValueDefinition|CA LDG|Tax Credit Information|E816423|1|2019/05/02|Federal Tax|1|Total
Claim Amount
MERGE|CalculationValueDefinition|CA LDG|Tax Credit Information|E816423|1|2019/05/02|Federal Tax|1|Other
Tax Credits

METADATA|EnterableCalculationValue|LegislativeDataGroupName|DirCardDefinitionName|AssignmentNumber|CardSeq
uence|EffectiveStartDate|DirCardCompDefName|ComponentSequence|ValueDefinitionName|Value1
MERGE|EnterableCalculationValue|CA LDG|Tax Credit Information|E816423|1|2019/05/02|Federal
Tax|1|Additional Tax|100
MERGE|EnterableCalculationValue|CA LDG|Tax Credit Information|E816423|1|2019/05/02|Federal Tax|1|Annual
Deduction|100
MERGE|EnterableCalculationValue|CA LDG|Tax Credit Information|E816423|1|2019/05/02|Federal
Tax|1|Commission Expenses|100
MERGE|EnterableCalculationValue|CA LDG|Tax Credit Information|E816423|1|2019/05/02|Federal
Tax|1|Commission Remuneration|100
MERGE|EnterableCalculationValue|CA LDG|Tax Credit Information|E816423|1|2019/05/02|Federal Tax|1|Federal
Tax Amount|100
MERGE|EnterableCalculationValue|CA LDG|Tax Credit Information|E816423|1|2019/05/02|Federal Tax|1|Federal
Tax Rate|100
MERGE|EnterableCalculationValue|CA LDG|Tax Credit Information|E816423|1|2019/05/02|Federal Tax|1|Labour
Fund Contributions|100
MERGE|EnterableCalculationValue|CA LDG|Tax Credit Information|E816423|1|2019/05/02|Federal
Tax|1|Prescribed Zone Deduction|100
MERGE|EnterableCalculationValue|CA LDG|Tax Credit Information|E816423|1|2019/05/02|Federal Tax|1|Total
Claim Amount|100
MERGE|EnterableCalculationValue|CA LDG|Tax Credit Information|E816423|1|2019/05/02|Federal Tax|1|Other Tax
Credits|100

19 W HITE PAPER / Loading Tax Withholding Information for Canada


Using HCM Data Loader
CARD COMPONENT: EMPLOYMENT INSURANCE
The Employment Insurance card component is used to capture information that will impact Employment Insurance calculations for the
employee.

Each Tax Credit Information calculation card should have one Employment Insurance card component.

Card Component Hierarchy

The Employment Insurance card component utilizes the Employment Insurance Context flexfield context and data for this is loaded
using the Component Detail record type. The following sections describe how to supply valid file lines for these record types.

Card Component
The Employment Insurance card component uses these attributes:

Card Component Attributes for Employment Insurance

HCM DATA LOADER


ATTRIBUTE ALTERNATIVE USER KEY ATTRIBUTES FUNCTIONAL DESCRIPTION

SourceSystemId CardSequence, ComponentSequence, The value that uniquely identifies the Employment Insurance
AssignmentNumber, card component. For new card components supply the source
DirCardDefinitionName, key attributes. You can also identify card component records
LegislativeDataGroupName, using the user key attributes.
DirCardCompDefName

Source System Owner The name of the source system used to generate the source
system ID.

LegislativeDataGroupName The name of the legislative data group for the card component
definition.

DirCardId(SourceSystemId) CardSequence, AssignmentNumber, The parent Tax Credit Information calculation card. Use the
DirCardDefinitionName, same key type used to identify the calculation card.
LegislativeDataGroupName When using source keys supply this attribute with the value
supplied for the calculation card’s SourceSystemId attribute.
Otherwise supply the user key attributes with the same values
as the parent calculation card.

EffectiveStartDate The start date of the card component. This must be after or
equal to the EffectiveStartDate on the Tax Credit Information
calculation card.

EffectiveEndDate An optional end date for the card component.

DirCardCompDefName The name of the card component definition. Specify


‘Employment Insurance’.

ComponentSequence A number to uniquely identify this card component when


multiple card components for the same card component

20 W HITE PAPER / Loading Tax Withholding Information for Canada


Using HCM Data Loader
HCM DATA LOADER
ATTRIBUTE ALTERNATIVE USER KEY ATTRIBUTES FUNCTIONAL DESCRIPTION

definition exist on the same card. Not required when source


keys are used.

Component Detail
Finding Flexfield Segment Attributes
In addition to the attributes defined here, include the necessary flexfield
You can find the flexfield segment attributes for the
segment attribute values for the flexfield context:
flexfield context using the View Business Object task.

– Employment Insurance Context


(HRX_CA_WTH_FEDERAL_EMPLOYMENT_INSURANCE)

Component Detail Attributes for Employment Insurance

HCM DATA LOADER


ATTRIBUTE ALTERNATIVE USER KEY ATTRIBUTES FUNCTIONAL DESCRIPTION

SourceSystemId CardSequence, ComponentSequence, The value that uniquely identifies the Employment Insurance
DirInformationCategory, component detail. For new component detail records supply the
LegislativeDataGroupName, source key attributes. You can also identify component detail
AssignmentNumber, records using the user key attributes.
DirCardDefinitionName,
DirCardCompDefName

Source System Owner The name of the source system used to generate the source
system ID.

LegislativeDataGroupName The name of the legislative data group. Required to identify the
component flexfield.

DirCardCompId CardSequence, ComponentSequence, The parent Employment Insurance card component. Use the
(SourceSystemId) AssignmentNumber, same key type used to identify the card component.
DirCardDefinitionName, When using source keys supply this attribute with the value
LegislativeDataGroupName, supplied for the card component’s SourceSystemId attribute.
DirCardCompDefName Otherwise supply the user key attributes with the same values
as the parent card component.

EffectiveStartDate The start date of the component detail, or update to the


component detail if you are providing date-effective history. This
must be after or equal to the EffectiveStartDate provided for the
Employment Insurance card component.

EffectiveEndDate The optional end date of the component detail, or if you are
providing date-effective history the last day of the date-effective
changes.

DirCompFlexId DirInformationCategory, The component flexfield ID. Provide the user key attributes
LegislativeDataGroupName, listed to identify the component flexfield.
DirCardCompDefName

DirInformationCategory The code for the flexfield context data is provided for. Specify
‘HRX_CA_WTH_FEDERAL_EMPLOYMENT_INSURANCE’.

FLEX:Deduction Developer The flexfield context code. Supply the same value as for the
DF DirInformationCategory attribute.

21 W HITE PAPER / Loading Tax Withholding Information for Canada


Using HCM Data Loader
Example File Lines
These file can be used to update the auto-generated Employment Insurance card component of the Tax Credit Information
calculation card.

METADATA|CalculationCard|LegislativeDataGroupName|DirCardDefinitionName|AssignmentNumber|CardSequence|Effe
ctiveStartDate
MERGE|CalculationCard|CA LDG|Tax Credit Information|E816423|1|2019/05/02

METADATA|CardComponent|LegislativeDataGroupName|DirCardDefinitionName|AssignmentNumber|CardSequence|Effect
iveStartDate|DirCardCompDefName|ComponentSequence
MERGE|CardComponent|CA LDG|Tax Credit Information|E816423|1|2019/05/02|Employment Insurance|1

METADATA|ComponentDetail|LegislativeDataGroupName|DirCardDefinitionName|AssignmentNumber|CardSequence|Effe
ctiveStartDate|DirCardCompDefName|ComponentSequence|DirInformationCategory|FLEX:Deduction Developer
DF|eiExempt(Deduction Developer DF=HRX_CA_WTH_FEDERAL_EMPLOYMENT_INSURANCE)
MERGE|ComponentDetail|CA LDG|Tax Credit Information|E816423|1|2019/05/02|Employment
Insurance|1|HRX_CA_WTH_FEDERAL_EMPLOYMENT_INSURANCE|HRX_CA_WTH_FEDERAL_EMPLOYMENT_INSURANCE|Y

22 W HITE PAPER / Loading Tax Withholding Information for Canada


Using HCM Data Loader
CARD COMPONENT: CANADA PENSION PLAN
The Canada Pension Plan card component is used to capture information that will impact Canada Pension Plan calculations for the
employee.

Each Tax Credit Information calculation card should have one Canada Pension Plan card component.

Card Component Hierarchy

The Canada Pension Plan card component utilizes the Canada Pension Plan Context flexfield context and data for this is loaded
using the Component Detail record type. The following sections describe how to supply valid file lines for these record types.

Card Component
The Canada Pension Plan card component uses these attributes:

Card Component Attributes for Canada Pension Plan

HCM DATA LOADER


ATTRIBUTE ALTERNATIVE USER KEY ATTRIBUTES FUNCTIONAL DESCRIPTION

SourceSystemId CardSequence, ComponentSequence, The value that uniquely identifies the Canada Pension Plan
AssignmentNumber, card component. For new card components supply the source
DirCardDefinitionName, key attributes. You can also identify card component records
LegislativeDataGroupName, using the user key attributes.
DirCardCompDefName

Source System Owner The name of the source system used to generate the source
system ID.

LegislativeDataGroupName The name of the legislative data group for the card component
definition.

DirCardId(SourceSystemId) CardSequence, AssignmentNumber, The parent Tax Credit Information calculation card. Use the
DirCardDefinitionName, same key type used to identify the calculation card.
LegislativeDataGroupName When using source keys supply this attribute with the value
supplied for the calculation card’s SourceSystemId attribute.
Otherwise supply the user key attributes with the same values
as the parent calculation card.

EffectiveStartDate The start date of the card component. This must be after or
equal to the EffectiveStartDate on the Tax Credit Information
calculation card.

EffectiveEndDate An optional end date for the card component.

DirCardCompDefName The name of the card component definition. Specify ‘Canada


Pension Plan’.

ComponentSequence A number to uniquely identify this card component when


multiple card components for the same card component

23 W HITE PAPER / Loading Tax Withholding Information for Canada


Using HCM Data Loader
HCM DATA LOADER
ATTRIBUTE ALTERNATIVE USER KEY ATTRIBUTES FUNCTIONAL DESCRIPTION

definition exist on the same card. Not required when source


keys are used.

Component Detail Finding Flexfield Segment Attributes


In addition to the attributes defined here, include the necessary flexfield segment You can find the flexfield segment attributes for the
attribute values for the flexfield context: flexfield context using the View Business Object task.

– Canada Pension Plan Context


(HRX_CA_WTH_FEDERAL_PENSION_PLAN)

Component Detail Attributes for Canada Pension Plan

HCM DATA LOADER


ATTRIBUTE ALTERNATIVE USER KEY ATTRIBUTES FUNCTIONAL DESCRIPTION

SourceSystemId CardSequence, ComponentSequence, The value that uniquely identifies the Canada Pension Plan
DirInformationCategory, component detail. For new component detail records supply the
LegislativeDataGroupName, source key attributes. You can also identify component detail
AssignmentNumber, records using the user key attributes.
DirCardDefinitionName,
DirCardCompDefName

Source System Owner The name of the source system used to generate the source
system ID.

LegislativeDataGroupName The name of the legislative data group. Required to identify the
component flexfield.

DirCardCompId CardSequence, ComponentSequence, The parent Canada Pension Plan card component. Use the
(SourceSystemId) AssignmentNumber, same key type used to identify the card component.
DirCardDefinitionName, When using source keys supply this attribute with the value
LegislativeDataGroupName, supplied for the card component’s SourceSystemId attribute.
DirCardCompDefName Otherwise supply the user key attributes with the same values
as the parent card component.

EffectiveStartDate The start date of the component detail, or update to the


component detail if you are providing date-effective history. This
must be after or equal to the EffectiveStartDate provided for the
Canada Pension Plan card component.

EffectiveEndDate The optional end date of the component detail, or if you are
providing date-effective history the last day of the date-effective
changes.

DirCompFlexId DirInformationCategory, The component flexfield ID. Provide the user key attributes
LegislativeDataGroupName, listed to identify the component flexfield.
DirCardCompDefName

DirInformationCategory The code for the flexfield context data is provided for. Specify
‘HRX_CA_WTH_FEDERAL_PENSION_PLAN’.

FLEX:Deduction Developer The flexfield context code. Supply the same value as for the
DF DirInformationCategory attribute.

24 W HITE PAPER / Loading Tax Withholding Information for Canada


Using HCM Data Loader
Example File Lines
These file lines can be used to update the auto-generated Canada Pension Plan card component of the Tax Credit Information
calculation card.

Example File 3: Maintaining Canada Pension Plan

METADATA|CalculationCard|LegislativeDataGroupName|DirCardDefinitionName|AssignmentNumber|CardSequence|Effe
ctiveStartDate
MERGE|CalculationCard|CA LDG|Tax Credit Information|E816423|1|2019/05/02

METADATA|CardComponent|LegislativeDataGroupName|DirCardDefinitionName|AssignmentNumber|CardSequence|Effect
iveStartDate|DirCardCompDefName|ComponentSequence
MERGE|CardComponent|CA LDG|Tax Credit Information|E816423|1|2019/05/02|Canada Pension Plan|1|

METADATA|ComponentDetail|LegislativeDataGroupName|DirCardDefinitionName|AssignmentNumber|CardSequence|Effe
ctiveStartDate|DirCardCompDefName|ComponentSequence|DirInformationCategory|FLEX:Deduction Developer
DF|cppRevocationDate(Deduction Developer DF=HRX_CA_WTH_FEDERAL_PENSION_PLAN)|cppExempt(Deduction Developer
DF=HRX_CA_WTH_FEDERAL_PENSION_PLAN)|cppElectionDate(Deduction Developer
DF=HRX_CA_WTH_FEDERAL_PENSION_PLAN)
MERGE|ComponentDetail|CA LDG|Tax Credit Information|E816423|1|2019/05/02|Canada Pension
Plan|1|HRX_CA_WTH_FEDERAL_PENSION_PLAN|HRX_CA_WTH_FEDERAL_PENSION_PLAN||Y|

25 W HITE PAPER / Loading Tax Withholding Information for Canada


Using HCM Data Loader
CARD COMPONENT: PROVINCIAL TAX
The Provincial Tax card component is used to capture information that will impact provincial tax calculations for the employee.

Each Tax Credit Information calculation card should have one Provincial Tax card component.

Card Component Hierarchy

All provinces utilize the Provincial Tax Context flexfield context and data for this is supplied using the Component Detail record type.
All provinces use value definitions and these are supplied using the Calculation Value Definition and Enterable Calculation Value record
types.

The following sections describe how to supply valid file lines for these record types.

Card Component
The Provincial Tax card component uses these attributes:

Card Component Attributes for Provincial Tax

HCM DATA LOADER


ATTRIBUTE ALTERNATIVE USER KEY ATTRIBUTES FUNCTIONAL DESCRIPTION

SourceSystemId CardSequence, ComponentSequence, The value that uniquely identifies the Provincial Tax card
AssignmentNumber, component. For new card components supply the source key
DirCardDefinitionName, attributes. You can also identify card component records using
LegislativeDataGroupName, the user key attributes.
DirCardCompDefName

Source System Owner The name of the source system used to generate the source
system ID.

LegislativeDataGroupName The name of the legislative data group for the card component
definition.

DirCardId(SourceSystemId) CardSequence, AssignmentNumber, The parent Tax Credit Information calculation card. Use the
DirCardDefinitionName, same key type used to identify the calculation card.
LegislativeDataGroupName When using source keys supply this attribute with the value
supplied for the calculation card’s SourceSystemId attribute.
Otherwise supply the user key attributes with the same values
as the parent calculation card.

26 W HITE PAPER / Loading Tax Withholding Information for Canada


Using HCM Data Loader
HCM DATA LOADER
ATTRIBUTE ALTERNATIVE USER KEY ATTRIBUTES FUNCTIONAL DESCRIPTION

EffectiveStartDate The start date of the card component. This must be after or
equal to the EffectiveStartDate on the Tax Credit Information
calculation card.

EffectiveEndDate An optional end date for the card component.

DirCardCompDefName The name of the card component definition. Specify ‘Provincial


Tax’.

ComponentSequence A number to uniquely identify this card component when


multiple card components for the same card component
definition exist on the same card. Not required when source
keys are used.

Context1 The code of the province. These are supplied in Appendix A -


Province Codes

Component Detail
In addition to the attributes defined here, include the necessary flexfield segment Finding Flexfield Segment Attributes

attribute values for the flexfield context: You can find the flexfield segment attributes for the
flexfield context using the View Business Object task.
– Provincial Tax Context (HRX_CA_WTH_PROVINCE_INCOME_TAX)

Component Detail Attributes for Provincial Tax

HCM DATA LOADER


ATTRIBUTE ALTERNATIVE USER KEY ATTRIBUTES FUNCTIONAL DESCRIPTION

SourceSystemId CardSequence, ComponentSequence, The value that uniquely identifies the Provincial Tax
DirInformationCategory, component detail. For new component detail records supply the
LegislativeDataGroupName, source key attributes. You can also identify component detail
AssignmentNumber, records using the user key attributes.
DirCardDefinitionName,
DirCardCompDefName

Source System Owner The name of the source system used to generate the source
system ID.

LegislativeDataGroupName The name of the legislative data group. Required to identify the
component flexfield.

DirCardCompId CardSequence, ComponentSequence, The parent Provincial Tax card component. Use the same key
(SourceSystemId) AssignmentNumber, type used to identify the card component.
DirCardDefinitionName, When using source keys supply this attribute with the value
LegislativeDataGroupName, supplied for the card component’s SourceSystemId attribute.
DirCardCompDefName Otherwise supply the user key attributes with the same values
as the parent card component.

EffectiveStartDate The start date of the component detail, or update to the


component detail if you are providing date-effective history. This
must be after or equal to the EffectiveStartDate provided for the
Provincial Tax card component.

27 W HITE PAPER / Loading Tax Withholding Information for Canada


Using HCM Data Loader
HCM DATA LOADER
ATTRIBUTE ALTERNATIVE USER KEY ATTRIBUTES FUNCTIONAL DESCRIPTION

EffectiveEndDate The optional end date of the component detail, or if you are
providing date-effective history the last day of the date-effective
changes.

DirCompFlexId DirInformationCategory, The component flexfield ID. Provide the user key attributes
LegislativeDataGroupName, listed to identify the component flexfield.
DirCardCompDefName

DirInformationCategory The code for the flexfield context data is provided for. Specify
‘HRX_CA_WTH_PROVINCE_INCOME_TAX’.

FLEX:Deduction Developer The flexfield context code. Supply the same value as for the
DF DirInformationCategory attribute.

Calculation Value Definition


The Provincial Tax card component utilizes value definitions to supply override values.

This table describes the value definitions that are applicable to each province. Note: All value definitions are applicable to Quebec.

Value Definitions for Provincial Tax

VALUE DEFINITION NAME FUNCTIONAL DESCRIPTION APPLICABLE TO WHICH PROVINCES

Other Tax Credits An additional tax credit used to reduce the income tax amount, All
as authorized by the government.

Total Claim Amount This value represents the provincial tax exemption amount. All
Note: This value defaults to the basic amount populated from
the Load Payroll Tax Information process. For employees with
the basic amount, do not populate the Total Claim Amount, as
the value will be read as an override and will not be updated by
the Load Payroll Tax Information process when the basic
amounts change.
If the employee has a total claim amount greater than the basic
amount, the higher amount should be entered here. This
override is not reset to the basic amount or updated at the
beginning of the year. It will remain the same until modified by
the user, or reset using the Tax Overrides Report.

Labour Fund Contributions A tax calculation reduction applicable only when the employee • British Columbia (BC)
has deductions related to labour-sponsored funds. • Manitoba (MB)
• New Brunswick (NB)
• Newfoundland and Labrador (NL)
• Nova Scotia (NS)
• Quebec (QC)
• Saskatchewan (SK)
• Yukon (YT)

Additional Tax This value represents the amount an employee elects to have Quebec (QC) only
deducted as extra tax, in addition to the tax calculation. The
amount is entered in dollars.

28 W HITE PAPER / Loading Tax Withholding Information for Canada


Using HCM Data Loader
VALUE DEFINITION NAME FUNCTIONAL DESCRIPTION APPLICABLE TO WHICH PROVINCES

Annual Deduction This value represents a tax reduction relating to child care and Quebec (QC) only
alimony expenses that is authorized by a tax services office.

Commission Expenses The amount of expenses a commissioned employee is Quebec (QC) only
expected to have in the calendar year.

Commission Remuneration The amount of income a commissioned employee is expected Quebec (QC) only
to earn in the calendar year.

Designated Remote Area A provincial tax calculation reduction for those employees that Quebec (QC) only
Deduction live in a designated remote area.

Provincial Tax Amount This is an override for the provincial income tax amount. Quebec (QC) only

Provincial Tax Rate This is an override for provincial income tax rate. Quebec (QC) only

The Calculation Value Definition record type specifies the value definition name.

Calculation Value Definition Attributes for Provincial Tax

HCM DATA LOADER


ATTRIBUTE ALTERNATIVE USER KEY ATTRIBUTES FUNCTIONAL DESCRIPTION

SourceSystemId CardSequence, ComponentSequence, The value that uniquely identifies the Calculation Value
AssignmentNumber, Definition. For new records supply the source key attributes.
DirCardDefinitionName, You can also identify calculation value definition records using
LegislativeDataGroupName, the user key attributes.
DirCardCompDefName,
ValueDefinitionName

Source System Owner The name of the source system used to generate the source
system ID.

LegislativeDataGroupName The name of the legislative data group for the value definition.

SourceId(SourceSystemId) CardSequence, ComponentSequence, The parent Provincial Tax card component. Use the same key
AssignmentNumber, type used to identify the card component.
DirCardDefinitionName, When using source keys supply this attribute with the value
LegislativeDataGroupName, supplied for the card component’s SourceSystemId attribute.
DirCardCompDefName Otherwise supply the user key attributes with the same values
as the parent card component.

EffectiveStartDate The start date of the Provincial Tax card component, or the
date the calculation value definition starts if later.

DirCardCompDefName

ValueDefinitionName The name of the value being overridden. The list of value
definitions applicable to this card component are listed above.

Context1 The code of the province the provincial tax override is for.
These are supplied in Appendix A - Province Codes

29 W HITE PAPER / Loading Tax Withholding Information for Canada


Using HCM Data Loader
Enterable Calculation Value
The Enterable Calculation Value details the override value for the value definition. You reference the Calculation Value Definition record
the override value is for.

Enterable Calculation Value Attributes for Provincial Tax

HCM DATA LOADER


ATTRIBUTE ALTERNATIVE USER KEY ATTRIBUTES FUNCTIONAL DESCRIPTION

SourceSystemId CardSequence, ComponentSequence, The value that uniquely identifies Enterable Calculation Value.
AssignmentNumber, For new records supply the source key attributes. You can also
DirCardDefinitionName, identify enterable calculation value records using the user key
LegislativeDataGroupName, attributes.
DirCardCompDefName, .
ValueDefinitionName

Source System Owner The name of the source system owner used to generate the
source system ID.

ValueDefnIdSourceSystemI CardSequence, ComponentSequence, The parent Calculation Value Definition record. Use the same
d) AssignmentNumber, key type used to identify the calculation value definition.
DirCardDefinitionName, When using source keys supply this attribute with the value
LegislativeDataGroupName, supplied for the calculation value definition’s SourceSystemId
DirCardCompDefName, attribute. Otherwise supply the user key attributes with the
ValueDefinitionName same values as the parent record.

EffectiveStartDate The EffectiveStartDate of the parent calculation value definition


record, or the update to the override value if supplying date-
effective history.

EffectiveEndDate The optional end date of the component detail, or if you are
providing date-effective history the last day of the date-effective
changes.

LegislativeDataGroupName The name of the legislative data group for the override value.

Value1 The value for the value definition identified by the parent
calculation value definition record.

Example File Lines


These file lines create the Provincial Tax card component for an auto-generated Tax Credit Information calculation card. This
example is for British Columbia.

Example File 4: Creating Provincial Tax

METADATA|CalculationCard|SourceSystemOwner|SourceSystemId|LegislativeDataGroupName|DirCardDefinitionName|A
ssignmentNumber|CardSequence|EffectiveStartDate
MERGE|CalculationCard|||CA LDG|Tax Credit Information|E816423|1|2019/05/02

METADATA|CardComponent|SourceSystemOwner|SourceSystemId|LegislativeDataGroupName|DirCardDefinitionName|Ass
ignmentNumber|CardSequence|EffectiveStartDate|DirCardCompDefName|ComponentSequence|Context1
MERGE|CardComponent|VISION|TCI_816423_PT_3|CA LDG|Tax Credit Information|E816423|1|2019/05/02|Provincial
Tax|3|3

30 W HITE PAPER / Loading Tax Withholding Information for Canada


Using HCM Data Loader
METADATA|ComponentDetail|SourceSystemId|SourceSystemOwner|LegislativeDataGroupName|DirCardCompId(SourceSys
temId)|EffectiveStartDate|DirCardCompDefName|DirInformationCategory|FLEX:Deduction Developer
DF|provinceTaxExempt(Deduction Developer
DF=HRX_CA_WTH_PROVINCE_INCOME_TAX)|numberOfDependentsUnderAge(Deduction Developer
DF=HRX_CA_WTH_PROVINCE_INCOME_TAX)|numberOfDisabledDependents(Deduction Developer
DF=HRX_CA_WTH_PROVINCE_INCOME_TAX)
MERGE|ComponentDetail|TCI_816423_PT_3_PIT|VISION|CA LDG|TCI_816423_PT_3|2019/05/02|Provincial
Tax|HRX_CA_WTH_PROVINCE_INCOME_TAX|HRX_CA_WTH_PROVINCE_INCOME_TAX|Y||

METADATA|CalculationValueDefinition|SourceSystemOwner|SourceSystemId|LegislativeDataGroupName|SourceId(Sou
rceSystemId)|EffectiveStartDate|DirCardCompDefName|ValueDefinitionName|Context1
MERGE|CalculationValueDefinition|VISION|TCI_816423_PT_3_VD1|CA LDG|TCI_816423_PT_3|2019/05/02|Provincial
Tax|Total Claim Amount|3
MERGE|CalculationValueDefinition|VISION|TCI_816423_PT_3_VD2|CA LDG|TCI_816423_PT_3|2019/05/02|Provincial
Tax|Other Tax Credits|3
MERGE|CalculationValueDefinition|VISION|TCI_816423_PT_3_VD3|CA LDG|TCI_816423_PT_3|2019/05/02|Provincial
Tax|Labour Fund Contributions|3

METADATA|EnterableCalculationValue|SourceSystemOwner|SourceSystemId|LegislativeDataGroupName|ValueDefnId(S
ourceSystemId)|EffectiveStartDate|DirCardCompDefName|ValueDefinitionName|Value1|Context1
MERGE|EnterableCalculationValue|VISION|TCI_816423_PT_3_VD1|CA
LDG|TCI_816423_PT_3_VD1|2019/05/02|Provincial Tax|Total Claim Amount|100|3
MERGE|EnterableCalculationValue|VISION|TCI_816423_PT_3_VD2|CA
LDG|TCI_816423_PT_3_VD2|2019/05/02|Provincial Tax|Other Tax Credits|100|3
MERGE|EnterableCalculationValue|VISION|TCI_816423_PT_3_VD3|CA
LDG|TCI_816423_PT_3_VD3|2019/05/02|Provincial Tax|Labour Fund Contributions|100|3
User keys are used to identify the auto-generated Tax Credit Information calculation card and the source key was auto-generated. Source keys uniquely
identify each new record. Supplying source keys simplifies the file shape and makes it easier to maintain the data.

CARD COMPONENT: PAYROLL TAX


The Payroll Tax card component is used to capture information that will impact payroll tax calculations for the employee.

Each Tax Credit Information calculation card should have one Payroll Tax card component, if the province is Northwest Territories and
Nunavut.

Card Component Hierarchy


Most provinces utilize the Provincial Tax Context flexfield context, but Northwest Territories and Nunavut utilize a different flexfield
context: Payroll Tax Context.

The following sections describe how to supply valid file lines for these record types.

Card Component
The Payroll Tax card component uses these attributes:

Card Component Attributes for Payroll Tax

HCM DATA LOADER


ATTRIBUTE ALTERNATIVE USER KEY ATTRIBUTES FUNCTIONAL DESCRIPTION

SourceSystemId CardSequence, ComponentSequence, The value that uniquely identifies the Payroll Tax card
AssignmentNumber, component. For new card components supply the source key
DirCardDefinitionName,

31 W HITE PAPER / Loading Tax Withholding Information for Canada


Using HCM Data Loader
HCM DATA LOADER
ATTRIBUTE ALTERNATIVE USER KEY ATTRIBUTES FUNCTIONAL DESCRIPTION

LegislativeDataGroupName, attributes. You can also identify card component records using
DirCardCompDefName the user key attributes.

Source System Owner The name of the source system used to generate the source
system ID.

LegislativeDataGroupName The name of the legislative data group for the card component
definition.

DirCardId(SourceSystemId) CardSequence, AssignmentNumber, The parent Tax Credit Information calculation card. Use the
DirCardDefinitionName, same key type used to identify the calculation card.
LegislativeDataGroupName When using source keys supply this attribute with the value
supplied for the calculation card’s SourceSystemId attribute.
Otherwise supply the user key attributes with the same values
as the parent calculation card.

EffectiveStartDate The start date of the card component. This must be after or
equal to the EffectiveStartDate on the Tax Credit Information
calculation card.

EffectiveEndDate An optional end date for the card component.

DirCardCompDefName The name of the card component definition. Specify ‘Payroll


Tax’.

ComponentSequence A number to uniquely identify this card component when


multiple card components for the same card component
definition exist on the same card. Not required when source
keys are used.

Context1 The code of the province. These are supplied in Appendix A -


Province Codes

Component Detail
In addition to the attributes defined here, include the necessary flexfield segment Finding Flexfield Segment Attributes

attribute values for the flexfield context: You can find the flexfield segment attributes for the
flexfield context using the View Business Object task.
– Payroll Tax Context (HRX_CA_WTH_PROVINCE_PAYROLL_TAX) for
Northwest Territories and Nunavut

Component Detail Attributes for Payroll Tax

HCM DATA LOADER


ATTRIBUTE ALTERNATIVE USER KEY ATTRIBUTES FUNCTIONAL DESCRIPTION

SourceSystemId CardSequence, ComponentSequence, The value that uniquely identifies the Payroll Tax component
DirInformationCategory, detail. For new component detail records supply the source key
LegislativeDataGroupName, attributes. You can also identify component detail records using
AssignmentNumber, the user key attributes.
DirCardDefinitionName,
DirCardCompDefName

32 W HITE PAPER / Loading Tax Withholding Information for Canada


Using HCM Data Loader
HCM DATA LOADER
ATTRIBUTE ALTERNATIVE USER KEY ATTRIBUTES FUNCTIONAL DESCRIPTION

Source System Owner The name of the source system used to generate the source
system ID.

LegislativeDataGroupName The name of the legislative data group. Required to identify the
component flexfield.

DirCardCompId CardSequence, ComponentSequence, The parent Payroll Tax card component. Use the same key
(SourceSystemId) AssignmentNumber, type used to identify the card component.
DirCardDefinitionName, When using source keys supply this attribute with the value
LegislativeDataGroupName, supplied for the card component’s SourceSystemId attribute.
DirCardCompDefName Otherwise supply the user key attributes with the same values
as the parent card component.

EffectiveStartDate The start date of the component detail, or update to the


component detail if you are providing date-effective history. This
must be after or equal to the EffectiveStartDate provided for the
Provincial Tax card component.

EffectiveEndDate The optional end date of the component detail, or if you are
providing date-effective history the last day of the date-effective
changes.

DirCompFlexId DirInformationCategory, The component flexfield ID. Provide the user key attributes
LegislativeDataGroupName, listed to identify the component flexfield.
DirCardCompDefName

DirInformationCategory The code for the flexfield context data is provided for. Specify
‘HRX_CA_WTH_PROVINCE_PAYROLL_TAX’.

FLEX:Deduction Developer The flexfield context code. Supply the same value as for the
DF DirInformationCategory attribute.

Calculation Value Definition


The Payroll Tax card component utilizes value definitions to supply override values.

This table describes the value definitions that are applicable to each province. Note: All value definitions are applicable to Quebec.

Value Definitions for Payroll Tax

VALUE DEFINITION NAME FUNCTIONAL DESCRIPTION

Other Tax Credits An additional tax credit used to reduce the income tax amount, as authorized by the government.

Total Claim Amount This value represents the provincial tax exemption amount.
Note: This value defaults to the basic amount populated from the Load Payroll Tax Information process. For
employees with the basic amount, do not populate the Total Claim Amount, as the value will be read as an
override and will not be updated by the Load Payroll Tax Information process when the basic amounts
change.
If the employee has a total claim amount greater than the basic amount, the higher amount should be
entered here. This override is not reset to the basic amount or updated at the beginning of the year. It will
remain the same until modified by the user, or reset using the Tax Overrides Report.

33 W HITE PAPER / Loading Tax Withholding Information for Canada


Using HCM Data Loader
Example File Lines
These file lines create the Payroll Tax card component for an auto-generated Tax Credit Information calculation card.

METADATA|CalculationCard|SourceSystemOwner|SourceSystemId|LegislativeDataGroupName|DirCardDefinitionName|A
ssignmentNumber|CardSequence|EffectiveStartDate
MERGE|CalculationCard|||CA LDG|Tax Credit Information|E816423|1|2019/05/02

METADATA|CardComponent|SourceSystemOwner|SourceSystemId|LegislativeDataGroupName|DirCardDefinitionName|Ass
ignmentNumber|CardSequence|EffectiveStartDate|DirCardCompDefName|ComponentSequence|Context1
MERGE|CardComponent|VISION|TCI_816423_PY_11|CA LDG|Tax Credit Information|E816423|1|2019/05/02|Payroll
Tax|11|11

METADATA|ComponentDetail|SourceSystemOwner|SourceSystemId|LegislativeDataGroupName|DirCardCompId(SourceSys
temId)|EffectiveStartDate|DirCardCompDefName|DirInformationCategory|FLEX:Deduction Developer
DF|payrollTaxExempt(Deduction Developer DF=HRX_CA_WTH_PROVINCE_PAYROLL_TAX)
MERGE|ComponentDetail|VISION|TCI_816423_PY_11_PAY|ZHRX_CAVS_ST_LDGMAIN|TCI_816423_PY_11|2019/05/02|Payroll
Tax|HRX_CA_WTH_PROVINCE_PAYROLL_TAX|HRX_CA_WTH_PROVINCE_PAYROLL_TAX|Y
User keys are used to identify the auto-generated Tax Credit Information calculation card and the source key was auto-generated. Source keys uniquely
identify each new record. Supplying source keys simplifies the file shape and makes it easier to maintain the data.

CARD COMPONENT: QUEBEC TAXES


The Quebec Taxes card component is used to capture information that will impact Quebec Pension Plan and Quebec Parental
insurance Plan calculations for the employee.

Each Tax Credit Information calculation card should have one Quebec Taxes card component, if the employee works in Quebec.

Card Component Hierarchy

The Quebec Taxes card component utilizes two flexfield contexts and data for these are loaded using the Component Detail record
type. The following sections describe how to supply valid file lines for these record types.

Card Component
The Quebec Taxes card component uses these attributes:

Card Component Attributes for Quebec Taxes

HCM DATA LOADER


ATTRIBUTE ALTERNATIVE USER KEY ATTRIBUTES FUNCTIONAL DESCRIPTION

SourceSystemId CardSequence, ComponentSequence, The value that uniquely identifies the Quebec Taxes card
AssignmentNumber, component. For new card components supply the source key
DirCardDefinitionName, attributes. You can also identify card component records using
LegislativeDataGroupName, the user key attributes.
DirCardCompDefName

Source System Owner The name of the source system used to generate the source
system ID.

34 W HITE PAPER / Loading Tax Withholding Information for Canada


Using HCM Data Loader
HCM DATA LOADER
ATTRIBUTE ALTERNATIVE USER KEY ATTRIBUTES FUNCTIONAL DESCRIPTION

LegislativeDataGroupName The name of the legislative data group for the card component
definition.

DirCardId(SourceSystemId) CardSequence, AssignmentNumber, The parent Tax Credit Information calculation card. Use the
DirCardDefinitionName, same key type used to identify the calculation card.
LegislativeDataGroupName When using source keys supply this attribute with the value
supplied for the calculation card’s SourceSystemId attribute.
Otherwise supply the user key attributes with the same values
as the parent calculation card.

EffectiveStartDate The start date of the card component. This must be after or
equal to the EffectiveStartDate on the Tax Credit Information
calculation card.

EffectiveEndDate An optional end date for the card component.

DirCardCompDefName The name of the card component definition. Specify ‘Quebec


Taxes’.

ComponentSequence A number to uniquely identify this card component when


multiple card components for the same card component
definition exist on the same card. Not required when source
keys are used.

Context1 The province code for Quebec. Specify ‘19’.

Component Detail Finding Flexfield Segment Attributes


In addition to the attributes defined here, include the necessary flexfield segment You can find the flexfield segment attributes for the
attribute values for the flexfield contexts: flexfield context using the View Business Object task.

– Quebec Parental Insurance Plan Context


(HRX_CA_WTH_PROVINCE_PARENTAL_INSURANCE)

– Quebec Pension Plan Context (HRX_CA_WTH_PROVINCE_PENSION_PLAN)

Component Detail Attributes for Quebec Taxes

HCM DATA LOADER


ATTRIBUTE ALTERNATIVE USER KEY ATTRIBUTES FUNCTIONAL DESCRIPTION

SourceSystemId CardSequence, ComponentSequence, The value that uniquely identifies the Quebec Taxes
DirInformationCategory, component detail. For new component detail records supply the
LegislativeDataGroupName, source key attributes. You can also identify component detail
AssignmentNumber, records using the user key attributes.
DirCardDefinitionName,
DirCardCompDefName

Source System Owner The name of the source system used to generate the source
system ID.

LegislativeDataGroupName The name of the legislative data group. Required to identify the
component flexfield.

35 W HITE PAPER / Loading Tax Withholding Information for Canada


Using HCM Data Loader
HCM DATA LOADER
ATTRIBUTE ALTERNATIVE USER KEY ATTRIBUTES FUNCTIONAL DESCRIPTION

DirCardCompId CardSequence, ComponentSequence, The parent Quebec Taxes card component. Use the same key
(SourceSystemId) AssignmentNumber, type used to identify the card component.
DirCardDefinitionName, When using source keys supply this attribute with the value
LegislativeDataGroupName, supplied for the card component’s SourceSystemId attribute.
DirCardCompDefName Otherwise supply the user key attributes with the same values
as the parent card component.

EffectiveStartDate The start date of the component detail, or update to the


component detail if you are providing date-effective history. This
must be after or equal to the EffectiveStartDate provided for the
Quebec Taxes card component.

EffectiveEndDate The optional end date of the component detail, or if you are
providing date-effective history the last day of the date-effective
changes.

DirCompFlexId DirInformationCategory, The component flexfield ID. Provide the user key attributes
LegislativeDataGroupName, listed to identify the component flexfield.
DirCardCompDefName

DirInformationCategory The code for the flexfield context data is provided for, such as
HRX_CA_WTH_PROVINCE_PARENTAL_INSURANCE’.

FLEX:Deduction Developer The flexfield context code. Supply the same value as for the
DF DirInformationCategory attribute.

Example File Lines


These file lines create the Quebec Taxes card component of an auto-generated Tax Credit Information calculation card.

Note: You can maintain Quebec Taxes individually but when creating them they are supplied with the Provincial Tax card component
for Quebec, an example of which is provided in the Example Files section.

Example File 5: Creating Quebec Taxes

METADATA|CalculationCard|SourceSystemOwner|SourceSystemId|LegislativeDataGroupName|DirCardDefinitionName|A
ssignmentNumber|CardSequence|EffectiveStartDate
MERGE|CalculationCard|||CA LDG|Tax Credit Information|E816423|1|2019/05/02

METADATA|CardComponent|SourceSystemOwner|SourceSystemId|LegislativeDataGroupName|DirCardDefinitionName|Ass
ignmentNumber|CardSequence|EffectiveStartDate|DirCardCompDefName|ComponentSequence|Context1
MERGE|CardComponent|VISION|TCI_816423_QB|CA LDG|Tax Credit Information|E816423|1|2019/05/02|Quebec
Taxes|19|19

METADATA|ComponentDetail|SourceSystemOwner|SourceSystemId|LegislativeDataGroupName|DirCardCompId(SourceSys
temId)|EffectiveStartDate|DirCardCompDefName|DirInformationCategory|FLEX:Deduction Developer
DF|ppipExempt(Deduction Developer DF=HRX_CA_WTH_PROVINCE_PARENTAL_INSURANCE)|pppExempt(Deduction Developer
DF=HRX_CA_WTH_PROVINCE_PENSION_PLAN)
MERGE|ComponentDetail|VISION|TCI_816423_QB_PAR|ZHRX_CAVS_ST_LDGMAIN|TCI_816423_QB|2019/05/02|Quebec
Taxes|HRX_CA_WTH_PROVINCE_PARENTAL_INSURANCE|HRX_CA_WTH_PROVINCE_PARENTAL_INSURANCE|Y|
MERGE|ComponentDetail|VISION|TCI_816423_QB_PEN|ZHRX_CAVS_ST_LDGMAIN|TCI_816423_QB|2019/05/02|Quebec
Taxes|HRX_CA_WTH_PROVINCE_PENSION_PLAN|HRX_CA_WTH_PROVINCE_PENSION_PLAN||Y
User keys are used to identify the auto-generated Tax Credit Information calculation card and the source key was auto-generated. Source keys uniquely
identify each new record. Supplying source keys simplifies the file shape and makes it easier to maintain the data.

36 W HITE PAPER / Loading Tax Withholding Information for Canada


Using HCM Data Loader
CARD ASSOCIATION: TAX CREDIT INFORMATION
The card association record associates the Tax Credit Information calculation card with a tax reporting unit.

Card Association Hierarchy

The associated tax reporting unit is defined in the card association. The card association details record allows the Canadian Taxation
card component to be associated with the employee assignment.

The following sections describe how to supply valid file lines for these record types.

Card Association

Card Association Attributes for the Tax Credit Information

HCM DATA LOADER


ATTRIBUTE ALTERNATIVE USER KEY ATTRIBUTES FUNCTIONAL DESCRIPTION

SourceSystemId CardSequence, TaxReportingUnitName, The value that uniquely identifies Tax Credit Information card
LegislativeDataGroupName, association. For new card associations supply the source key
AssignmentNumber, attributes. You can also identify component association records
DirCardDefinitionName using the user key attributes.

Source System Owner The name of the source system owner used to generate the
source system ID.

DirCardId(SourceSystemId) CardSequence, AssignmentNumber, The parent Tax Credit Information calculation card. Use the
DirCardDefinitionName, same key type used to identify the calculation card.
LegislativeDataGroupName When using source keys supply this attribute with the value
supplied for the calculation card’s SourceSystemId attribute.
Otherwise supply the user key attributes with the same values
as the parent calculation card.

EffectiveStartDate The start date of the card association or the update to the card
association if you are providing date-effective history. This must
be after or equal to the EffectiveStartDate provided for the Tax
Credit Information calculation card.

TaxReportingUnitName The name of the tax reporting unit to associate with the Tax
Credit Information calculation card.
If source keys are used to identify the card association, you
must also specify the LegislativeDataGroupName attribute to
identify the tax reporting unit.

Card Association Details


The card association details record associates the Canadian Taxation card component with the payroll assignments for the employee.
If the employee has more than one payroll assignment provide a card association detail record for each payroll assignment.

37 W HITE PAPER / Loading Tax Withholding Information for Canada


Using HCM Data Loader
Card Association Detail Attributes for Tax Credit Information

HCM DATA LOADER


ATTRIBUTE ALTERNATIVE USER KEY ATTRIBUTES FUNCTIONAL DESCRIPTION

SourceSystemId DirCardDefinitionName, The value that uniquely identifies card association detail. For
AssignmentNumber, new records supply the source key attributes. If updating an
LegislativeDataGroupName, existing card association detail you can identify the record using
CardSequence, TaxReportingUnitName the user key attributes.

Source System Owner The name of the source system owner used to generate the
source system ID.

DirRepCardId(SourceSyste CardSequence, TaxReportingUnitName, The parent card association record. For new records supply the
mId) LegislativeDataGroupName, source system ID you provided on the card association record.
AssignmentNumber, You can identify existing card association records using the
DirCardDefinitionName user keys. Supply user key attributes with the same values
supplied on the parent card association record.

EffectiveStartDate The start date of the component association.

EffectiveEndDate The end date of the component association.

DirCardCompId(SourceSys CardSequence, ComponentSequence, The card component the association is for. Supply either the
temId) AssignmentNumber, source system ID value or user key attributes to identify the
DirCardDefinitionName, Canadian Taxation card component.
LegislativeDataGroupName,
DirCardCompDefName

AssociationAssignmentId AssociationAssignmentNumber The employee’s assignment to associate the card to.


(SourceSystemId)

Example File
These file lines create the Card Association record for an auto-generatedTax Credit Information calculation card. User keys are used
to identify the Tax Credit Information calculation card and the Canadian Taxation card component referenced in the card association
detail record.

Example File 6: Creating the Card Association

METADATA|CardAssociation|EffectiveStartDate|LegislativeDataGroupName|TaxReportingUnitName|DirCardDefinitio
nName|AssignmentNumber|CardSequence
MERGE|CardAssociation|2019/05/02|CA LDG|CA Tax Reporting Unit|Tax Credit Information|E816423|1

METADATA|CardAssociationDetail|EffectiveStartDate|LegislativeDataGroupName|TaxReportingUnitName|DirCardDef
initionName|AssignmentNumber|CardSequence|DirCardCompDefName|ComponentSequence|AssociationAssignmentNumber
MERGE|CardAssociationDetail|2019/05/02|CA LDG|CA Tax Reporting Unit|Tax Credit
Information|E816423|1|Canadian Taxation|300100044131319| E816423

38 W HITE PAPER / Loading Tax Withholding Information for Canada


Using HCM Data Loader
EXAMPLE FILES
There are three Tax Credit Information card shapes used by the Canadian provinces. An example is supplied for each.

Creating Tax Credit Information for Northwest Territories and Nunavut


This example creates a complete Tax Credit Information calculation card for an employee in Northwest Territories. This shape is also
used by Nunavut.

Use the CalculationCard.dat file to upload Tax Credit Information calculation cards with HCM Data Loader.

Example File 7: Creating Tax Credit Information for Northwest Territories and Nunavut

METADATA|CalculationCard|SourceSystemOwner|SourceSystemId|LegislativeDataGroupName|DirCardDefinitionName|Effe
ctiveStartDate|AssignmentNumber|CardSequence
MERGE|CalculationCard|VISION|TCI_816423|ZHRX_CAVS_ST_LDGMAIN|Tax Credit Information|2019/05/02|E311BULK0604|1

METADATA|CardComponent|SourceSystemOwner|SourceSystemId|LegislativeDataGroupName|DirCardId(SourceSystemId)|Ef
fectiveStartDate|DirCardCompDefName|ComponentSequence|Context1
MERGE|CardComponent|VISION|TCI_816423_CT|ZHRX_CAVS_ST_LDGMAIN|TCI_816423|2019/05/02|Canadian
Taxation|300100044131319|300100044131319
MERGE|CardComponent|VISION|TCI_816423_FT|ZHRX_CAVS_ST_LDGMAIN|TCI_816423|2019/05/02|Federal Tax|1|
MERGE|CardComponent|VISION|TCI_816423_EI|ZHRX_CAVS_ST_LDGMAIN|TCI_816423|2019/05/02|Employment Insurance|1|
MERGE|CardComponent|VISION|TCI_816423_PP|ZHRX_CAVS_ST_LDGMAIN|TCI_816423|2019/05/02|Canada Pension Plan|1|

COMMENT Additional card components for Northwest Territories


MERGE|CardComponent|VISION|TCI_816423_PT_11|ZHRX_CAVS_ST_LDGMAIN|TCI_816423|2019/05/02|Provincial Tax|11|11
MERGE|CardComponent|VISION|TCI_816423_PY_11|ZHRX_CAVS_ST_LDGMAIN|TCI_816423|2019/05/02|Payroll Tax|11|11

METADATA|ComponentDetail|SourceSystemOwner|SourceSystemId|LegislativeDataGroupName|DirCardCompId(SourceSystem
Id)|EffectiveStartDate|DirCardCompDefName|DirInformationCategory|FLEX:Deduction Developer
DF|federalTaxExempt(Deduction Developer DF=HRX_CA_WTH_FEDERAL_INCOME_TAX)|cppRevocationDate(Deduction
Developer DF=HRX_CA_WTH_FEDERAL_PENSION_PLAN)|cppExempt(Deduction Developer
DF=HRX_CA_WTH_FEDERAL_PENSION_PLAN)|cppElectionDate(Deduction Developer
DF=HRX_CA_WTH_FEDERAL_PENSION_PLAN)|eiExempt(Deduction Developer
DF=HRX_CA_WTH_FEDERAL_EMPLOYMENT_INSURANCE)|provinceTaxExempt(Deduction Developer
DF=HRX_CA_WTH_PROVINCE_INCOME_TAX)|numberOfDependentsUnderAge(Deduction Developer
DF=HRX_CA_WTH_PROVINCE_INCOME_TAX)|numberOfDisabledDependents(Deduction Developer
DF=HRX_CA_WTH_PROVINCE_INCOME_TAX)|payrollTaxExempt(Deduction Developer
DF=HRX_CA_WTH_PROVINCE_PAYROLL_TAX)|provinceOfEmployement(Deduction Developer
DF=HRX_CA_WTH_TAXATION)|oraHrxCaVlPlan(Deduction Developer
DF=HRX_CA_WTH_TAXATION)|oraHrxCaVacServDate(Deduction Developer DF=HRX_CA_WTH_TAXATION)
MERGE|ComponentDetail|VISION|TCI_816423_CT_TX|ZHRX_CAVS_ST_LDGMAIN|TCI_816423_CT|2019/05/02|Canadian
Taxation|HRX_CA_WTH_TAXATION|HRX_CA_WTH_TAXATION||||||||||19||
MERGE|ComponentDetail|VISION|TCI_816423_FT_IT|ZHRX_CAVS_ST_LDGMAIN|TCI_816423_FT|2019/05/02|Federal
Tax|HRX_CA_WTH_FEDERAL_INCOME_TAX|HRX_CA_WTH_FEDERAL_INCOME_TAX|Y|||||||||||
MERGE|ComponentDetail|VISION|TCI_816423_EI_EI|ZHRX_CAVS_ST_LDGMAIN|TCI_816423_EI|2019/05/02|Employment
Insurance|HRX_CA_WTH_FEDERAL_EMPLOYMENT_INSURANCE|HRX_CA_WTH_FEDERAL_EMPLOYMENT_INSURANCE|||||Y|||||||
MERGE|ComponentDetail|VISION|TCI_816423_PP_PP|ZHRX_CAVS_ST_LDGMAIN|TCI_816423_PP|2019/05/02|Canada Pension
Plan|HRX_CA_WTH_FEDERAL_PENSION_PLAN|HRX_CA_WTH_FEDERAL_PENSION_PLAN|||Y|||||||||

COMMENT Additional components details for Northwest Territories


MERGE|ComponentDetail|VISION|TCI_816423_PT_11_PIT|ZHRX_CAVS_ST_LDGMAIN|TCI_816423_PT_11|2019/05/02|Provincial
Tax|HRX_CA_WTH_PROVINCE_INCOME_TAX|HRX_CA_WTH_PROVINCE_INCOME_TAX||||||Y||||||
MERGE|ComponentDetail|VISION|TCI_816423_PY_11_PAY|ZHRX_CAVS_ST_LDGMAIN|TCI_816423_PY_11|2019/05/02|Payroll
Tax|HRX_CA_WTH_PROVINCE_PAYROLL_TAX|HRX_CA_WTH_PROVINCE_PAYROLL_TAX|||||||||Y|||

METADATA|CalculationValueDefinition|SourceSystemOwner|SourceSystemId|LegislativeDataGroupName|SourceId(Source
SystemId)|EffectiveStartDate|ValueDefinitionName|DirCardCompDefName|Context1
COMMENT value definitions for Federal Tax
MERGE|CalculationValueDefinition|VISION|TCI_816423_FT_VD1|ZHRX_CAVS_ST_LDGMAIN|TCI_816423_FT|2019/05/02|Addit
ional Tax|Federal Tax|
MERGE|CalculationValueDefinition|VISION|TCI_816423_FT_VD2|ZHRX_CAVS_ST_LDGMAIN|TCI_816423_FT|2019/05/02|Annua
l Deduction|Federal Tax|
MERGE|CalculationValueDefinition|VISION|TCI_816423_FT_VD3|ZHRX_CAVS_ST_LDGMAIN|TCI_816423_FT|2019/05/02|Commi
ssion Expenses|Federal Tax|

39 W HITE PAPER / Loading Tax Withholding Information for Canada


Using HCM Data Loader
MERGE|CalculationValueDefinition|VISION|TCI_816423_FT_VD4|ZHRX_CAVS_ST_LDGMAIN|TCI_816423_FT|2019/05/02|Commi
ssion Remuneration|Federal Tax|
MERGE|CalculationValueDefinition|VISION|TCI_816423_FT_VD5|ZHRX_CAVS_ST_LDGMAIN|TCI_816423_FT|2019/05/02|Feder
al Tax Amount|Federal Tax|
MERGE|CalculationValueDefinition|VISION|TCI_816423_FT_VD6|ZHRX_CAVS_ST_LDGMAIN|TCI_816423_FT|2019/05/02|Feder
al Tax Rate|Federal Tax|
MERGE|CalculationValueDefinition|VISION|TCI_816423_FT_VD7|ZHRX_CAVS_ST_LDGMAIN|TCI_816423_FT|2019/05/02|Labou
r Fund Contributions|Federal Tax|
MERGE|CalculationValueDefinition|VISION|TCI_816423_FT_VD8|ZHRX_CAVS_ST_LDGMAIN|TCI_816423_FT|2019/05/02|Presc
ribed Zone Deduction|Federal Tax|
MERGE|CalculationValueDefinition|VISION|TCI_816423_FT_VD9|ZHRX_CAVS_ST_LDGMAIN|TCI_816423_FT|2019/05/02|Total
Claim Amount|Federal Tax|
MERGE|CalculationValueDefinition|VISION|TCI_816423_FT_VD10|ZHRX_CAVS_ST_LDGMAIN|TCI_816423_FT|2019/05/02|Othe
r Tax Credits|Federal Tax|

COMMENT Value definitions for Northwest Territories Provincial Tax


MERGE|CalculationValueDefinition|VISION|TCI_816423_PT_11_VD1|ZHRX_CAVS_ST_LDGMAIN|TCI_816423_PT_11|2019/05/02
|Total Claim Amount|Provincial Tax|11
MERGE|CalculationValueDefinition|VISION|TCI_816423_PT_11_VD2|ZHRX_CAVS_ST_LDGMAIN|TCI_816423_PT_11|2019/05/02
|Other Tax Credits|Provincial Tax|11

METADATA|EnterableCalculationValue|SourceSystemOwner|SourceSystemId|LegislativeDataGroupName|ValueDefnId(Sour
ceSystemId)|EffectiveStartDate|ValueDefinitionName|DirCardCompDefName|Value1|Context1
COMMENT Override values for Federal Tax
MERGE|EnterableCalculationValue|VISION|TCI_816423_FT_VD1|ZHRX_CAVS_ST_LDGMAIN|TCI_816423_FT_VD1|2019/05/02|Ad
ditional Tax|Federal Tax|100|
MERGE|EnterableCalculationValue|VISION|TCI_816423_FT_VD2|ZHRX_CAVS_ST_LDGMAIN|TCI_816423_FT_VD2|2019/05/02|An
nual Deduction|Federal Tax|100|
MERGE|EnterableCalculationValue|VISION|TCI_816423_FT_VD3|ZHRX_CAVS_ST_LDGMAIN|TCI_816423_FT_VD3|2019/05/02|Co
mmission Expenses|Federal Tax|100|
MERGE|EnterableCalculationValue|VISION|TCI_816423_FT_VD4|ZHRX_CAVS_ST_LDGMAIN|TCI_816423_FT_VD4|2019/05/02|Co
mmission Remuneration|Federal Tax|100|
MERGE|EnterableCalculationValue|VISION|TCI_816423_FT_VD5|ZHRX_CAVS_ST_LDGMAIN|TCI_816423_FT_VD5|2019/05/02|Fe
deral Tax Amount|Federal Tax|100|
MERGE|EnterableCalculationValue|VISION|TCI_816423_FT_VD6|ZHRX_CAVS_ST_LDGMAIN|TCI_816423_FT_VD6|2019/05/02|Fe
deral Tax Rate|Federal Tax|100|
MERGE|EnterableCalculationValue|VISION|TCI_816423_FT_VD7|ZHRX_CAVS_ST_LDGMAIN|TCI_816423_FT_VD7|2019/05/02|La
bour Fund Contributions|Federal Tax|100|
MERGE|EnterableCalculationValue|VISION|TCI_816423_FT_VD8|ZHRX_CAVS_ST_LDGMAIN|TCI_816423_FT_VD8|2019/05/02|Pr
escribed Zone Deduction|Federal Tax|100|
MERGE|EnterableCalculationValue|VISION|TCI_816423_FT_VD9|ZHRX_CAVS_ST_LDGMAIN|TCI_816423_FT_VD9|2019/05/02|To
tal Claim Amount|Federal Tax|100|
MERGE|EnterableCalculationValue|VISION|TCI_816423_FT_VD10|ZHRX_CAVS_ST_LDGMAIN|TCI_816423_FT_VD10|2019/05/02|
Other Tax Credits|Federal Tax|100|

COMMENT Override values for Northwest Territories Provincial Tax


MERGE|EnterableCalculationValue|VISION|TCI_816423_PT_11_VD1|ZHRX_CAVS_ST_LDGMAIN|TCI_816423_PT_11_VD1|2019/05
/02|Total Claim Amount|Provincial Tax|100|11
MERGE|EnterableCalculationValue|VISION|TCI_816423_PT_11_VD2|ZHRX_CAVS_ST_LDGMAIN|TCI_816423_PT_11_VD2|2019/05
/02|Other Tax Credits|Provincial Tax|100|11

Creating Tax Credit Information for Quebec


This example creates a complete Tax Credit Information calculation card for an employee in Quebec.

Use the CalculationCard.dat file to upload Tax Credit Information calculation cards with HCM Data Loader.

Example File 8: Creating Tax Credit Infomration for Quebec

METADATA|CalculationCard|SourceSystemOwner|SourceSystemId|LegislativeDataGroupName|DirCardDefinitionName|Effe
ctiveStartDate|AssignmentNumber|CardSequence
MERGE|CalculationCard|VISION|TCI_816423|ZHRX_CAVS_ST_LDGMAIN|Tax Credit Information|2019/05/02|E311BULK0604|1

METADATA|CardComponent|SourceSystemOwner|SourceSystemId|LegislativeDataGroupName|DirCardId(SourceSystemId)|Ef
fectiveStartDate|DirCardCompDefName|ComponentSequence|Context1

40 W HITE PAPER / Loading Tax Withholding Information for Canada


Using HCM Data Loader
MERGE|CardComponent|VISION|TCI_816423_CT|ZHRX_CAVS_ST_LDGMAIN|TCI_816423|2019/05/02|Canadian
Taxation|300100044131319|300100044131319
MERGE|CardComponent|VISION|TCI_816423_FT|ZHRX_CAVS_ST_LDGMAIN|TCI_816423|2019/05/02|Federal Tax|1|
MERGE|CardComponent|VISION|TCI_816423_EI|ZHRX_CAVS_ST_LDGMAIN|TCI_816423|2019/05/02|Employment Insurance|1|
MERGE|CardComponent|VISION|TCI_816423_PP|ZHRX_CAVS_ST_LDGMAIN|TCI_816423|2019/05/02|Canada Pension Plan|1|
MERGE|CardComponent|VISION|TCI_816423_PT_19|ZHRX_CAVS_ST_LDGMAIN|TCI_816423|2019/05/02|Provincial Tax|19|19
MERGE|CardComponent|VISION|TCI_816423_QB|ZHRX_CAVS_ST_LDGMAIN|TCI_816423|2019/05/02|Quebec Taxes|19|19

METADATA|ComponentDetail|SourceSystemOwner|SourceSystemId|LegislativeDataGroupName|DirCardCompId(SourceSystem
Id)|EffectiveStartDate|DirCardCompDefName|DirInformationCategory|FLEX:Deduction Developer
DF|federalTaxExempt(Deduction Developer DF=HRX_CA_WTH_FEDERAL_INCOME_TAX)|cppRevocationDate(Deduction
Developer DF=HRX_CA_WTH_FEDERAL_PENSION_PLAN)|cppExempt(Deduction Developer
DF=HRX_CA_WTH_FEDERAL_PENSION_PLAN)|cppElectionDate(Deduction Developer
DF=HRX_CA_WTH_FEDERAL_PENSION_PLAN)|eiExempt(Deduction Developer
DF=HRX_CA_WTH_FEDERAL_EMPLOYMENT_INSURANCE)|provinceTaxExempt(Deduction Developer
DF=HRX_CA_WTH_PROVINCE_INCOME_TAX)|numberOfDependentsUnderAge(Deduction Developer
DF=HRX_CA_WTH_PROVINCE_INCOME_TAX)|numberOfDisabledDependents(Deduction Developer
DF=HRX_CA_WTH_PROVINCE_INCOME_TAX)|payrollTaxExempt(Deduction Developer
DF=HRX_CA_WTH_PROVINCE_PAYROLL_TAX)|ppipExempt(Deduction Developer
DF=HRX_CA_WTH_PROVINCE_PARENTAL_INSURANCE)|pppExempt(Deduction Developer
DF=HRX_CA_WTH_PROVINCE_PENSION_PLAN)|provinceOfEmployement(Deduction Developer
DF=HRX_CA_WTH_TAXATION)|oraHrxCaVlPlan(Deduction Developer
DF=HRX_CA_WTH_TAXATION)|oraHrxCaVacServDate(Deduction Developer DF=HRX_CA_WTH_TAXATION)
MERGE|ComponentDetail|VISION|TCI_816423_CT_TX|ZHRX_CAVS_ST_LDGMAIN|TCI_816423_CT|2019/05/02|Canadian
Taxation|HRX_CA_WTH_TAXATION|HRX_CA_WTH_TAXATION||||||||||||19||
MERGE|ComponentDetail|VISION|TCI_816423_FT_IT|ZHRX_CAVS_ST_LDGMAIN|TCI_816423_FT|2019/05/02|Federal
Tax|HRX_CA_WTH_FEDERAL_INCOME_TAX|HRX_CA_WTH_FEDERAL_INCOME_TAX|Y|||||||||||||
MERGE|ComponentDetail|VISION|TCI_816423_EI_EI|ZHRX_CAVS_ST_LDGMAIN|TCI_816423_EI|2019/05/02|Employment
Insurance|HRX_CA_WTH_FEDERAL_EMPLOYMENT_INSURANCE|HRX_CA_WTH_FEDERAL_EMPLOYMENT_INSURANCE|||||Y|||||||||
MERGE|ComponentDetail|VISION|TCI_816423_PP_PP|ZHRX_CAVS_ST_LDGMAIN|TCI_816423_PP|2019/05/02|Canada Pension
Plan|HRX_CA_WTH_FEDERAL_PENSION_PLAN|HRX_CA_WTH_FEDERAL_PENSION_PLAN|||Y|||||||||||
MERGE|ComponentDetail|VISION|TCI_816423_PT_19_PIT|ZHRX_CAVS_ST_LDGMAIN|TCI_816423_PT_19|2019/05/02|Provincial
Tax|HRX_CA_WTH_PROVINCE_INCOME_TAX|HRX_CA_WTH_PROVINCE_INCOME_TAX||||||Y||||||||

COMMENT Additional components details for Quebec


MERGE|ComponentDetail|VISION|TCI_816423_QB_PAR|ZHRX_CAVS_ST_LDGMAIN|TCI_816423_QB|2019/05/02|Quebec
Taxes|HRX_CA_WTH_PROVINCE_PARENTAL_INSURANCE|HRX_CA_WTH_PROVINCE_PARENTAL_INSURANCE||||||||||Y||||
MERGE|ComponentDetail|VISION|TCI_816423_QB_PEN|ZHRX_CAVS_ST_LDGMAIN|TCI_816423_QB|2019/05/02|Quebec
Taxes|HRX_CA_WTH_PROVINCE_PENSION_PLAN|HRX_CA_WTH_PROVINCE_PENSION_PLAN|||||||||||Y|||

METADATA|CalculationValueDefinition|SourceSystemOwner|SourceSystemId|LegislativeDataGroupName|SourceId(Source
SystemId)|EffectiveStartDate|ValueDefinitionName|DirCardCompDefName|Context1
COMMENT value definitions for Federal Tax
MERGE|CalculationValueDefinition|VISION|TCI_816423_FT_VD1|ZHRX_CAVS_ST_LDGMAIN|TCI_816423_FT|2019/05/02|Addit
ional Tax|Federal Tax|
MERGE|CalculationValueDefinition|VISION|TCI_816423_FT_VD2|ZHRX_CAVS_ST_LDGMAIN|TCI_816423_FT|2019/05/02|Annua
l Deduction|Federal Tax|
MERGE|CalculationValueDefinition|VISION|TCI_816423_FT_VD3|ZHRX_CAVS_ST_LDGMAIN|TCI_816423_FT|2019/05/02|Commi
ssion Expenses|Federal Tax|
MERGE|CalculationValueDefinition|VISION|TCI_816423_FT_VD4|ZHRX_CAVS_ST_LDGMAIN|TCI_816423_FT|2019/05/02|Commi
ssion Remuneration|Federal Tax|
MERGE|CalculationValueDefinition|VISION|TCI_816423_FT_VD5|ZHRX_CAVS_ST_LDGMAIN|TCI_816423_FT|2019/05/02|Feder
al Tax Amount|Federal Tax|
MERGE|CalculationValueDefinition|VISION|TCI_816423_FT_VD6|ZHRX_CAVS_ST_LDGMAIN|TCI_816423_FT|2019/05/02|Feder
al Tax Rate|Federal Tax|
MERGE|CalculationValueDefinition|VISION|TCI_816423_FT_VD7|ZHRX_CAVS_ST_LDGMAIN|TCI_816423_FT|2019/05/02|Labou
r Fund Contributions|Federal Tax|
MERGE|CalculationValueDefinition|VISION|TCI_816423_FT_VD8|ZHRX_CAVS_ST_LDGMAIN|TCI_816423_FT|2019/05/02|Presc
ribed Zone Deduction|Federal Tax|
MERGE|CalculationValueDefinition|VISION|TCI_816423_FT_VD9|ZHRX_CAVS_ST_LDGMAIN|TCI_816423_FT|2019/05/02|Total
Claim Amount|Federal Tax|
MERGE|CalculationValueDefinition|VISION|TCI_816423_FT_VD10|ZHRX_CAVS_ST_LDGMAIN|TCI_816423_FT|2019/05/02|Othe
r Tax Credits|Federal Tax|

COMMENT Value definitions for Quebec Provincial Tax


MERGE|CalculationValueDefinition|VISION|TCI_816423_PT_19_VD1|ZHRX_CAVS_ST_LDGMAIN|TCI_816423_PT_19|2019/05/02
|Other Tax Credits|Provincial Tax|19

41 W HITE PAPER / Loading Tax Withholding Information for Canada


Using HCM Data Loader
MERGE|CalculationValueDefinition|VISION|TCI_816423_PT_19_VD2|ZHRX_CAVS_ST_LDGMAIN|TCI_816423_PT_19|2019/05/02
|Additional Tax|Provincial Tax|19
MERGE|CalculationValueDefinition|VISION|TCI_816423_PT_19_VD3|ZHRX_CAVS_ST_LDGMAIN|TCI_816423_PT_19|2019/05/02
|Annual Deduction|Provincial Tax|19
MERGE|CalculationValueDefinition|VISION|TCI_816423_PT_19_VD4|ZHRX_CAVS_ST_LDGMAIN|TCI_816423_PT_19|2019/05/02
|Commission Expenses|Provincial Tax|19
MERGE|CalculationValueDefinition|VISION|TCI_816423_PT_19_VD5|ZHRX_CAVS_ST_LDGMAIN|TCI_816423_PT_19|2019/05/02
|Commission Remuneration|Provincial Tax|19
MERGE|CalculationValueDefinition|VISION|TCI_816423_PT_19_VD6|ZHRX_CAVS_ST_LDGMAIN|TCI_816423_PT_19|2019/05/02
|Labour Fund Contributions|Provincial Tax|19
MERGE|CalculationValueDefinition|VISION|TCI_816423_PT_19_VD7|ZHRX_CAVS_ST_LDGMAIN|TCI_816423_PT_19|2019/05/02
|Provincial Tax Amount|Provincial Tax|19
MERGE|CalculationValueDefinition|VISION|TCI_816423_PT_19_VD8|ZHRX_CAVS_ST_LDGMAIN|TCI_816423_PT_19|2019/05/02
|Provincial Tax Rate|Provincial Tax|19
MERGE|CalculationValueDefinition|VISION|TCI_816423_PT_19_VD9|ZHRX_CAVS_ST_LDGMAIN|TCI_816423_PT_19|2019/05/02
|Total Claim Amount|Provincial Tax|19

METADATA|EnterableCalculationValue|SourceSystemOwner|SourceSystemId|LegislativeDataGroupName|ValueDefnId(Sour
ceSystemId)|EffectiveStartDate|ValueDefinitionName|DirCardCompDefName|Value1|Context1
COMMENT Override values for Federal Tax
MERGE|EnterableCalculationValue|VISION|TCI_816423_FT_VD1|ZHRX_CAVS_ST_LDGMAIN|TCI_816423_FT_VD1|2019/05/02|Ad
ditional Tax|Federal Tax|100|
MERGE|EnterableCalculationValue|VISION|TCI_816423_FT_VD2|ZHRX_CAVS_ST_LDGMAIN|TCI_816423_FT_VD2|2019/05/02|An
nual Deduction|Federal Tax|100|
MERGE|EnterableCalculationValue|VISION|TCI_816423_FT_VD3|ZHRX_CAVS_ST_LDGMAIN|TCI_816423_FT_VD3|2019/05/02|Co
mmission Expenses|Federal Tax|100|
MERGE|EnterableCalculationValue|VISION|TCI_816423_FT_VD4|ZHRX_CAVS_ST_LDGMAIN|TCI_816423_FT_VD4|2019/05/02|Co
mmission Remuneration|Federal Tax|100|
MERGE|EnterableCalculationValue|VISION|TCI_816423_FT_VD5|ZHRX_CAVS_ST_LDGMAIN|TCI_816423_FT_VD5|2019/05/02|Fe
deral Tax Amount|Federal Tax|100|
MERGE|EnterableCalculationValue|VISION|TCI_816423_FT_VD6|ZHRX_CAVS_ST_LDGMAIN|TCI_816423_FT_VD6|2019/05/02|Fe
deral Tax Rate|Federal Tax|100|
MERGE|EnterableCalculationValue|VISION|TCI_816423_FT_VD7|ZHRX_CAVS_ST_LDGMAIN|TCI_816423_FT_VD7|2019/05/02|La
bour Fund Contributions|Federal Tax|100|
MERGE|EnterableCalculationValue|VISION|TCI_816423_FT_VD8|ZHRX_CAVS_ST_LDGMAIN|TCI_816423_FT_VD8|2019/05/02|Pr
escribed Zone Deduction|Federal Tax|100|
MERGE|EnterableCalculationValue|VISION|TCI_816423_FT_VD9|ZHRX_CAVS_ST_LDGMAIN|TCI_816423_FT_VD9|2019/05/02|To
tal Claim Amount|Federal Tax|100|
MERGE|EnterableCalculationValue|VISION|TCI_816423_FT_VD10|ZHRX_CAVS_ST_LDGMAIN|TCI_816423_FT_VD10|2019/05/02|
Other Tax Credits|Federal Tax|100|

COMMENT Override values for Quebec Provincial Tax


MERGE|EnterableCalculationValue|VISION|TCI_816423_PT_19_VD1|ZHRX_CAVS_ST_LDGMAIN|TCI_816423_PT_19_VD1|2019/05
/02|Other Tax Credits|Provincial Tax|100|19
MERGE|EnterableCalculationValue|VISION|TCI_816423_PT_19_VD2|ZHRX_CAVS_ST_LDGMAIN|TCI_816423_PT_19_VD2|2019/05
/02|Additional Tax|Provincial Tax|100|19
MERGE|EnterableCalculationValue|VISION|TCI_816423_PT_19_VD3|ZHRX_CAVS_ST_LDGMAIN|TCI_816423_PT_19_VD3|2019/05
/02|Annual Deduction|Provincial Tax|100|19
MERGE|EnterableCalculationValue|VISION|TCI_816423_PT_19_VD4|ZHRX_CAVS_ST_LDGMAIN|TCI_816423_PT_19_VD4|2019/05
/02|Commission Expenses|Provincial Tax|100|19
MERGE|EnterableCalculationValue|VISION|TCI_816423_PT_19_VD5|ZHRX_CAVS_ST_LDGMAIN|TCI_816423_PT_19_VD5|2019/05
/02|Commission Remuneration|Provincial Tax|100|19
MERGE|EnterableCalculationValue|VISION|TCI_816423_PT_19_VD6|ZHRX_CAVS_ST_LDGMAIN|TCI_816423_PT_19_VD6|2019/05
/02|Labour Fund Contributions|Provincial Tax|100|19
MERGE|EnterableCalculationValue|VISION|TCI_816423_PT_19_VD7|ZHRX_CAVS_ST_LDGMAIN|TCI_816423_PT_19_VD7|2019/05
/02|Provincial Tax Amount|Provincial Tax|100|19
MERGE|EnterableCalculationValue|VISION|TCI_816423_PT_19_VD8|ZHRX_CAVS_ST_LDGMAIN|TCI_816423_PT_19_VD8|2019/05
/02|Provincial Tax Rate|Provincial Tax|100|19
MERGE|EnterableCalculationValue|VISION|TCI_816423_PT_19_VD9|ZHRX_CAVS_ST_LDGMAIN|TCI_816423_PT_19_VD9|2019/05
/02|Total Claim Amount|Provincial Tax|100|19

42 W HITE PAPER / Loading Tax Withholding Information for Canada


Using HCM Data Loader
Creating Tax Credit Information for Most Canadian Provinces
This example creates a complete Tax Credit Information calculation card for an employee in British Columbia. This shape is used by
most provinces, with the exception of

• Nunavut

• Northwest Territories

• Quebec

Note: This example provides three value definitions for Provincial Tax; some provinces don’t utilize Labor Fund Contributions. Refer to
the Calculation Value Definitions table in the Provincial Tax section for more information.

Use the CalculationCard.dat file to upload Tax Credit Information calculation cards with HCM Data Loader.

Example File 9: Creating Tax Credit Information for other Provinces

METADATA|CalculationCard|SourceSystemOwner|SourceSystemId|LegislativeDataGroupName|DirCardDefinitionName|Effec
tiveStartDate|AssignmentNumber|CardSequence
MERGE|CalculationCard|VISION|TCI_816423|CA LDG|Tax Credit Information|2019/05/02|E816423|1

METADATA|CardComponent|SourceSystemOwner|SourceSystemId|LegislativeDataGroupName|DirCardId(SourceSystemId)|Eff
ectiveStartDate|DirCardCompDefName|ComponentSequence|Context1
MERGE|CardComponent|VISION|TCI_816423_CT|CA LDG|TCI_816423|2019/05/02|Canadian
Taxation|300100044131319|300100044131319
MERGE|CardComponent|VISION|TCI_816423_FT|CA LDG|TCI_816423|2019/05/02|Federal Tax|1|
MERGE|CardComponent|VISION|TCI_816423_EI|CA LDG|TCI_816423|2019/05/02|Employment Insurance|1|
MERGE|CardComponent|VISION|TCI_816423_PP|CA LDG|TCI_816423|2019/05/02|Canada Pension Plan|1|

COMMENT Additional card components for British Columbia


MERGE|CardComponent|VISION|TCI_816423_PT_3|CA LDG|TCI_816423|2019/05/02|Provincial Tax|3|3

METADATA|ComponentDetail|SourceSystemOwner|SourceSystemId|LegislativeDataGroupName|DirCardCompId(SourceSystemI
d)|EffectiveStartDate|DirCardCompDefName|DirInformationCategory|FLEX:Deduction Developer
DF|federalTaxExempt(Deduction Developer DF=HRX_CA_WTH_FEDERAL_INCOME_TAX)|cppRevocationDate(Deduction
Developer DF=HRX_CA_WTH_FEDERAL_PENSION_PLAN)|cppExempt(Deduction Developer
DF=HRX_CA_WTH_FEDERAL_PENSION_PLAN)|cppElectionDate(Deduction Developer
DF=HRX_CA_WTH_FEDERAL_PENSION_PLAN)|eiExempt(Deduction Developer
DF=HRX_CA_WTH_FEDERAL_EMPLOYMENT_INSURANCE)|provinceTaxExempt(Deduction Developer
DF=HRX_CA_WTH_PROVINCE_INCOME_TAX)|numberOfDependentsUnderAge(Deduction Developer
DF=HRX_CA_WTH_PROVINCE_INCOME_TAX)|numberOfDisabledDependents(Deduction Developer
DF=HRX_CA_WTH_PROVINCE_INCOME_TAX)|payrollTaxExempt(Deduction Developer
DF=HRX_CA_WTH_PROVINCE_PAYROLL_TAX)|provinceOfEmployement(Deduction Developer
DF=HRX_CA_WTH_TAXATION)|oraHrxCaVlPlan(Deduction Developer
DF=HRX_CA_WTH_TAXATION)|oraHrxCaVacServDate(Deduction Developer DF=HRX_CA_WTH_TAXATION)
MERGE|ComponentDetail|VISION|TCI_816423_CT_TX|CA LDG|TCI_816423_CT|2019/05/02|Canadian
Taxation|HRX_CA_WTH_TAXATION|HRX_CA_WTH_TAXATION||||||||||19||
MERGE|ComponentDetail|VISION|TCI_816423_FT_IT|CA LDG|TCI_816423_FT|2019/05/02|Federal
Tax|HRX_CA_WTH_FEDERAL_INCOME_TAX|HRX_CA_WTH_FEDERAL_INCOME_TAX|Y|||||||||||
MERGE|ComponentDetail|VISION|TCI_816423_EI_EI|CA LDG|TCI_816423_EI|2019/05/02|Employment
Insurance|HRX_CA_WTH_FEDERAL_EMPLOYMENT_INSURANCE|HRX_CA_WTH_FEDERAL_EMPLOYMENT_INSURANCE|||||Y|||||||
MERGE|ComponentDetail|VISION|TCI_816423_PP_PP|CA LDG|TCI_816423_PP|2019/05/02|Canada Pension
Plan|HRX_CA_WTH_FEDERAL_PENSION_PLAN|HRX_CA_WTH_FEDERAL_PENSION_PLAN|||Y|||||||||

COMMENT Additional components details for British Columbia


MERGE|ComponentDetail|VISION|TCI_816423_PT_3_PIT|CA LDG|TCI_816423_PT_3|2019/05/02|Provincial
Tax|HRX_CA_WTH_PROVINCE_INCOME_TAX|HRX_CA_WTH_PROVINCE_INCOME_TAX||||||Y||||||

METADATA|CalculationValueDefinition|SourceSystemOwner|SourceSystemId|LegislativeDataGroupName|SourceId(SourceS
ystemId)|EffectiveStartDate|ValueDefinitionName|DirCardCompDefName|Context1
COMMENT value definitions for Federal Tax
MERGE|CalculationValueDefinition|VISION|TCI_816423_FT_VD1|CA LDG|TCI_816423_FT|2019/05/02|Additional
Tax|Federal Tax|
MERGE|CalculationValueDefinition|VISION|TCI_816423_FT_VD2|CA LDG|TCI_816423_FT|2019/05/02|Annual
Deduction|Federal Tax|

43 W HITE PAPER / Loading Tax Withholding Information for Canada


Using HCM Data Loader
MERGE|CalculationValueDefinition|VISION|TCI_816423_FT_VD3|CA LDG|TCI_816423_FT|2019/05/02|Commission
Expenses|Federal Tax|
MERGE|CalculationValueDefinition|VISION|TCI_816423_FT_VD4|CA LDG|TCI_816423_FT|2019/05/02|Commission
Remuneration|Federal Tax|
MERGE|CalculationValueDefinition|VISION|TCI_816423_FT_VD5|CA LDG|TCI_816423_FT|2019/05/02|Federal Tax
Amount|Federal Tax|
MERGE|CalculationValueDefinition|VISION|TCI_816423_FT_VD6|CA LDG|TCI_816423_FT|2019/05/02|Federal Tax
Rate|Federal Tax|
MERGE|CalculationValueDefinition|VISION|TCI_816423_FT_VD7|CA LDG|TCI_816423_FT|2019/05/02|Labour Fund
Contributions|Federal Tax|
MERGE|CalculationValueDefinition|VISION|TCI_816423_FT_VD8|CA LDG|TCI_816423_FT|2019/05/02|Prescribed Zone
Deduction|Federal Tax|
MERGE|CalculationValueDefinition|VISION|TCI_816423_FT_VD9|CA LDG|TCI_816423_FT|2019/05/02|Total Claim
Amount|Federal Tax|
MERGE|CalculationValueDefinition|VISION|TCI_816423_FT_VD10|CA LDG|TCI_816423_FT|2019/05/02|Other Tax
Credits|Federal Tax|

COMMENT Value definitions for British Columbia Provincial Tax


MERGE|CalculationValueDefinition|VISION|TCI_816423_PT_3_VD1|CA LDG|TCI_816423_PT_3|2019/05/02|Total Claim
Amount|Provincial Tax|3
MERGE|CalculationValueDefinition|VISION|TCI_816423_PT_3_VD2|CA LDG|TCI_816423_PT_3|2019/05/02|Other Tax
Credits|Provincial Tax|3
MERGE|CalculationValueDefinition|VISION|TCI_816423_PT_3_VD3|CA LDG|TCI_816423_PT_3|2019/05/02|Labour Fund
Contributions|Provincial Tax|3

METADATA|EnterableCalculationValue|SourceSystemOwner|SourceSystemId|LegislativeDataGroupName|ValueDefnId(Sourc
eSystemId)|EffectiveStartDate|ValueDefinitionName|DirCardCompDefName|Value1|Context1
COMMENT Override values for Federal Tax
MERGE|EnterableCalculationValue|VISION|TCI_816423_FT_VD1|CA LDG|TCI_816423_FT_VD1|2019/05/02|Additional
Tax|Federal Tax|100|
MERGE|EnterableCalculationValue|VISION|TCI_816423_FT_VD2|CA LDG|TCI_816423_FT_VD2|2019/05/02|Annual
Deduction|Federal Tax|100|
MERGE|EnterableCalculationValue|VISION|TCI_816423_FT_VD3|CA LDG|TCI_816423_FT_VD3|2019/05/02|Commission
Expenses|Federal Tax|100|
MERGE|EnterableCalculationValue|VISION|TCI_816423_FT_VD4|CA LDG|TCI_816423_FT_VD4|2019/05/02|Commission
Remuneration|Federal Tax|100|
MERGE|EnterableCalculationValue|VISION|TCI_816423_FT_VD5|CA LDG|TCI_816423_FT_VD5|2019/05/02|Federal Tax
Amount|Federal Tax|100|
MERGE|EnterableCalculationValue|VISION|TCI_816423_FT_VD6|CA LDG|TCI_816423_FT_VD6|2019/05/02|Federal Tax
Rate|Federal Tax|100|
MERGE|EnterableCalculationValue|VISION|TCI_816423_FT_VD7|CA LDG|TCI_816423_FT_VD7|2019/05/02|Labour Fund
Contributions|Federal Tax|100|
MERGE|EnterableCalculationValue|VISION|TCI_816423_FT_VD8|CA LDG|TCI_816423_FT_VD8|2019/05/02|Prescribed Zone
Deduction|Federal Tax|100|
MERGE|EnterableCalculationValue|VISION|TCI_816423_FT_VD9|CA LDG|TCI_816423_FT_VD9|2019/05/02|Total Claim
Amount|Federal Tax|100|
MERGE|EnterableCalculationValue|VISION|TCI_816423_FT_VD10|CA LDG|TCI_816423_FT_VD10|2019/05/02|Other Tax
Credits|Federal Tax|100|

COMMENT Override values for British Columbia Provincial Tax


MERGE|EnterableCalculationValue|VISION|TCI_816423_PT_3_VD1|CA LDG|TCI_816423_PT_3_VD1|2019/05/02|Total Claim
Amount|Provincial Tax|100|3
MERGE|EnterableCalculationValue|VISION|TCI_816423_PT_3_VD2|CA LDG|TCI_816423_PT_3_VD2|2019/05/02|Other Tax
Credits|Provincial Tax|100|3
MERGE|EnterableCalculationValue|VISION|TCI_816423_PT_3_VD3|CA LDG|TCI_816423_PT_3_VD3|2019/05/02|Labour Fund
Contributions|Provincial Tax|100|3

METADATA|CardAssociation|SourceSystemOwner|SourceSystemId|LegislativeDataGroupName|DirCardId(SourceSystemId)|E
ffectiveStartDate|TaxReportingUnitName
MERGE|CardAssociation|VISION|TCI_816423_TRU|CA LDG|TCI_816423|2019/05/02|CA Tax Reporting Unit

METADATA|CardAssociationDetail|SourceSystemOwner|SourceSystemId|LegislativeDataGroupName|DirRepCardId(SourceSy
stemId)|EffectiveStartDate|DirCardCompId(SourceSystemId)|AssignmentNumber
MERGE|CardAssociationDetail|VISION|TCI_816423_CA|CA LDG|TCI_816423_TRU|2019/05/02|TCI_816423_CT|E816423

44 W HITE PAPER / Loading Tax Withholding Information for Canada


Using HCM Data Loader
45 W HITE PAPER / Loading Tax Withholding Information for Canada
Using HCM Data Loader
APPENDIX A – PROVINCE CODES
This table lists the codes used to identify the Canadian provinces. These codes are supplied to Context1 for Provincial and Quebec
Taxes.

PROVINCE GEOCODE VALUE

Alberta 1

British Columbia 3

Manitoba 5

New Brunswick 7

Newfoundland and Labrador 9

Northwest Territories 11

Nova Scotia 13

Ontario 15

Prince Edward Island 17

Quebec 19

Saskatchewan 21

Yukon 23

Nunavut 25

46 W HITE PAPER / Loading Tax Withholding Information for Canada


Using HCM Data Loader
ORACLE CORPORATION

Worldwide Headquarters
500 Oracle Parkway, Redwood Shores, CA 94065 USA

Worldwide Inquiries
TELE + 1.650.506.7000 + 1.800.ORACLE1
FAX + 1.650.506.7200
oracle.com

CONNECT W ITH US
Call +1.800.ORACLE1 or visit oracle.com. Outside North America, find your local office at oracle.com/contact.

blogs.oracle.com/oracle facebook.com/oracle twitter.com/oracle

Copyright © 2019, Oracle and/or its affiliates. All rights reserved. This document is provided for information purposes only, and the contents hereof are
subject to change without notice. This document is not warranted to be error-free, nor subject to any other warranties or conditions, whether expressed
orally or implied in law, including implied warranties and conditions of merchantability or fitness for a particular purpose. We specifically disclaim any
liability with respect to this document, and no contractual obligations are formed either directly or indirectly by this document. This document may not be
reproduced or transmitted in any form or by any means, electronic or mechanical, for any purpose, without our prior written permission.
Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.
Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or
registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks
of Advanced Micro Devices. UNIX is a registered trademark of The Open Group. 0719
White Paper Loading Tax Withholding Information for Canada
Using HCM Data Loader
July 2019July 2019
Author: Ema Johnson
Contributing Authors: Rene Holtam

You might also like