PRGARNRULE – The Garnishment Rules files contains garnishment rules by governing tax authority and category for wage formulas…

System: Payroll (PR)
Prefix: PGR
Primary key: COMPANY, COUNTRY-CODE, TAX-ID-CODE, GARN-CAT, TYPE
Fields: 40
Updated by: 7 programs
Referenced by: 12 programs

PRGARNRULE is the The Garnishment Rules files contains garnishment rules by governing tax authority and category for wage formulas… table in Lawson Payroll (prefix PGR). It is indexed by COMPANY, COUNTRY-CODE, TAX-ID-CODE, GARN-CAT, TYPE (PGRSET1); alternate indexes: PGRSET2 and PGRSET3. It is related 1:1 to DEDCODE, PRGARNTYPE, PRSYSTEM and PRTAXAUTH and 1:M to PRGARNRULX. It is updated by PR115, PR25.2, PR26.1, PR46.2, PR47.1, PR514 and PR925 and referenced by BN66.1, PR05.1, PR139, PR140, PR189, PR195, PR225, PR246 and 4 more. The table has 40 fields, 3 indexes and 7 documented relations.

About PRGARNRULE

The Garnishment Rules files contains garnishment rules by governing tax authority and category for wage formulas, disposable income, and fee definitions.

Fields (40)

Column = COBOL field name without the PGR- prefix, hyphens → underscores. Derived fields are computed by the application and are not stored.

