Search Results pay_in_eoy_reports




Overview
Explore in AI Chat

Overview

PAY_IN_EOY_REPORTS is an Oracle E-Business Suite PL/SQL package owned by the APPS schema that supports the Indian localization's end-of-year (EOY) statutory reporting requirements. Its principal responsibility is to assemble the data and XML payloads required to render year-end tax and payslip reports, including the generation of addresses and location details used on those reports. The package exposes a small public API of six documented program units, combining low-level XML CLOB management routines with business-specific data extraction routines such as GET_ADDRESS_DETAILS and GET_LOCATION_DETAILS.

The package is classified under API classification OTHER within ETRM, indicating that it is an internal technical utility rather than a formally supported public interface. Its consumers are expected to be Oracle's own localization report components rather than third-party customizations.

Key Procedures and Functions

  • GET_TEMPLATE — Returns the payslip template code associated with a given business group. It is used to resolve which RTF/XML template should be applied when producing the EOY output for a specific legislative context.
  • FETCH_XML — Retrieves the next CLOB available from a package-level global CLOB array. This provides a buffered, sequential read mechanism for the XML documents built up by LOAD_XML and LOAD_XML_BURST.
  • LOAD_XML — Builds a list of XML documents into the global CLOB array. It accepts a business group, assessment year, GRE organization, employee type, and employee number as selection criteria, and returns a count of the CLOBs produced. This is the primary data-assembly entry point for the report.
  • LOAD_XML_BURST — Performs the same conceptual role as LOAD_XML but is oriented toward burst-mode generation, allowing the XML payloads to be produced and dispatched in batches rather than as a single job.
  • GET_LOCATION_DETAILS — Resolves location information used on the EOY report output, typically the employer's or establishment's registered address details.
  • GET_ADDRESS_DETAILS — Returns address details, sourced from the HR address model, that are formatted onto the end-of-year report. This is the procedure most frequently searched for, since it is the address-formatting hook invoked by the localization report generation.

Tables Accessed

The package reads from a broad set of HR and Payroll tables through APPS synonyms. Address and location resolution relies on PER_ADDRESSES, HR_ALL_ORGANIZATION_UNITS, and HR_ORGANIZATION_INFORMATION, with FF_GLOBALS_F supplying legislative/global context. Payroll processing and balance data come from PAY_ASSIGNMENT_ACTIONS, PAY_ACTION_INFORMATION, PAY_ACTION_INTERLOCKS, PAY_ELEMENT_ENTRIES_F, PAY_ELEMENT_ENTRY_VALUES_F, PAY_ELEMENT_LINKS_F, PAY_ELEMENT_TYPES_F, PAY_INPUT_VALUES_F, PAY_DEFINED_BALANCES, PAY_BALANCE_TYPES, and PAY_BALANCE_DIMENSIONS. Together these provide the element entry, input value, and balance information needed to compute and report year-end tax figures.

Usage Notes

PAY_IN_EOY_REPORTS is invoked indirectly through Oracle's Indian end-of-year report concurrent programs and associated report definitions rather than through direct user-facing forms. A typical execution sequence calls LOAD_XML (or LOAD_XML_BURST) to populate the global CLOB array, after which FETCH_XML is called repeatedly to retrieve each generated XML document for rendering. GET_TEMPLATE determines the applicable template, while GET_ADDRESS_DETAILS and GET_LOCATION_DETAILS supply the formatted address blocks embedded in the output.

Because the package is classified as OTHER and is referenced by no other documented packages, it should be regarded as internal to the localization feature. Custom code that calls it directly must account for the dependency on package-level global state, the NOCOPY OUT parameters used for CLOB handling, and the fact that behaviour is not guaranteed across point releases.