Search Results get_fed_prev_ptd_values

Overview

The APPS.HR_US_FF_UDF1 package is a PL/SQL library of user-defined Fast Formula (FF) functions that extends the standard Oracle Payroll Fast Formula function set for United States legislative payroll processing. In Oracle E-Business Suite 12.1.1 and 12.2.2, US payroll calculations frequently require jurisdiction-specific logic that cannot be expressed with seeded Fast Formula functions alone—such as state tax jurisdiction determination, jurisdictional percentage allocation, work-state resolution, and cumulative (period-to-date and year-to-date) balance accumulation across multiple work jurisdictions. HR_US_FF_UDF1 addresses this requirement by exposing callable functions that payroll administrators reference directly within Fast Formula definitions attached to payroll elements and balances.

The package is classified as "OTHER" in the ETRM metadata, indicating it is not a standard public API but rather an internal utility package intended for Fast Formula consumption. It is tightly coupled to the US payroll data model, referencing state tax rules, element classifications, balance feeds, and assignment action records. Notably, it is referenced by three other packages, including PAY_GET_TAX_EXISTS_PKG, which confirms its role as a foundational utility within the US payroll tax calculation chain.

Key Procedures and Functions

The package exposes 28 documented procedures and functions. The following are the most significant, grouped by purpose.

• Earning calculation: CALC_EARNING and NEG_EARNING compute earning amounts, including negative earnings, for use in formula-driven element processing.
• Cumulative balance retrieval: GET_PREV_PTD_VALUES and GET_FED_PREV_PTD_VALUES retrieve prior period-to-date values for a balance, respectively for general and federal tax purposes. GET_JD_TAX_BALANCE returns tax balances at the jurisdiction level.
• Jurisdiction logic: GET_WORK_JURISDICTIONS, GET_IT_WORK_JURISDICTIONS, GET_TAX_JURISDICTION, GET_JURISDICTION_TYPE, GET_WORK_STATE, and JURISDICTION_PROCESSED determine which taxing jurisdictions apply to an assignment and whether a jurisdiction has already been processed within the current payroll run.
• Jurisdictional allocation: GET_JD_PERCENT and GET_IT_JD_PERCENT return jurisdiction percentages, including for interstate (IT) scenarios, supporting proportional allocation of earnings and taxes across multiple states.
• Special-status and threshold flags: GET_EXECUTIVE_STATUS, GET_WC_FLAG (workers' compensation), and GET_JD_LEVEL_THRESHOLD return computed indicators used to gate further formula logic.
• Hours and calendar handling: GET_PERSON_IT_HOURS and GET_JIT_DATA retrieve hours data for interstate calculations, while ACROSS_CALENDAR_YEARS determines whether a computation spans a calendar year boundary.
• Rules retrieval: GET_RS_JD returns jurisdiction-level rules, drawing on state tax rule data.

Tables Accessed

The package reads and writes through APPS synonyms against the following core US payroll tables.

• Payroll run context: PAY_PAYROLL_ACTIONS and PAY_ASSIGNMENT_ACTIONS identify the active payroll run and assignment action, providing the transactional context for calculations.
• Tax rules: PAY_US_EMP_STATE_TAX_RULES_F supplies employee state tax rule definitions used by the jurisdiction and rules-retrieval functions.
• Balances: PAY_DEFINED_BALANCES, PAY_BALANCE_TYPES, PAY_BALANCE_DIMENSIONS, and PAY_BALANCE_FEEDS_F define balance structure, dimensionality, and feed mappings used in PTD/YTD retrieval.
• Element definitions: PAY_ELEMENT_CLASSIFICATIONS, PAY_ELEMENT_LINKS_F, PAY_ELEMENT_ENTRIES_F, and PAY_ELEMENT_ENTRY_VALUES_F provide element classification and entry data that drive earning calculations.
• Organization and flexfield data: HR_ORGANIZATION_INFORMATION and HR_SOFT_CODING_KEYFLEX resolve organization and costing attributes relevant to jurisdiction assignment.
• Fast Formula metadata: FF_USER_ENTITIES stores user-entity definitions consumed by the formula functions.
• Payroll definitions: PAY_ALL_PAYROLLS_F provides payroll-level configuration.

Usage Notes

HR_US_FF_UDF1 is invoked indirectly, not by end users. Payroll administrators reference its functions by name within Fast Formula text (for example, in element input formulas, element skip rules, or balance feed formulas), and the Oracle Fast Formula runtime then binds the call to the PL/SQL function. The package is most relevant to implementations processing multi-state payroll, interstate employees, executive supplemental withholding, or workers' compensation jurisdictions.

Because the package is documented as a private utility rather than a public API, custom code should call it only where necessary and should treat function signatures as subject to change across patch levels. The package status is VALID in both 12.1.1 and 12.2.2, with dependency on standard SYS.STANDARD and PAY_US_EMP_STATE_TAX_RULES_F. When troubleshooting payroll formula errors, the dependency chain—including PAY_GET_TAX_EXISTS_PKG—should be reviewed to confirm that the expected versions are compiled and valid in the APPS schema.