Search Results pay_ie_advance_pay




Overview

PAY_IE_ADVANCE_PAY is an Oracle E-Business Suite PL/SQL package owned by the APPS schema and is specific to the Irish (IE) localisation of Oracle Payroll. Its purpose is to support the processing of advance payments within the Irish payroll cycle, most notably by determining the circumstances under which an employee's advance payment should be skipped or withheld during a payroll run. The package is classified in the ETRM as an "OTHER" API, indicating that it is not a formally published public API but rather an internal supporting package that supplements the standard payroll engine behaviour for Irish legislation requirements.

The package is registered as VALID in both Oracle EBS 12.1.1 and 12.2.2, and in the documented metadata it exposes a single documented procedure or function, ADV_PAYMENT_SKIP_RULE. Its dependency footprint is intentionally narrow, referencing only SYS.STANDARD and a small number of payroll data structures through APPS synonyms, which reflects the focused, rule-based nature of its role within the payroll calculation engine.

Key Procedures and Functions

The ETRM documentation records one documented program unit within this package:

  • ADV_PAYMENT_SKIP_RULE — This routine encapsulates the Irish statutory business rule that governs whether an advance payment should be skipped during a given payroll period. In the context of Oracle Payroll's element processing, advance payments are typically recovered or offset against regular earnings, and legislative or company rules may require that the advance be skipped under certain conditions (for example, where insufficient net pay exists, where a specific element entry state applies, or where the payroll action for the period dictates that no advance be taken). The procedure evaluates the relevant conditions against the current employee's payroll data and signals to the calling payroll engine whether the advance payment element should be processed or bypassed.

No parameter lists are published in the ETRM metadata, and consumers should treat the calling convention as internal to the Irish payroll solution rather than as a documented integration point.

Tables Accessed

The package accesses the following tables through APPS synonyms:

  • PAY_ELEMENT_ENTRIES_F — This is the core datastore for element entries associated with an employee's assignment. The package reads entries from this table to identify the advance payment element and its current state (such as entry value, effective dates, and processing flags) in order to apply the skip rule.
  • PAY_PAYROLL_ACTIONS — This table records each payroll action (payroll run, reversal, quick pay, and so on) performed within the system. The package references it to establish the payroll action context in which the advance payment is being evaluated, ensuring that the skip rule is applied only in the appropriate action type or status.

These are read-oriented references used for rule evaluation rather than for direct maintenance of the payroll results.

Usage Notes

PAY_IE_ADVANCE_PAY is an internal localisation component and is not intended for direct invocation by end users. It is invoked indirectly:

  • By the Oracle Payroll calculation engine during the payroll run, when processing the Irish advance payment element and its associated skip rule.
  • Potentially through payroll element configuration, where the skip rule is attached as part of the element's processing logic for the Irish legislation.
  • Not through standard Oracle EBS forms or concurrent programs exposed to the user; no concurrent program or form is documented as directly calling this package.

The ETRM reports that the package is referenced by zero other packages and is not exposed as a published API. Customisations or extensions for Irish advance payments should therefore avoid calling ADV_PAYMENT_SKIP_RULE directly and should instead work through the standard payroll element framework. Any modification to this package carries a high risk because it participates in statutory payroll processing and is validated as part of the Irish localisation.