Field / column	Type	Description & values	Updated by
`PGR-COMPANY` PK COMPANY	Numeric 4	Contains the company number.	PR25.2, PR46.2, PR925
`PGR-TAX-ID-CODE` PK TAX_ID_CODE	Alpha 10	Defines the state, county, or province governing the attachment. Determines the rules that apply to a type of a garnishment. Note: You cannot define federal rules.	PR25.2, PR46.2, PR925
`PGR-GARN-CAT` PK GARN_CAT	Alpha 1	Identifies a group of garnishments. Rules may be defined by category. Reporting may be done by category. Garnishment types are tied to categories on the garnishment types table. `A` Assignment `B` Bankruptcy `G` Garnishment `L` Student Loans `S` Support `T` Tax Levies	PR25.2, PR46.2, PR925
`PGR-TYPE` PK TYPE	Alpha 2	Defines a type of garnishment. Rules are then defined for this type.	PR25.2, PR46.2, PR925
`PGR-EXEM-FORM` EXEM_FORM	Alpha 2	Defines how exempt earnings (protected income) are calculated.	PR25.2, PR46.2, PR925
`PGR-RATE-X-FED-MIN` RATE_X_FED_MIN	Numeric 3	This number is multiplied by the federal minimum wage to determine exempt wages.	PR25.2, PR925
`PGR-FACTOR-1` FACTOR_1	Signed 7.2	Parameter used in calculating exempt wages.	PR25.2, PR925
`PGR-FACTOR-2` FACTOR_2	Signed 7.2	Parameter used to calculate exempt wages.	PR25.2
`PGR-FACTOR-3` FACTOR_3	Signed 7.2	Parameter used to calculate exempt wages.	PR25.2
`PGR-FACTOR-4` FACTOR_4	Signed 7.2	Parameter used to calculate exempt wages.	PR25.2
`PGR-SND-FAM-YES` SND_FAM_YES	Signed 5.2	Contains the percent to withhold for an employee with a second family.	PR25.2, PR925
`PGR-SND-FAM-NO` SND_FAM_NO	Signed 5.2	Contains the percent to withhold for an employee without a second family.	PR25.2, PR925
`PGR-ARR-ADD-PCT` ARR_ADD_PCT	Signed 5.2	Used with child support or alimony garnishments and represents the additional percent if outstanding arrearages are more than 12 weeks old on the employee record.	PR25.2, PR925
`PGR-PCT-PER-DEP` PCT_PER_DEP	Signed 7.2	Defines the amount or percent per dependent used to calculate exempt earnings.	PR25.2
`PGR-CALC-TYPE` CALC_TYPE	Alpha 1	Determines if the value in the Per Dependent field is an amount or a percent. `A` Amount `P` Percent	PR25.2
`PGR-MULT-GARN-RULE` MULT_GARN_RULE	Alpha 1	Defines how to distribute the amount to be withheld when the amount is insufficient and multiple orders exist (for the same category) for an employee. `1` Prorate Based On Farn Amount `2` Equal Amount To Each Other `3` Effective Date Order `4` Withhold One Garn At A Time	PR25.2, PR46.2, PR925
`PGR-FEES-DED-CODE` FEES_DED_CODE	Alpha 4	Contains the deduction code used to track the fee amount withheld separately from the order amount.	PR25.2, PR46.2
`PGR-AMOUNT` AMOUNT	Currency 15.2	Contains the amount to be charged for this garnishment.	PR25.2, PR46.2
`PGR-FREQUENCY` FREQUENCY	Alpha 1	Indicates when the fee will be withheld. `1` Only When Garn Amt is Withheld `2` Every Cyc Garn Should be Taken	PR25.2, PR46.2
`PGR-FEES-LMT-TYPE` FEES_LMT_TYPE	Alpha 2	Identifies which rules formula is used in determining the fee amount.	PR25.2, PR46.2
`PGR-FEES-LMT-AMT-1` FEES_LMT_AMT_1	Signed 7.2	Contains a limit amount or percent. This used in calculation based on the limit rule.	PR25.2, PR46.2
`PGR-FEES-LMT-AMT-2` FEES_LMT_AMT_2	Signed 7.2	If the limit rule has two calculations, contains the amount or percent of the second part of the calculation.	PR25.2, PR46.2
`PGR-FEES-1ST-TIME` FEES_1ST_TIME	Signed 7.2	Contains a fee used for the first time garnishment is processed for an employee.	PR25.2, PR46.2
`PGR-GL-DIST-COMP` GL_DIST_COMP	Numeric 4	Contains the distribution company for the accrual account on the deduction for fees.	PR25.2, PR46.2
`PGR-GL-ACCT-UNIT` GL_ACCT_UNIT	Alpha 15	Contains the accounting unit used for the accrual on the deduction for fees.	PR25.2, PR46.2
`PGR-GL-ACCOUNT` GL_ACCOUNT	Numeric 6	Contains the account for the accrual account on the deduction for fees.	PR25.2, PR46.2
`PGR-GL-SUB-ACCT` GL_SUB_ACCT	Numeric 4	Contains the subaccount for the accrual account used on the fee deduction.	PR25.2, PR46.2
`PGR-EXCL-PAY-CODE` EXCL_PAY_CODE	Alpha 4 Occurs 30 Times ×30	Excludes certain pay in calculating the disposable income.	PR25.2, PR46.2
`PGR-EXCL-DED-CODE` EXCL_DED_CODE	Alpha 4 Occurs 30 Times ×30	Excludes certain deductions in calculating the disposable income.	PR25.2, PR46.2
`PGR-CHANGE-FLAG` CHANGE_FLAG	Alpha 1	Indicates whether the fee amount is changed for the garnishment rule. `Y` Yes	PR115, PR25.2, PR46.2
`PGR-USED-FLAG` USED_FLAG	Alpha 1	This flag is updated when an employee garnishment is added for this garnishment rule in PR26.1 (Employee Garnishment) based on the governing taxing authority, category, and type. `Y` YEs `N` No	PR25.2, PR26.1, PR46.2, PR47.1, PR514, PR925
`PGR-COUNTRY-CODE` PK COUNTRY_CODE	Alpha 2	The country code. Required for VAT and intrastat reporting. Must be defined in IN01.1 (Country Maintenance).	PR25.2, PR46.2, PR925
`PGR-NBR-DEPS` NBR_DEPS	Numeric 2 Occurs 20 Times ×20	Contains the number of dependents used in the calculation of the dependent exempt amount.	PR46.2
`PGR-DEP-AMOUNT` DEP_AMOUNT	Signed 7.2 Occurs 20 Times ×20	Contains the amount per dependent that is exempt from seizure.	PR46.2
`PGR-INCL-ADD-NET` INCL_ADD_NET	Alpha 4 Occurs 10 Times ×10	Contains the deduction code of the add to net deduction(s) that should be included in calculating the wages available for garnishment.	PR46.2
`PGR-CURRENCY-CODE` CURRENCY_CODE	Alpha 5	This field contains the company base currency code established in Company (GL10.1 ).	—
`PGR-CURR-ND` CURR_ND	Numeric 1	The number of decimals assigned to a particular account as determined by the account currency.	—
`PGR-DED-FROM-GARN` DED_FROM_GARN	Alpha 1	—	PR25.2
`PGR-CH-DED-CODE` CH_DED_CODE	Alpha 4	—	PR25.2
`PGR-CLEARHOUSE-FEE` CLEARHOUSE_FEE	Signed 11.2	—	PR25.2

