Results for “pre_tax_redns”

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

Overview

APPS.PAY_US_TAX_BALANCE_PERF is a performance-optimized utility package body in the Oracle E-Business Suite Payroll application, providing an API to retrieve United States tax balance figures. The package originated as a copy of pay_us_tax_bals_pkg but was deliberately restructured to support cheque writer performance requirements, as its header history records. The "PERF" suffix and the naming convention reflect its purpose: delivering tax balance values, particularly Federal Income Tax (FIT) and State Income Tax (SIT) related figures, quickly enough for high-volume cheque printing operations.

The package carries a long modification history spanning 1996 through 2000. It was renamed to comply with Oracle naming standards in May 1996, converted for canonical date compliance in April 1999, and received several pre-tax enhancements through versions 115.4 to 115.7. These enhancements addressed the treatment of gross earnings versus FIT gross, the subtraction of Alien earnings from FIT gross where no dedicated FIT gross balance existed, and the reporting of Alien expatriate pre-tax earnings for 1042-S purposes. A subsequent change reverted certain SIT reduction logic because those reductions were being applied directly by payroll feeds.

Key Procedures and Functions

• US_TAX_BALANCE — The single documented procedure exposed by this package. It returns US tax balance figures for payroll processing, intended for the performance-sensitive cheque writer path. It represents the principal public entry point through which callers obtain FIT/SIT balance amounts.
• LOCAL_ERROR — An internal helper (visible in the source excerpt) that raises a standardized error using the HR message dictionary, setting procedure name and step tokens for diagnostics. It is not part of the documented public API.

Global package-level declarations include array types for balance identifiers and names (g_defbal_tbl_id, g_defbal_tbl_name) and a free-index counter (g_nxt_free_defbal), used to cache or index defined balance records during processing.

Tables Accessed

The package references the following tables through APPS synonyms:

• FF_USER_ENTITIES — The Oracle FastFormula user entity definition table, used to resolve balance and entity identifiers required to interpret tax balance definitions.
• PAY_ASSIGNMENT_ACTIONS — Stores the processed assignment action records for which balances are evaluated, forming the basis of the payroll run context.
• PAY_PAYROLL_ACTIONS — Holds payroll action (run) information, providing the payroll process context needed to scope balance retrieval.
• DUAL — Used for single-row computations and control checks.

Usage Notes

PAY_US_TAX_BALANCE_PERF is not intended for general application development. Its documented consumer is the cheque writer, where retrieving US tax balances efficiently is critical to throughput. It is invoked internally by payroll processing logic rather than through a standard concurrent program request or a Form-level user action. The ETRM metadata records no packages that reference it, indicating it is called from compiled payroll executables or internal Payroll code paths rather than from other PL/SQL packages within the documented schema scope. Custom implementations should avoid depending on this package directly; developers requiring tax balance data should generally use the supported balance APIs instead, reserving this performance variant for its original cheque writer purpose.