Results for “load_state_taxes”

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

Overview

APPS.PAY_US_OVER_LIMIT_TAX_RPT_PKG is an Oracle EBS Payroll (PAY) package that supports the United States "Over Limit Tax" reporting process. Its purpose is to compute and stage data required to report wages subject to state-level tax limits — specifically the state wage limits tracked on employee state tax rules — so that balances for earnings above those limits can be identified and reported. The package was introduced in 1999 (initial version 110.0) and was substantially rewritten in 2002–2003 (versions 115.6–115.10) to support the new balance reporting architecture (run balances) and multi-threading, addressing bug fix 2938556. It is owned by APPS and classified as OTHER in the ETRM repository.

Key Procedures and Functions

• GET_TAXABLE_BALANCE — Retrieves the taxable balance for an employee's assignment so the report can determine how much of a given earnings or tax balance is exposed to state limits. Historical change notes indicate a PRAGMA RESTRICT_REFERENCES clause was removed from this routine, confirming it queries data and therefore cannot be declared free of database writes.
• GET_STATE_LIMIT — Returns the applicable state wage limit used by the report. This is the routine most directly relevant to the search term "get_state_limit": it resolves the state-level threshold (from the employee's state tax rules) against which taxable balances are compared to identify over-limit amounts.
• LOAD_DATA — Populates the reporting structures used by the concurrent program. Added in version 115.2 (bug 2166701), this procedure gathers and stages the over-limit tax data into the reporting totals table so the report output can be generated; the 115.6 rewrite extended it to use run balances and to support multi-threaded (parallel) execution.

Tables Accessed

The package reads (and, through LOAD_DATA, writes) data across several schemas via APPS synonyms:

• PAY_US_EMP_STATE_TAX_RULES_F — the employee-level state tax rules, including state wage limits; this is the primary source for GET_STATE_LIMIT.
• PAY_US_STATES — the US state definition table, used to resolve state identifiers and related limit attributes.
• PAY_DEFINED_BALANCES, PAY_BALANCE_TYPES, PAY_BALANCE_DIMENSIONS, PAY_BALANCE_FEEDS_F — balance definition and dimension metadata used to identify the correct balance feeds for the new run-balance architecture.
• PAY_PAYROLL_ACTIONS, PAY_ASSIGNMENT_ACTIONS, PAY_ASSIGNMENT_ACTIONS_S — payroll run and assignment action records used to scope balances to specific payroll runs and assignments.
• PAY_US_RPT_TOTALS — the staging/reporting totals table where LOAD_DATA stores computed over-limit amounts.
• HR_ALL_ORGANIZATION_UNITS, HR_ORGANIZATION_INFORMATION, HR_LOCATIONS_ALL, FF_USER_ENTITIES, FF_DATABASE_ITEMS — organization, location, and FastFormula entity metadata used for report grouping and validation.

Usage Notes

PAY_US_OVER_LIMIT_TAX_RPT_PKG is invoked by the US Over Limit Tax report concurrent program: LOAD_DATA gathers and stages the data (typically in a multi-threaded run), and the reporting queries consume the staged rows to produce the output. The package is referenced by one other package in the ETRM metadata, indicating limited but defined internal reuse. Oracle EBS versions 12.1.1 and 12.2.2 share the same source header (pyusoltx.pkh 120.0.12000000.1), so customer-visible behavior is consistent across both releases. Developers should not call these procedures directly from custom code without understanding the run-balance and threading expectations established in version 115.6; the supported entry point is the concurrent program. As with all APPS packages, review is warranted before modification, since the object is covered by Oracle's standard support restrictions.