Search Results pay_ie_paye_api




Overview

PAY_IE_PAYE_API is an Oracle EBS 12.1.1 / 12.2.2 application programming interface package owned by the APPS schema and classified in the ETRM repository as a PL/SQL API. It supports the Irish statutory payroll requirement to calculate, record, and report Pay As You Earn (PAYE) deductions for employees. PAYE is the Irish income tax withholding mechanism operated through the Revenue Commissioners, so this package is the technical bridge between Oracle Payroll processing and the country-specific PAYE data structures that hold taxable pay, tax credits, standard rate cut-off points, and the resulting PAYE liability.

The package encapsulates the maintenance of Irish PAYE detail rows, exposing them for use by payroll and tax validation logic rather than requiring callers to manipulate the underlying tables directly. Its dependency profile confirms the package is referenced by PAY_IE_PAYE_PKG and PAY_IE_TAX_VAL, and indirectly by itself, indicating that it sits within a small cluster of Irish payroll objects and is the lower-level entry point for PAYE detail maintenance.

Key Procedures and Functions

Three API procedures are documented for this package:

  • CREATE_IE_PAYE_DETAILS — Creates Irish PAYE detail records for the relevant payroll context. It is the insertion point for new PAYE data produced during payroll processing, establishing the taxable pay and tax calculation basis for an employee.
  • UPDATE_IE_PAYE_DETAILS — Modifies existing Irish PAYE detail records, allowing corrections, recalculations, or adjustments to reflect changes in taxable pay, credits, or cut-off values.
  • DELETE_IE_PAYE_DETAILS — Removes Irish PAYE detail records, used when a payroll run, assignment, or PAYE calculation must be reversed or cleaned up before reprocessing.

Each procedure operates on the PAYE detail entity and follows Oracle's standard API conventions of routing all DML through controlled interfaces. Parameter lists are intentionally not reproduced here; callers should confirm signatures against the installed package specification for their exact release and patch level.

Tables Accessed

The package references the following tables through APPS synonyms:

Usage Notes

PAY_IE_PAYE_API is typically invoked from Irish payroll processing logic, most directly from PAY_IE_PAYE_PKG, and from tax validation routines in PAY_IE_TAX_VAL. It is not generally called interactively from a form; instead it executes as part of payroll run processing, pre-payments validation, or balance adjustment workflows.

Custom code should call these procedures rather than inserting into PAY_IE_PAYE_DETAILS_F directly, so that Oracle's validation and derivation logic is preserved. The package status is VALID, confirming it is compiled and installed. Because the ETRM metadata does not expose parameter lists or return types, developers integrating with this API should inspect the package specification directly and perform thorough testing, particularly around idempotency of create and delete calls during payroll reruns and reversals.