Indexes (3)

Keys marked * are descending. Every documented Lawson index is unique unless flagged Duplicates; Subset indexes carry a Where condition.

Index	Keys	Flags	Condition	Used in
`PGRSET1`	`COMPANY`, `COUNTRY-CODE`, `TAX-ID-CODE`, `GARN-CAT`, `TYPE`	Primary		BN66.1, PR05.1, PR115, PR139, PR140, PR189, PR195, PR225 +11 more
`PGRSET2`	`TYPE`, `COMPANY`, `COUNTRY-CODE`, `TAX-ID-CODE`, `GARN-CAT`			PR25.1, PR46.1
`PGRSET3`	`COMPANY`, `COUNTRY-CODE`, `TAX-ID-CODE`, `GARN-CAT`, `TYPE`	Subset	Where CHANGE-FLAG = "Y" And USED-FLAG = "Y"	PR115, PR140, PR189, PR80.1, PR80.4

Relations

One to one (6) — lookups and parents

Relation	Table	Rules	Field map
Fees Ded	DEDCODE	Required	`PGR-COMPANY` → `DDC-COMPANY`, `PGR-FEES-DED-CODE` → `DDC-DED-CODE`
Incl Add Net	DEDCODE	Required	`PGR-COMPANY` → `DDC-COMPANY`, `PGR-INCL-ADD-NET` → `DDC-DED-CODE`
Prgarncat	PRGARNTYPE	Required	`PGR-COUNTRY-CODE` → `GRT-COUNTRY-CODE`, `PGR-GARN-CAT` → `GRT-GARN-CAT`, `PGR-TYPE` → `GRT-TYPE`
Prgarntype	PRGARNTYPE	Required	`PGR-COUNTRY-CODE` → `GRT-COUNTRY-CODE`, `PGR-TYPE` → `GRT-TYPE`
Prsystem	PRSYSTEM	Required	`PGR-COMPANY` → `PRS-COMPANY`, `Spaces` → `PRS-PROCESS-LEVEL`
Prtaxauth	PRTAXAUTH	Required	`PGR-TAX-ID-CODE` → `PRX-TAX-ID-CODE`

One to many (1) — child tables

Relation	Table	Rules	Condition	Field map
Prgarnrulx	PRGARNRULX	Delete Cascades		`PGR-COMPANY` → `PGX-COMPANY`, `PGR-COUNTRY-CODE` → `PGX-COUNTRY-CODE`, `PGR-TAX-ID-CODE` → `PGX-TAX-ID-CODE`, `PGR-GARN-CAT` → `PGX-GARN-CAT`, `PGR-TYPE` → `PGX-TYPE`, → `PGX-SEQ-NBR`

Programs

Updated by (7)

PR115 Deduction, Garnishment Fee, Pay Summary Grp Update
PR25.2 United States Garnishment Rules
PR26.1 United States Employee Garnishment
PR46.2 Canada Garnishment Rules
PR47.1 Canada Employee Garnishment
PR514 Employee Deduction Master Load
PR925 Load Required US Federal Garnishment Rules

Referenced by (12)

BN66.1 Estimated Pay Calculation
PR05.1 Deduction
PR139 Arrears Automation
PR140 Earnings and Deductions Calculation
PR189 Gross Up Calculation
PR195 Accrual Program
PR225 United States Garnishment Rules Listing
PR246 Canada Garnishment Rules Listing
PR80.1 Manual Check
PR80.4 Manual Payment
PR89.1 Payment Modeling
PRAT.1 Alltax connection test