Example of Loading Federal Tax Withheld Balance Adjustments for Canada
This example creates a batch header and group record, with various lines and values to adjust the Federal Tax Withheld balance for two employees to increase the withheld balances by $10.
Load the Balance Adjustment Header and Group
Use the BalanceAdjustmentHeader.dat file to create the batch header and group records.
METADATA|BalanceAdjustmentHeader|LegislativeDataGroupName|BatchName
MERGE|BalanceAdjustmentHeader|CA LDG|Adjust Federal Taxes
METADATA|BalanceAdjustmentGroup|LegislativeDataGroupName|BatchName|EffectiveDate|PayrollName|ConsolidationSetName|PrepayFlag|BalanceAdjCostFlag
MERGE|BalanceAdjustmentGroup|CA LDG|Adjust Federal Taxes|2020/01/31|CA Semimonthly|CA Semimonthly Consolidation Set|N|N
The lines and values file can be simplified if Source Keys are used, as the user keys include a large number of attributes. However, this requires that source keys are used to identify the header and group. For example:
METADATA|BalanceAdjustmentHeader|SourceSystemOwner|SourceSystemId|LegislativeDataGroupName|BatchName
MERGE|BalanceAdjustmentHeader|VISION|ADJ_FED_TAX_2018|CA LDG|Adjust Federal Taxes 2018
METADATA|BalanceAdjustmentGroup|SourceSystemOwner|SourceSystemId|LegislativeDataGroupName|BalAdjBatchId(SourceSystemId)|EffectiveDate|PayrollName|ConsolidationSetName|PrepayFlag|BalanceAdjCostFlag
MERGE|BalanceAdjustmentGroup|VISION|ADJ_FED_TAX_2018_GRP|CA LDG|ADJ_FED_TAX_2018|2018/01/31|CA Semimonthly|CA Semimonthly Consolidation Set|N|N
Load the Balance Adjustment Lines and Values
| Batch Line Sequence | Assignment Number | Element Name | Tax Reporting Unit Name |
|---|---|---|---|
| 1 | E182111 | Federal Taxes | CA Tax Reporting Unit |
| 2 | E182110 | Federal Taxes | CA Tax Reporting Unit |
The Balance Adjustment Value file lines specify the input values for the element named in the line record. The Entry Value is the value for the Input Value Name of the Element Name. For example, in the first line below, the Entry Value of $10 is the value specified for the Tax Calculated input value for the Federal Taxes element.
You must also specify the contexts for the Province and Reporting Type. That is the reason there are 3 value records for the 1 line record above for the Federal Taxes element. In the value record below where Province is the Input Value Name, the Entry Value corresponds to the geography code of the province. For example, the value ‘1’ corresponds to the province of Alberta.
In the value record below where Reporting Type is the Input Value Name, the Entry Value corresponds to the statutory reporting code.
| Batch Line Sequence | Element Name | Input Value Name | Entry Value |
|---|---|---|---|
| 1 | Federal Taxes | Federal Withheld | 10 |
| 1 | Federal Taxes | Province | 1 |
| 1 | Federal Taxes | Reporting Type | T4_RL1 |
| 2 | Federal Taxes | Federal Withheld | 10 |
| 2 | Federal Taxes | Province | 21 |
| 2 | Federal Taxes | Reporting Type | T4_RL1 |
Use the BalanceAdjustmentLine.dat file to create the batch line and value records.
METADATA|BalanceAdjustmentLine|LegislativeDataGroupName|BatchName|PayrollName|ConsolidationSetName|EffectiveDate|BatchLineSequence|AssignmentNumber|ElementName|TaxReportingUnitName
MERGE|BalanceAdjustmentLine|CA LDG|Adjust Federal Taxes|CA Semimonthly|CA Semimonthly Consolidation Set|2020/01/31|1|E182111|Federal Taxes|CA Tax Reporting Unit
MERGE|BalanceAdjustmentLine|CA LDG|Adjust Federal Taxes|CA Semimonthly|CA Semimonthly Consolidation Set|2020/01/31|2|E182110|Federal Taxes|CA Tax Reporting Unit
METADATA|BalanceAdjustmentValue|LegislativeDataGroupName|BatchName|PayrollName|ConsolidationSetName|EffectiveDate|BatchLineSequence|InputValueName|ElementName|EntryValue
MERGE|BalanceAdjustmentValue|CA LDG|Adjust Federal Taxes|CA Semimonthly|CA Semimonthly Consolidation Set|2020/01/31|1|Federal Withheld|Federal Taxes|10
MERGE|BalanceAdjustmentValue|CA LDG|Adjust Federal Taxes|CA Semimonthly|CA Semimonthly Consolidation Set|2020/01/31|1|Province|Federal Taxes|1
MERGE|BalanceAdjustmentValue|CA LDG|Adjust Federal Taxes|CA Semimonthly|CA Semimonthly Consolidation Set|2020/01/31|1|Reporting Type|Federal Taxes|T4_RL1
MERGE|BalanceAdjustmentValue|CA LDG|Adjust Federal Taxes|CA Semimonthly|CA Semimonthly Consolidation Set|2020/01/31|2|Federal Withheld|Federal Taxes|10
MERGE|BalanceAdjustmentValue|CA LDG|Adjust Federal Taxes|CA Semimonthly|CA Semimonthly Consolidation Set|2020/01/31|2|Province|Federal Taxes|21
MERGE|BalanceAdjustmentValue|CA LDG|Adjust Federal Taxes|CA Semimonthly|CA Semimonthly Consolidation Set|2020/01/31|2|Reporting Type|Federal Taxes|T4_RL1
When source keys are supplied the balance adjustment group can be identified by the two source key attributes as opposed to the five user attributes. Similarly, the balance adjustment line can be identified by the two source key attributes as opposed to the six user key attributes.
METADATA|BalanceAdjustmentLine|SourceSystemOwner|SourceSystemId|LegislativeDataGroupName|BalAdjGroupId(SourceSystemId)|BatchLineSequence|AssignmentNumber|ElementName|TaxReportingUnitName
MERGE|BalanceAdjustmentLine|VISION|ADJ_FED_TAX_2018_GRP_1|CA LDG|ADJ_FED_TAX_2018_GRP|1|E182111|Federal Taxes|CA Tax Reporting Unit
MERGE|BalanceAdjustmentLine|VISION|ADJ_FED_TAX_2018_GRP_2|CA LDG|ADJ_FED_TAX_2018_GRP|2|E182110|Federal Taxes|CA Tax Reporting Unit
METADATA|BalanceAdjustmentValue|SourceSystemOwner|SourceSystemId|LegislativeDataGroupName|BatchNameBalAdjLineId(SourceSystemId)|InputValueName|EntryValue|ElementName
MERGE|BalanceAdjustmentValue|VISION|ADJ_FED_TAX_2018_GRP_1_FW|CA LDG|ADJ_FED_TAX_2018_GRP_1|Federal Withheld|10|Federal Taxes
MERGE|BalanceAdjustmentValue|VISION|ADJ_FED_TAX_2018_GRP_1_PR|CA LDG|ADJ_FED_TAX_2018_GRP_1|Province|1|Federal Taxes
MERGE|BalanceAdjustmentValue|VISION|ADJ_FED_TAX_2018_GRP_1_RT|CA LDG|ADJ_FED_TAX_2018_GRP_1|Reporting Type|T4_RL1|Federal Taxes
MERGE|BalanceAdjustmentValue|VISION|ADJ_FED_TAX_2018_GRP_2_FW|CA LDG|ADJ_FED_TAX_2018_GRP_2|Federal Withheld|10|Federal Taxes
MERGE|BalanceAdjustmentValue|VISION|ADJ_FED_TAX_2018_GRP_2_PR|CA LDG|ADJ_FED_TAX_2018_GRP_2|Province|21|Federal Taxes
MERGE|BalanceAdjustmentValue|VISION|ADJ_FED_TAX_2018_GRP_2_RT|CA LDG|ADJ_FED_TAX_2018_GRP_2|Reporting Type|T4_RL1|Federal Taxes