Example of Loading Garnishment and Creditor Debt Involuntary Deductions for US Employees

Wage garnishment or creditor debt occurs when an employer is required to withhold the earnings of an employee for the payment of a debt in accordance with a court order or other legal or equitable procedure.

An involuntary deduction element using this secondary classification needs to be configured prior to creating the card component.

Garnishment and Creditor Debt Involuntary Deduction Hierarchy

The card component name is defined by the element configuration, as are the value definitions which are supplied using the Calculation Value Definition and Enterable Calculation Value record types.

Refer to the Loading a Card Component for an Involuntary Deduction for details of each of the record types and attributes you need to supply for an involuntary deduction.

The example file lines in the section below are always supplied together in the same CalculationCard.dat file.

Calculation Card

Always supply the CalculationCard record for the Involuntary Deduction, even if the calculation card already exists for the employee.

Here, let's create a new Involuntary Deductions card for Payroll Relationship Number 6485851 starting 03-Jan-2022.

METADATA|CalculationCard|SourceSystemOwner|SourceSystemId|LegislativeDataGroupName|DirCardDefinitionName|EffectiveStartDate|EffectiveEndDate|CardSequence|PayrollRelationshipNumber
MERGE|CalculationCard|VISION|ID_6485851|USA LDG|Involuntary Deductions|2022/01/03|||6485851

Card Component

Define the type of Involuntary Deduction using the CardComponent record type.

For Garnishment and Creditor Debt involuntary deductions you must supply this context attribute:

Attribute Name	Value
Context1	The geocode of the state. Refer to the Cloud Customer Connect topic Template: BI Publisher Report: United States - State, County and City Geography Codes.
Context2	Supply a reference code. This value must be unique by deduction type and state.

In this example, let's create a Garnishment card component from 03-Jan-2022 for the state of Tennessee that has a reference code of Garn-32688.

METADATA|CardComponent|SourceSystemOwner|SourceSystemId|LegislativeDataGroupName|DirCardId(SourceSystemId)|EffectiveStartDate|EffectiveEndDate|DirCardCompDefName|Context1|Context2|Subpriority
MERGE|CardComponent|VISION|ID_GARN_6485851|USA LDG|ID_6485851|2022/01/03||Vision Creditor Debt|43|Garn-32688|

The parent Involuntary Deduction Calculation Card is identified by the DirCardId(SourceSystemId) attribute which has a value that match the SourceSystemId attribute on the CalculationCard record.

Component Details

Use the ComponentDetail record type to provide flexfield segment values. This example supplies a subset of the flexfield segments available.

METADATA|ComponentDetail|SourceSystemOwner|SourceSystemId|LegislativeDataGroupName|DirCardCompId(SourceSystemId)|EffectiveStartDate|EffectiveEndDate|DirCardCompDefName|DirInformationCategory|FLEX:Deduction Developer DF|orderAmtPayee_Display(Deduction Developer DF=INVLN_DEDN_PAYEE_DETAILS)|processFeePayee_Display(Deduction Developer DF=INVLN_DEDN_PAYEE_DETAILS)|receivedDate(Deduction Developer DF=INVLN_DEDN_SUPPORT_DATA)|startDate(Deduction Developer DF=INVLN_DEDN_SUPPORT_DATA)|description(Deduction Developer DF=INVLN_DEDN_SUPPORT_DATA)|issuingAuthorityName(Deduction Developer DF=INVLN_DEDN_SUPPORT_DATA)|initialFeeTaken(Deduction Developer DF=INVLN_DEDN_SUPPORT_DATA)|issuingJurisdictionName(Deduction Developer DF=INVLN_DEDN_SUPPORT_DATA)|remittanceIdentifier(Deduction Developer DF=HRX_US_INV_DEDN_DATA)|third2dpartyInvoluntaryDe(Deduction Developer DF=HRX_US_INV_DEDN_DATA)|documentTrackingNumber(Deduction Developer DF=HRX_US_INV_DEDN_DATA)
MERGE|ComponentDetail|VISION|ID_GARN_IDPD_6485851|USA LDG|ID_GARN_6485851|2022/01/03||Vision Creditor Debt|INVLN_DEDN_PAYEE_DETAILS|INVLN_DEDN_PAYEE_DETAILS|GMAC Collections|Employer Payee for Processing Fee|||||||||
MERGE|ComponentDetail|VISION|ID_GARN_IDSD_6485851|USA LDG|ID_GARN_6485851|2022/01/03||Vision Creditor Debt|INVLN_DEDN_SUPPORT_DATA|INVLN_DEDN_SUPPORT_DATA|||2022/01/03||Tennessee garnishment||Y|Tennessee|||
MERGE|ComponentDetail|VISION|ID_GARN_IDD_6485851|USA LDG|ID_GARN_6485851|2022/01/03||Vision Creditor Debt|HRX_US_INV_DEDN_DATA|HRX_US_INV_DEDN_DATA|||||||||4734333|1|DocID-12345

The parent Card Component is identified on the ComponentDetails records by the DirCardCompId(SourceSystemId) attribute, which has a value that matches the SourceSystemId on the CardComponent record.

Value Definitions

Use the CalculationValueDefinition and EnterableValueDefinition record types to provide override values for the value definitions.

In this example the following value definitions are overridden:

Value Definition	Value
Tennessee Garnishment Order Rate	.25
Tennessee Garnishment Total Owed Amount	7845.22
Tennessee Garnishment Number of Dependents	2

Note: Refer to the Cloud Customer Connect topic: Utilize the US Involuntary Deductions Value Definitions BI publisher report, to identify all value definitions for the Garnishment or Creditor debt element.

METADATA|CalculationValueDefinition|SourceSystemOwner|SourceSystemId|LegislativeDataGroupName|SourceId(SourceSystemId)|EffectiveStartDate|EffectiveEndDate|DirCardCompDefName|ValueDefinitionName
MERGE|CalculationValueDefinition|VISION|ID_GARN_VD1_6485851|USA LDG|ID_GARN_6485851|2022/01/03||Vision Creditor Debt|Tennessee Garnishment Order Rate
MERGE|CalculationValueDefinition|VISION|ID_GARN_VD2_6485851|USA LDG|ID_GARN_6485851|2022/01/03||Vision Creditor Debt|Tennessee Garnishment Total Owed Amount
MERGE|CalculationValueDefinition|VISION|ID_GARN_VD3_6485851|USA LDG|ID_GARN_6485851|2022/01/03||Vision Creditor Debt|Tennessee Garnishment Number of Dependents

METADATA|EnterableCalculationValue|SourceSystemOwner|SourceSystemId|LegislativeDataGroupName|ValueDefnId(SourceSystemId)|EffectiveStartDate|EffectiveEndDate|Value1
MERGE|EnterableCalculationValue|VISION|ID_GARN_VD1_ECV_6485851|USA LDG|ID_GARN_VD1_6485851|2022/01/03||0.25
MERGE|EnterableCalculationValue|VISION|ID_GARN_VD2_ECV_6485851|USA LDG|ID_GARN_VD2_6485851|2022/01/03||7845.22
MERGE|EnterableCalculationValue|VISION|ID_GARN_VD3_ECV_6485851|USA LDG|ID_GARN_VD3_6485851|2022/01/03||2

The parent Card Component is identified on the CalculationValueDefinitions records by the SourceId(SourceSystemId) attribute which has a value that matches the SourceSystemId on the CardComponent record.

The parent for each Calculation Value Definition is identified on each EnterableCalculationValue record using the ValueDefnId(SourceSystemId) attribute, which has a value that matches the SourceSystemID attribute on the parent CalculationValueDefinition record.