Search Results get_nonw2_bal




Overview
Explore in AI Chat

Overview

APPS.PQP_US_FF_FUNCTIONS is a United States legislative and payroll tax helper package within the Oracle E-Business Suite Payroll (PQP) module. It exists to support Oracle Payroll's US-specific statutory requirements, particularly those relating to alien tax withholding, tax treaty eligibility, state reciprocity and treaty honoring rules, Windstar/Non-W2 payment processing, and the derivation of balance values used by payroll and tax calculations. The package is defined with AUTHID CURRENT_USER, meaning its SQL executes under the privileges of the invoking schema — a common design in Oracle Payroll packages that must resolve APPS synonyms at runtime.

Because EBS payroll tax calculations demand both current-period values and historical balances, this package bridges functional payroll data (assignments, element entries, balances) with legislative rule data (state rules, alien state treaties). It is registered in ETRM with an API classification of OTHER, indicating that it is an internal utility package rather than a published public API for customer extension.

Key Procedures and Functions

The documented package exposes eleven procedures and functions. Each serves a discrete payroll-tax purpose:

  • GET_COL_VAL — Retrieves a column value from payroll-related data for a given assignment and payroll action, filtered by column name and income code. It is a generic value-lookup utility used to resolve context-specific figures.
  • STATE_HONORS_TREATY — Determines whether a given state honors a tax treaty, based on the payroll action, element input value jurisdiction code, and an override state location.
  • ALIEN_TREATY_VALID — Validates whether an alien tax treaty applies to a particular assignment, payroll action, and income code.
  • GET_ALIEN_BAL — The function targeted by the user's search. It returns a numeric balance value related to alien tax withholding. Its parameters include assignment ID, effective date, payroll action ID, tax unit ID, income code, balance name, dimension name, state code, and a FIT withholding balance flag; most are optional with defaults, allowing callers to retrieve a balance by name, dimension, or state context.
  • IS_WINDSTAR and PQP_IS_WINDSTAR — Related checks that determine whether a payment is a Windstar (Non-W2) payment subject to special reporting rules.
  • GET_NONW2_BAL and GET_TRR_NONW2_BAL — Retrieve Non-W2 balance amounts (including TRR-specific values) used in Non-W2 reporting.
  • GET_PREV_CONTRIB — Returns a previous contribution amount, typically for retirement or benefit contribution comparison.
  • PQP_PROCESS_EVENTS_EXIST — Checks whether payroll process events exist for a given context.
  • PQP_ALIEN_TAX_ELE_EXIST — Checks whether alien tax elements exist for an assignment.

Tables Accessed

The package reads and writes a broad set of APPS-synonymed tables. Assignment data comes from PER_ALL_ASSIGNMENTS_F and related person data from PER_PEOPLE_EXTRA_INFO. Balance and balance-type metadata are drawn from PAY_BALANCE_TYPES, PAY_DEFINED_BALANCES, PAY_BALANCE_DIMENSIONS, and PAY_ELEMENT_CLASSIFICATIONS. Element configuration is read from PAY_ELEMENT_TYPES_F, PAY_ELEMENT_LINKS_F, and PAY_ELEMENT_ENTRIES_F. Legislative and treaty rules are obtained from PQP_ALIEN_STATE_TREATIES_F and PAY_STATE_RULES. Process event checks use PAY_PROCESS_EVENTS. Soft coding and DUAL are also referenced.

Usage Notes

PQP_US_FF_FUNCTIONS is invoked primarily from Oracle Payroll's fast formulas, payroll run processes, and legislative tax routines rather than from end-user forms. It is referenced by four other packages, confirming its role as an internal dependency. Custom code invoking these functions, particularly GET_ALIEN_BAL, must respect the AUTHID CURRENT_USER context and supply a valid effective date and assignment ID; because many parameters default to NULL, callers should ensure that omitted values do not inadvertently broaden the balance lookup. Customers extending US payroll logic should treat this package as reference documentation rather than as a supported extension point.