Search Results dedn_amt




Overview
Explore in AI Chat

Overview

APPS.PAY_US_INV_DED_FORMULAS is a PL/SQL package body that supports the calculation of involuntary deduction amounts within Oracle EBS Payroll for United States legislations. As documented in the package header, its stated purpose is to be "used by fast formulas of involuntary deduction elements to calculate deduction amounts," with different functions catering to distinct categories of involuntary deduction such as garnishments, bankruptcies, tax levies, and creditor debts.

The package originates from the Oracle Payroll US product family (source file pyusgrfm.pkb) and was introduced in version 115.0 in April 2004. The incrementally documented change history shows that responsibility for deduction amount calculation was later relocated from cal_formula_bo to base_formula, proration rules were enabled for cal_formula_bo, and the proration algorithm was adjusted so current support orders are prorated before arrears. The change list also records the migration of base formula global variables from scalar types to PL/SQL tables and the rework of date conversion using fnd_date.canonical_to_date. These changes reflect the package's central role in sequencing, prorating, and limiting involuntary deductions against statutory ceilings.

Key Procedures and Functions

The documented API surface comprises thirteen procedures and functions. BASE_FORMULA is the principal entry point, orchestrating deduction amount computation for involuntary deduction elements and, per the change history, hosting the relocated dedn amount calculation logic. CAL_FORMULA_SS, CAL_FORMULA_BO, and CAL_FORMULA_TL are calculation routines that handle category-specific processing, with CAL_FORMULA_BO associated with proration rules for support and bankruptcy orders. ENTRY_SUBPRIORITY resolves the relative ordering of deduction entries where multiple orders compete for limited disposable income.

Supporting utilities include CONVERT_PERIOD_TYPE, which normalizes deduction amounts and limits across payroll period frequencies; FNC_FEE_CALCULATION, which computes administrative or agency fees associated with garnishment processing; and GET_GARN_LIMIT_MAX_DURATION, which returns statutory maximum duration constraints for garnishment limits. GET_GEOCODE resolves geographic jurisdiction information, while GARN_CAT classifies the garnishment or involuntary deduction category. GET_TABLE_VALUE retrieves configuration or rules data, GET_CCPA_PROTECTION applies Consumer Credit Protection Act protection thresholds to restrict the deductible portion of disposable earnings, and RESET_GLOBAL_VAR clears package-level global state, which the change history indicates is maintained as PL/SQL tables rather than scalars.

Tables Accessed

The package reads and writes a defined set of Payroll and FND tables through APPS synonyms. Element and input-value configuration is sourced from PAY_ELEMENT_TYPES_F, PAY_ELEMENT_TYPE_EXTRA_INFO, PAY_INPUT_VALUES_F, PAY_USER_TABLES, PAY_USER_COLUMNS, PAY_USER_ROWS_F, and PAY_USER_COLUMN_INSTANCES_F, supplying the flexfield and user-defined rule metadata that fast formulas reference. Element entry data used in calculation comes from PAY_ELEMENT_ENTRIES_F and PAY_ELEMENT_ENTRY_VALUES_F.

Legislative and jurisdiction-specific rules are drawn from PAY_US_GARN_FEE_RULES_F (garnishment fee structures), PAY_US_FEDERAL_TAX_INFO_F (federal limits and exemptions), PAY_US_EMP_STATE_TAX_RULES_F and PAY_US_STATES (state-level rules and reference data). Session and payroll context are obtained from FND_SESSIONS and PAY_ALL_PAYROLLS_F, supporting effective-date and payroll-period awareness during processing.

Usage Notes

PAY_US_INV_DED_FORMULAS is not intended for direct invocation by end users or custom code. It is called from Oracle Payroll fast formulas attached to involuntary deduction elements during the payroll run, and may also be exercised from formula validation and testing screens in the Payroll responsibility. Because the ETRM metadata records zero referencing packages, integration occurs exclusively through the fast formula engine rather than through peer PL/SQL APIs. Customers extending involuntary deduction behavior should build on the fast formula layer and the documented configuration tables rather than modifying this seeded package body, since it is patched by Oracle as part of the Payroll US code line (pyusgrfm.pkb).