Search Results pay_us_inv_ded_formulas




Overview
Explore in AI Chat

Overview

APPS.PAY_US_INV_DED_FORMULAS is a PL/SQL package within the Oracle E-Business Suite Payroll module that supports involuntary deduction processing for United States payrolls. Involuntary deductions include court-ordered garnishments, creditor judgments, tax levies, and similar withholdings that an employer is legally obligated to satisfy. The package provides the underlying calculation logic used by Oracle Fast Formulas attached to involuntary deduction elements. As the header comment states, the package is used by fast formulas of involuntary deduction elements to calculate deduction amounts, with different functions catering to different categories of involuntary deduction.

The package originated under the pyusgrfm.pkh header and was created on 23-APR-2004. Its change history demonstrates that functionality was progressively expanded across multiple versions, adding parameter support for the DCIA (Debt Collection Improvement Act) category, introducing arrears handling via a global PL/SQL table, and refining parameter sets for the base and calculation routines.

Key Procedures and Functions

The package exposes thirteen documented procedures and functions:

  • BASE_FORMULA — The central routine that governs base deduction computation for involuntary deduction elements. It is the most frequently revised entry point in the package history and the object referenced by the search term "base_formula."
  • CAL_FORMULA_SS, CAL_FORMULA_BO, CAL_FORMULA_TL — Category-specific calculation routines supporting the various involuntary deduction classifications (for example, Social Security-related, bankruptcy order, and tax levy categories).
  • ENTRY_SUBPRIORITY — Determines the processing subpriority for element entries, ensuring deductions are applied in a legally compliant order.
  • CONVERT_PERIOD_TYPE — Translates deduction amounts or limits between differing payroll period frequencies.
  • FNC_FEE_CALCULATION — Computes administrative or processing fees associated with a garnishment or involuntary deduction.
  • GET_GARN_LIMIT_MAX_DURATION — Retrieves the maximum duration for which a garnishment limit applies.
  • GET_GEOCODE — Returns geographic codes used to resolve jurisdiction-specific rules.
  • GARN_CAT — Returns the garnishment category associated with a given deduction or employee context.
  • GET_TABLE_VALUE — A utility that fetches values from user-defined tables referenced by Fast Formula logic.
  • GET_CCPA_PROTECTION — Determines the protected disposable earnings amount under the Consumer Credit Protection Act.
  • RESET_GLOBAL_VAR — Clears package-level global variables between payroll processing runs to prevent stale values from affecting subsequent calculations.

Tables Accessed

The package reads and writes a range of payroll and reference tables through APPS synonyms. Payroll and element structures are accessed via PAY_ALL_PAYROLLS_F, PAY_ELEMENT_ENTRIES_F, PAY_ELEMENT_ENTRY_VALUES_F, PAY_ELEMENT_TYPES_F, PAY_ELEMENT_TYPE_EXTRA_INFO, and PAY_INPUT_VALUES_F. Fast Formula user-defined table support draws on PAY_USER_TABLES, PAY_USER_COLUMNS, PAY_USER_ROWS_F, and PAY_USER_COLUMN_INSTANCES_F. Statutory and jurisdictional rules are sourced from PAY_US_EMP_STATE_TAX_RULES_F, PAY_US_FEDERAL_TAX_INFO_F, PAY_US_GARN_FEE_RULES_F, and PAY_US_STATES. FND_SESSIONS provides session context relevant to the executing environment.

Usage Notes

PAY_US_INV_DED_FORMULAS is not invoked directly by end users. It is called by Fast Formulas attached to involuntary deduction elements during the payroll run, typically through the Element Entry and Formula processing engine. The presence of RESET_GLOBAL_VAR indicates the package maintains session-scoped global state across multiple element-entry invocations within a single payroll process and must be reset between runs. Because it is classified as an OTHER API within ETRM and is referenced by zero other packages, customizations should treat it as an internal implementation dependency rather than a supported extension point. Any modification to BASE_FORMULA or the CAL_FORMULA routines risks affecting statutory deduction compliance and should be validated against federal and state garnishment rules prior to deployment on EBS 12.1.1 or 12.2.2.