Search Results pay_es_advance_pay




Overview

The APPS.PAY_ES_ADVANCE_PAY package is a Spanish localizations utility within the Oracle E-Business Suite Payroll (PAY) module. Its role is to supply rule logic that determines whether an employee's advance payment should be skipped during a payroll run. Advance payments are installments paid to employees ahead of or between regular payroll cycles; statutory and business rules in Spain occasionally require certain periods or individuals to be excluded from an advance cycle. This package encapsulates that decision logic as a single callable function, allowing the payroll engine to query the skip condition without embedding the rule directly in element or formula definitions.

The package is declared AUTHID CURRENT_USER, meaning that it executes with the privileges of the invoking database user rather than the package owner. In an Oracle EBS environment this is significant because it allows the package to respect the caller's security context and session settings. The package is classified under the ETRM API classification OTHER, indicating that it is not a public, supported integration API (such as a PL/SQL business API) but rather an internal localization routine used by the payroll processing flow.

Key Procedures and Functions

The ETRM metadata documents one callable routine:

  • ADV_PAYMENT_SKIP_RULE — a FUNCTION returning VARCHAR2. Based on documented metadata it accepts a payroll element entry identifier (p_element_entry_id), a date earned (p_date_earned), and a payroll action identifier (p_payroll_action_id). The function evaluates the advance payment skip condition for the given element entry within the context of a specific payroll action and returns a VARCHAR2 result that the payroll engine interprets as a skip indicator.

No additional procedures or functions are documented in the ETRM metadata for this package. The package is therefore narrow in scope, containing only this single rule evaluation entry point.

Tables Accessed

The ETRM metadata identifies two underlying tables accessed through APPS synonyms:

  • PAY_ELEMENT_ENTRIES_F — the element entries table that stores the assignments of elements (such as advance payment elements) to employee assignment records. The package reads this table to resolve the element entry passed as p_element_entry_id and to retrieve its associated attributes needed for the skip decision.
  • PAY_PAYROLL_ACTIONS — the table holding the payroll action (run) header, including the effective dates and processing parameters that define a specific payroll cycle. The package reads this table to interpret the p_payroll_action_id context, ensuring the skip rule is evaluated against the correct advance payment run.

Together these tables provide the minimum data needed to associate an element entry with a payroll advance cycle and decide whether the advance should be suppressed.

Usage Notes

Because PAY_ES_ADVANCE_PAY is not referenced by any other documented package (the metadata records zero dependent packages), it is invoked directly by payroll processing components, such as element skip rules, formula functions, or localization routines that call the function during the element entry processing phase of a payroll run. The function will typically be triggered when the payroll engine evaluates whether an advance element entry should be processed in a given action.

Typical invocation scenarios include:

  • Spanish payroll localizations where advance payment elements define a skip rule that delegates to this function.
  • Concurrent payroll runs and quickpay processes that execute the advance payment processing path for the Spain legal employer.
  • Custom PL/SQL code or formula wrappers that need to reproduce the Spanish advance skip logic outside the standard processing path.

Administrators and developers should treat this package as an internal localization component rather than a supported public API. Given that it is declared AUTHID CURRENT_USER, callers must ensure that the invoking session has appropriate access to PAY_ELEMENT_ENTRIES_F and PAY_PAYROLL_ACTIONS via the APPS synonym layer. Since the ETRM metadata documents only one function and two tables, any additional behavior assumed beyond this scope should be verified against the live source code in the specific EBS release (12.1.1 or 12.2.2) being deployed.