Search Results pay_get_tax_exists_pkg




Overview
Explore in AI Chat

Overview

APPS.PAY_GET_TAX_EXISTS_PKG is a PL/SQL package body in the Oracle E-Business Suite (EBS) Payroll (PAY) schema, classified under the "OTHER" API category in the ETRM metadata for releases 12.1.1 and 12.2.2. The package serves as a utility for determining whether a payroll assignment is subject to tax at the federal, state, county, or city level, and for managing the storage and retrieval of related wage accumulation balances during payroll processing. As a non-public, internal utility package, it is invoked primarily by the Oracle Payroll calculation engine and adjacent payroll processes rather than exposed to external integration callers. The documented status is VALID in the APPS schema, and the package is not referenced by any other database object, meaning it is a leaf-level dependency consumed by higher-level payroll logic such as the payroll run and tax calculation routines.

Key Procedures and Functions

The ETRM documentation identifies eleven procedures and functions within the package body, though full parameter signatures are not published. The principal entry points are:

  • GET_TAX_EXISTS — Determines whether a tax record exists for a given assignment and tax context, forming the core logic that gives the package its name.
  • CHECK_TAX_EXISTS — Validates tax existence against the relevant tax rule and information tables prior to payroll tax processing.
  • STORE_PRETAX_REDNS — Persists pretax deduction information so it can be applied during wage accumulation.
  • GET_STORED_BALANCE and RESET_STORED_BALANCE — Retrieve and clear previously stored balance values, supporting repeatable or multi-pass payroll calculations.
  • GET_WAGE_ACCUM_RULE, GET_RES_WAGE_ACCUM_RULE, and GET_WAGE_ACCUMULATION_FLAG — Resolve the wage accumulation rules and flags that govern how earnings are aggregated for tax purposes.
  • GET_PROFILE_VALUE — Reads an Oracle Applications profile option value, typically to drive conditional behavior at runtime.

These procedures collectively support the payroll engine's determination of taxable status and the correct accumulation of wages before taxation.

Tables Accessed

Through APPS synonyms, the package reads and references a set of HRMS and Payroll tables. Tax determination depends on the federal, state, county, and city tax rule and information tables: PAY_US_EMP_FED_TAX_RULES_F, PAY_US_EMP_STATE_TAX_RULES_F, PAY_US_STATES, PAY_US_STATE_TAX_INFO_F, PAY_US_COUNTIES, PAY_US_COUNTY_TAX_INFO_F, and PAY_US_CITY_TAX_INFO_F. Employee and assignment context is drawn from PER_ALL_ASSIGNMENTS_F, PER_ASSIGNMENTS_F, and PER_ADDRESSES. Location and organization data come from HR_LOCATIONS and HR_ORGANIZATION_INFORMATION, with key flexfield and UDF data from HR_SOFT_CODING_KEYFLEX and HR_US_FF_UDF1. Session and security context is derived from FND_SESSIONS and FND_PROFILE, while payroll action context comes from PAY_PAYROLL_ACTIONS and PAY_ACTION_PARAMETERS. HR_UTILITY and PLITBLM provide shared utility and indexing support. These reads inform tax existence checks and wage accumulation without persisting new payroll results directly.

Usage Notes

This package is typically invoked during the Oracle Payroll calculation phase, when the payroll engine must establish whether an assignment is taxable in a given jurisdiction and how pretax deductions affect wage accumulation. It is not exposed as a public API and should not be called directly by custom code unless the caller replicates the payroll driver context (session, assignment, and action parameters) that the package expects. Because it relies on FND_SESSIONS and FND_PROFILE, it requires an active Oracle Applications session. Customizations that need tax existence logic should prefer documented public payroll APIs; direct invocation risks behavior changes across 12.1.1 and 12.2.2 patches. The package's leaf-level dependency status means changes to it propagate only upward into the payroll calculation stack, making it a stable internal utility.