Search Results get_old_payroll_id
Overview
PAY_IE_PAYE_PKG is the Oracle E-Business Suite payroll package that encapsulates the Irish Pay As You Earn (PAYE) tax logic for the Oracle HRMS payroll engine. Its header identifies it as the "IE PAYE package header," and the source file (pyietax.pkh, version 120.5) tracks an evolution from its original creation in June 2001 through a series of statutory and functional enhancements. The package provides the calculation, retrieval, and maintenance routines required to support Irish PAYE, Universal Social Charge (USC), standard rate cut-off, tax credit, and P45/P60 processing within the payroll run.
In Oracle EBS 12.1.1 and 12.2.2 the package is owned by APPS and is classified as an OTHER API in the ETRM repository. It exposes 27 documented procedures and functions, and it is referenced by three other packages, indicating that it acts as a shared utility layer rather than an isolated routine. The business purpose is to centralise Irish tax rules so that payroll processing, statutory reporting, and the Irish SOE (Statement of Earnings) form can draw on consistent, authoritative calculations and data.
Key Procedures and Functions
- GET_PAYE_TAX_BASIS / GET_DIFF_TAX_BASIS / GET_IE_EXCLUDE_TAX_BASIS — retrieve the applicable PAYE tax basis, differential tax basis, and Irish tax-exclusion indicators for a person or assignment.
- GET_PAYE_DETAILS — returns PAYE details; per the change list it was extended to output
p_assess_basisandp_certificate_issue_datefor the SOE form. - GET_USC_DETAILS — returns Universal Social Charge information for the assignment.
- GET_PAYROLL_DETAILS — supplies payroll-level data used by the tax calculation routines.
- GET_CALCULATED_PERIOD_VALUES — calculates tax credits and cut-offs from user-entered values and period types.
- GET_PPS_NUMBER — returns the PPS number; returns 1 where no PPS number exists for the person/assignment or where the emergency tax basis is selected.
- VALID_WORK_INCIDENTS — returns true if the work incident entered on screen exists for the person (added for reference 2943335).
- INSERT_ELEMENT_ENTRY and UPDATE_ELEMENT_ENTRY — create and amend payroll element entries; both were added in July 2003 for reference 3030621. These are the routines most commonly associated with the user search term "insert_element_entry."
- GET_WEEKLY_TAX_CREDIT / GET_WEEKLY_STD_RATE_CUT_OFF / GET_MONTHLY_TAX_CREDIT / GET_MONTHLY_STD_RATE_CUT_OFF — return the weekly and monthly tax credit and standard rate cut-off values added in July 2003.
- UPDATE_PAYE_CHANGE_FREQ — creates a new tax record when the pay frequency changes (reference 4080773); it was subsequently modified to include
P_DATATRACK_UPDATE_MODE. - GET_OLD_PAYROLL_ID / SET_OLD_PAYROLL_ID / UNSET_OLD_PAYROLL_ID — manage session state for the previous payroll identifier used during payroll transfer processing.
- DECODE_VALUE_CHAR — utility routine for decoding a character input value.
Tables Accessed
The package reads and writes a defined set of core HRMS tables through APPS synonyms. PAY_IE_PAYE_DETAILS_F is the primary Irish PAYE detail table for tax basis, credits, cut-offs, and certificate data. Element entry creation and update are performed against PAY_ELEMENT_ENTRIES_F and PAY_ELEMENT_ENTRY_VALUES_F, with supporting lookups in PAY_ELEMENT_LINKS_F, PAY_ELEMENT_TYPES_F, and PAY_INPUT_VALUES_F. Person and assignment context comes from PER_ALL_PEOPLE_F and PER_ALL_ASSIGNMENTS_F, with payroll context from PAY_ALL_PAYROLLS_F, PAY_PAYROLL_ACTIONS, and PER_TIME_PERIODS. USC and social benefit data are held in PAY_IE_SOCIAL_BENEFITS_F. Session and global context are obtained from FND_SESSIONS and FF_GLOBALS_F, and Irish organisation tax information from HR_ORGANIZATION_INFORMATION.
Usage Notes
PAY_IE_PAYE_PKG is normally invoked indirectly by the payroll engine through Irish payroll element fast formulas and by the Irish SOE and PAYE detail forms, which call GET_PAYE_DETAILS, GET_USC_DETAILS, and the weekly/monthly credit and cut-off functions. The INSERT_ELEMENT_ENTRY and UPDATE_ELEMENT_ENTRY procedures are the supported entry points for programmatically creating or amending element entries during Irish tax maintenance and pay-frequency changes. Because it is classified as an OTHER API, customers and integrators should treat it as a supported but internal interface: calling it from custom PL/SQL is permitted where documented, but direct DML against the underlying tables should be avoided. Custom code must supply valid person, assignment, payroll, and period identifiers and should expect the session-based old payroll ID to be set or cleared around transfer processing.