Search Results pay_advance_pay_ele_pkg




Overview
Explore in AI Chat

Overview

APPS.PAY_ADVANCE_PAY_ELE_PKG is a PL/SQL package within the Oracle E-Business Suite Payroll (PAY) schema whose responsibility is the creation and management of advance pay element entries. Advance pay is the mechanism by which Oracle Payroll disburses earnings to employees in advance of the payroll period in which those earnings are normally paid; the subsequent regular payroll run then recovers or offsets the advance. This package encapsulates the logic required to build the element entry records that represent a pre-payment, so that downstream payroll processing can accurately account for amounts already issued to the employee.

The package is classified as an OTHER API within Oracle Enterprise Resource Planning Technical Reference Manual (ETRM) metadata and is confirmed VALID in the APPS schema for both release 12.1.1 and 12.2.2. It is not a public, customer-callable business API in the conventional sense; rather it is an internal supporting package used by the payroll advance processing engine and by legislation-specific advance pay packages.

Key Procedures and Functions

ETRM documents a single callable program unit within the package:

  • GET_SUBPRIORITY — Returns a subpriority value associated with an advance pay element. Payroll element processing in Oracle Payroll is governed by processing priority and subpriority, which determine the order in which element entries are resolved during a payroll run. Advance pay elements must be processed in a controlled sequence relative to the elements they offset, and GET_SUBPRIORITY supplies the numeric subpriority that drives this sequencing. The procedure is consumed internally by the advance pay processing logic rather than being exposed directly to end users or customer extensions.

The package body also contains the runtime logic that inserts and maintains advance pay element entries, but ETRM documents no additional individually named public procedures beyond GET_SUBPRIORITY. Parameter lists are not enumerated in the reference metadata and should be confirmed against the deployed package specification for the specific release and patch level.

Tables Accessed

The documented table references are as follows:

  • PAY_ELEMENT_ENTRIES_F — The core element entry table for Oracle Payroll. The package writes advance pay element entries here (and reads existing entries) so that the advance is recognised as a payable element during the payroll run and is subsequently offset against the corresponding regular earnings. Entries are created against the employee's element entry records for the relevant assignment and payroll period.
  • PAY_LEGISLATION_RULES — Holds legislation-specific configuration and business rules. The package consults these rules to determine whether advance pay is permitted and how it must be administered for the employee's legislation, ensuring that the behaviour of the advance processing conforms to the rules defined for the operating country.

Usage Notes

PAY_ADVANCE_PAY_ELE_PKG is an internal dependency of three legislation-specific advance pay packages documented in ETRM:

Each of these packages invokes PAY_ADVANCE_PAY_ELE_PKG to create and manage the underlying element entries, while retaining responsibility for country-specific statutory rules. The package therefore forms the shared technical foundation beneath the legislation layers, ensuring consistent behaviour across supported countries.

Because the package is not exposed as a customer-facing API, it is normally invoked indirectly: through the advance pay functionality driven by the legislation packages, and through payroll run processing that calls those packages. Direct invocation from custom PL/SQL is not recommended. Customisations should be implemented at the legislation package level or through standard element and formula configuration, so that the integrity of the element entry data written by this package is preserved across patch applications and upgrades.