Search Results reset_stored_balance

Overview

The APPS.PAY_GET_TAX_EXISTS_PKG package is a payroll tax utility within the Oracle E-Business Suite Payroll (PAY) module. Its principal business purpose is to determine whether a given tax exists for an employee assignment, jurisdiction, tax unit, and payroll action context, so that downstream payroll processing can decide which tax rules, balances, and pretax reductions must be applied. The package centralizes tax existence validation and pretax reduction storage logic, exposing a set of reusable PL/SQL functions and procedures that other payroll packages and tax calculation routines can call. It is defined with AUTHID CURRENT_USER, meaning it executes with the privileges of the invoking user rather than as the defining APPS user, which is significant for how synonym resolution and security are handled.

In addition to tax existence checks, the package supports wage accumulation rule lookup and the storage and retrieval of pretax deduction balances. This makes it a supporting component for the broader payroll tax engine used to compute taxable wages, subject wages, and applicable employee tax deductions.

Key Procedures and Functions

The documented callable units total eleven and address several related responsibilities:

• GET_TAX_EXISTS — The primary function associated with the user search term "get_tax_exists." It returns a VARCHAR2 value indicating whether a tax exists for a specified jurisdiction, date earned, tax unit, assignment, and tax type. It determines whether tax processing should proceed for the given context.
• CHECK_TAX_EXISTS — A related validation routine that performs a comparable tax existence check, likely used internally or as an alternate entry point.
• STORE_PRETAX_REDNS — Stores pretax reduction amounts for categories such as 125, 401, 403, 457, dependent care, and other pretax reductions, adjusting gross and subject-wage values passed in as IN OUT parameters.
• GET_STORED_BALANCE — Retrieves a previously stored balance amount for a jurisdiction, balance name, and location.
• RESET_STORED_BALANCE — Clears the stored balance entry identified by jurisdiction, balance name, and location.
• GET_WAGE_ACCUM_RULE — Returns the wage accumulation rule applicable to a jurisdiction, date earned, tax unit, assignment, payroll action, type, and wage accumulation.
• GET_RES_WAGE_ACCUM_RULE — Returns the resident wage accumulation rule for the given context.
• GET_WAGE_ACCUMULATION_FLAG — Returns a flag indicating the wage accumulation setting for a payroll action.
• GET_PROFILE_VALUE — Retrieves a system profile option value used to govern payroll tax behavior.

The package also declares a balance_record record type and a balance_table associative array type, which are used internally to hold jurisdiction, location, balance name, and amount data.

Tables Accessed

The package reads from and writes to several payroll, HR, and foundation tables through APPS synonyms. Tax existence and rule determination rely on the tax information tables PAY_US_CITY_TAX_INFO_F, PAY_US_COUNTY_TAX_INFO_F, PAY_US_STATE_TAX_INFO_F, PAY_US_EMP_FED_TAX_RULES_F, and PAY_US_EMP_STATE_TAX_RULES_F, together with the geographic reference tables PAY_US_STATES, PAY_US_COUNTIES, and PER_ADDRESSES. Assignment context is resolved through PER_ALL_ASSIGNMENTS_F, while payroll action context comes from PAY_PAYROLL_ACTIONS. Organization and key flexfield data are drawn from HR_ORGANIZATION_INFORMATION and HR_SOFT_CODING_KEYFLEX. The FND_SESSIONS table is referenced for session context, and PLITBLM is a standard PL/SQL index-by table utility object.

Usage Notes

PAY_GET_TAX_EXISTS_PKG is typically invoked from payroll tax calculation routines and related PL/SQL packages rather than directly by end users. The metadata indicates it is referenced by three other packages, confirming its role as a shared dependency within the payroll tax execution path. It may be called during payroll run processing when the tax engine must verify whether a tax applies for an assignment before computing deductions or subject wages. Customizations that extend payroll tax logic should call GET_TAX_EXISTS and the wage accumulation functions rather than duplicating tax existence logic, ensuring consistency with seeded rules. Because the package is defined with AUTHID CURRENT_USER, callers must ensure appropriate synonyms and privileges are in place. Its behavior depends on valid session, assignment, and payroll action context, so it should be invoked within an active payroll processing session.