Results for “sta_information”

AI-generated from documented ETRM metadata — verify critical details on the linked pages.

Overview

PAY_US_PAYROLL_UTILS is a shared PL/SQL utility package in the APPS schema that consolidates the common routines used throughout Oracle Payroll for United States legislation. Its source header (pyusutil.pkh) and change history confirm that the package was created in April 2003 and has been maintained continuously to support US-specific payroll processing, tax validation, balance interrogation, and report formatting. In an Oracle EBS 12.1.1 or 12.2.2 environment, the package acts as a central library rather than a business transaction processor: other payroll packages, concurrent programs, and report definitions call into it to avoid duplicating logic for jurisdiction tax checks, balance lookups, session and security context retrieval, and output formatting.

The naming convention and the documented entry points indicate that the package is deeply tied to US payroll tax handling (federal, state, county, and city), to the earning and deduction balance infrastructure, and to user-facing reporting output. Because it is classified as an OTHER API and is referenced by 31 other packages, it should be treated as internal infrastructure that supports higher-level payroll flows rather than as a standalone integration point.

Key Procedures and Functions

• POPULATE_JIT_INFORMATION — Populates jurisdiction (JIT) tax information, including the city tax handling added in version 115.1. It is used to assemble the tax jurisdiction context required during payroll processing.
• GET_TAX_EXISTS — Determines whether a given tax exists for a jurisdiction. The function was overloaded in version 115.2 and enhanced in 115.3 to check for county and city taxes in addition to the original scope.
• CHECK_BALANCE_STATUS — Evaluates the status of a payroll balance. Version 115.7 added a p_legislation_code parameter, making the routine aware of the applicable legislation when assessing balances.
• FORMATED_HEADER_STRING — Produces formatted header text used by reports rendered in HTML and CSV output formats (added in version 115.5).
• FORMATED_DATA_STRING — Produces formatted data row text for the same HTML and CSV reports.
• GET_PARAMETER — Retrieves a parameter value; added to the package in version 115.8 to provide a reusable parameter lookup facility.
• SSN_REPORTING_PREFERENCES — Returns Social Security Number reporting preferences, supporting masking and reporting rules for US statutory output.
• GET_MIN_ACTION — Returns the minimum action reference associated with a payroll action, used to locate the earliest relevant assignment action.
• UPDATE_STATE_OR_LOCAL_WH_LINK — Maintains the link between state or local withholding tax records, supporting withholding setup and correction.

Tables Accessed

The package reads and writes through APPS synonyms across several payroll and foundation areas. Tax and balance logic depends on PAY_BALANCE_TYPES, PAY_BALANCE_DIMENSIONS, PAY_BALANCE_ATTRIBUTES, PAY_BALANCE_VALIDATION, and PAY_DEFINED_BALANCES. Payroll action context is drawn from PAY_ASSIGNMENT_ACTIONS and FF_USER_ENTITIES. Jurisdiction and location data come from HR_LOCATION_EXTRA_INFO and HR_ORGANIZATION_INFORMATION. Application and lookup configuration is read from FND_APPLICATION, FND_LOOKUP_TYPES, and FND_LOOKUP_VALUES, while session, user, and security context are obtained from FND_SESSIONS, FND_USER, and FND_SECURITY_GROUPS.

Usage Notes

PAY_US_PAYROLL_UTILS is invoked indirectly by standard payroll concurrent programs, payroll report definitions (particularly HTML and CSV formatted reports), and by the 31 packages that reference it. Because it is not a public API with a stable external contract, customizations and extensions should not call it directly without assessing upgrade impact. Developers investigating payroll tax or balance behaviour in 12.1.1 or 12.2.2 can trace the callers of these routines to locate the legitimate point at which US payroll tax and balance determinations are performed.