Search Results get_final_xml

Overview

PAY_CA_T4A_XML is an Oracle E-Business Suite PL/SQL package owned by the APPS schema that generates the Canadian T4A (Statement of Pension, Retirement, Annuity, and Other Income) tax slip in XML format. The T4A slip is a statutory Canadian Revenue Agency (CRA) filing requirement, and this package is the technical component that assembles the structured electronic file that the CRA accepts for tax reporting. The package was created in 2009 and subsequently modified between 2010 and 2012 to support the online retrieval of finalized T4A XML.

Under Oracle EBS 12.1.1 and 12.2.2, the package is classified as an OTHER API rather than a standard public interface. It is invoked internally by the Canadian payroll tax-reporting flow rather than being documented as a customer-facing integration API. Its design reflects the multi-version document format required by CRA, including a version marker ("Version 1.1") and a structured envelope composed of header, assignment (employee), and trailer blocks.

Key Procedures and Functions

Seven documented procedures and functions are exposed:

• GET_FINAL_XML — Added in version 115.3 (June 2012), this function returns the completed T4A XML document as a BLOB for a given assignment action. It is the entry point used by the online (forms-based) request path, returning the assembled XML stream directly to the caller.
• FETCH_T4A_XML — Also added in version 115.3, this procedure populates an output BLOB with the T4A XML for a specified assignment action and payroll action context, accepting control parameters for print behaviour and caller origin.
• STORE_OTHER_INFORMATION — Caches additional income code and amount pairs (for example, pension or other income boxes) keyed to the assignment action, introduced under bug fix 6456662.
• GET_OTHER_INFORMATION — Retrieves a previously stored "other information" entry by index, returning the code and amount to the caller.
• GET_ASG_XML, GET_HEADER_XML, GET_TRAILER_XML — Component builders that emit the employee-level, header, and trailer XML fragments respectively. These are called internally to assemble the final document.

Tables Accessed

The package reads and writes across payroll, HR, and FastFormula data structures:

• PAY_ASSIGNMENT_ACTIONS and PAY_PAYROLL_ACTIONS — provide the assignment action and payroll action context that drive which T4A slip is generated.
• PER_ALL_ASSIGNMENTS_F and PER_ALL_PEOPLE_F — supply employee assignment and personal details.
• HR_ALL_ORGANIZATION_UNITS and HR_LOCATIONS_ALL — provide employer/legal entity and location data for the slip header.
• PAY_ACTION_INFORMATION — holds the calculated balance values (earnings, deductions, and T4A box amounts).
• FF_ARCHIVE_ITEMS, FF_DATABASE_ITEMS, and PLITBLM — support FastFormula-based value retrieval and the persistence of other-information records.
• DBMS_LOB and UTL_RAW — used for BLOB assembly and conversion of the XML output.

These tables are referenced through APPS synonyms in line with standard EBS coding practice.

Usage Notes

PAY_CA_T4A_XML is not called from a public API. It is invoked in two principal ways: through the online Canadian T4A form flow, where GET_FINAL_XML provides the XML to the request, and through concurrent-program processing of the T4A extract, where FETCH_T4A_XML performs the BLOB assembly. Because it is classified as OTHER and is referenced by zero other packages, custom code should avoid depending on its internal procedures, as the interface is subject to change across patch levels. Integration requirements should instead target the standard Canadian payroll year-end concurrent programs that call this package on the application's behalf.