Search Results pay_year_end_extract




Overview
Explore in AI Chat

Overview

The APPS.PAY_YEAR_END_EXTRACT package is a PL/SQL module within the Oracle E-Business Suite Payroll (PAY) application. Its primary business function is to support the year-end processing and statutory reporting obligations for payroll, most notably the extraction of cumulative pay and tax data required for producing year-end documents. In the United Kingdom localization, this corresponds to the production of P45, P60, and related statutory returns that summarize an employee's earnings and deductions for the tax year. The package is documented with the API classification OTHER, indicating it is an internal utility or supporting package rather than a public, supported API, and it carries a VALID status in the APPS schema. It resides alongside and is referenced by the GB-specific year-end control package PAY_GB_EYCTL, which suggests it acts as a lower-level extraction engine invoked by the higher-level year-end control logic.

Key Procedures and Functions

The ETRM metadata documents four procedures or functions within the package: PLOG, TRASH, EXTRACT, and GET_NEAREST_SCON.

  • EXTRACT — The principal procedure of the package, responsible for assembling and materializing the year-end data set. It gathers assignment-level pay, tax, and National Insurance values from the relevant balance and element tables and writes them into the GB year-end staging structures for subsequent reporting.
  • PLOG — A diagnostic logging procedure used to record informational messages, warnings, or debug traces during extraction. This supports troubleshooting of year-end runs, which are typically executed once per tax year and demand careful auditability.
  • TRASH — A housekeeping or cleanup routine that removes or invalidates prior staging or temporary data. It ensures that a re-run of the extraction does not accumulate or double-count stale records from earlier attempts.
  • GET_NEAREST_SCON — A helper function that returns the nearest or most relevant Service Control Object Number (SCON) reference. In the GB year-end context, SCON values trace the source document or submission associated with a given record, enabling correct linkage during extraction.

No parameter lists are documented in the ETRM metadata, and the above descriptions reflect the functional purpose implied by the naming and package context rather than an exposed signature.

Tables Accessed

The package reads and writes a broad set of payroll tables, accessed through APPS synonyms. Core payroll configuration and transactional tables include PAY_ELEMENT_TYPES_F, PAY_ELEMENT_LINKS_F, PAY_ELEMENT_ENTRIES_F, PAY_ELEMENT_ENTRY_VALUES_F, PAY_DEFINED_BALANCES, PAY_BALANCE_TYPES, PAY_BALANCE_DIMENSIONS, and PAY_BALANCE_FEEDS_F, which collectively supply element definitions, captured entries, and balance feed logic. PAY_ASSIGNMENT_ACTIONS and PAY_ACTION_INTERLOCKS provide the payroll action context that determines which results are in scope. HR_ORGANIZATION_INFORMATION and HR_SOFT_CODING_KEYFLEX supply organization and costing details used to attribute extracted values. The GB-specific staging tables PAY_GB_YEAR_END_ASSIGNMENTS, PAY_GB_YEAR_END_PAYROLLS, and PAY_GB_YEAR_END_VALUES are the primary targets into which the extracted year-end results are written for reporting purposes.

Usage Notes

PAY_YEAR_END_EXTRACT is not a user-facing component. It is invoked indirectly through the GB year-end processing framework, principally by the PAY_GB_EYCTL package, which manages the overall year-end control flow. It is therefore typically executed as part of a concurrent program or batch run initiated from the Payroll year-end responsibility, often as a scheduled, once-per-tax-year job. Because it is classified as OTHER and documented as internal, it carries no supported API guarantee; customizations or direct calls should be avoided. Developers diagnosing year-end issues, however, may inspect its execution via the PLOG output. Any custom code interacting with this package should treat it as an implementation detail subject to change across releases.