Search Results pay_us_w2_generic_extract




Overview
Explore in AI Chat

Overview

PAY_US_W2_GENERIC_EXTRACT is an Oracle Applications (APPS) PL/SQL package that supports the YearEnd Generic Interface Extract Process for United States payroll reporting. Its principal business function is to read archived year-end payroll data, validate that data, and construct XML elements suitable for downstream W-2 and related federal/state tax reporting interfaces. The package was created on 08-Nov-2006 by user ppanda at version 115.0, and the header file payusw2genxtract.pkh carries the identifier 120.0.12010000.1 (dated 2008/07/27), placing it within the standard EBS 12.1.1 and 12.2.2 code lines.

The package declares global and record-level PL/SQL structures used to hold archived employee data during extraction. The fed_employee_record record type, for example, stores archival values such as assignment action, tax year, tax unit, assignment and employee numbers, Social Security Number, employee name components, and both domestic and foreign address fields. This record-oriented design allows the extract process to assemble a complete employee image before serializing it into XML.

Key Procedures and Functions

The package exposes seven documented components. Each is described below by purpose; parameter lists are not published in the available metadata and are therefore not asserted here.

  • POPULATE_ARCH_EMPLOYEE — Gathers archived employee-level data (identifiers, name, SSN, address) for inclusion in the extract output.
  • POPULATE_ARCH_EMPLOYER — Collects archived employer-level information, typically the employing entity's identification and address details required on year-end forms.
  • POPULATE_ARCH_TRANSMITTER — Assembles transmitter data used in electronic filing headers and submission records.
  • POPULATE_EE_DATA_TAG — Constructs the XML element (tag) representing the employee data segment.
  • POPULATE_RA_DATA_TAG — Constructs the XML element representing the record-agent or reporting-agent data segment.
  • POPULATE_RE_DATA_TAG — Constructs the XML element representing the recipient/employer reporting entity segment.
  • CONVERT_SPECIAL_CHAR — Converts or escapes special characters so that generated XML remains well-formed and valid for the target filing format.

Tables Accessed

The package references these tables through APPS synonyms:

Usage Notes

This package is classified as OTHER rather than a public API, indicating it is an internal component invoked by the YearEnd Generic Interface Extract Process rather than called directly by customer code. It is typically executed through the corresponding YearEnd concurrent program (or a related extraction request) during year-end W-2 processing, and it is referenced by one other package within the payroll application suite.

For the user scenario "how to get W-2 from an old job," this package is the underlying engine that produces and validates the archived W-2 extract data. Individuals cannot query it directly; former employees obtain historical W-2 copies through their employer or payroll provider, or via the archived year-end extract performed by the responsible payroll administrator using this YearEnd extraction process. In EBS 12.1.1 and 12.2.2 the package remains an APPS-owned, non-API utility, so changes to it fall under standard Oracle support and patching rather than customer customization.