Search Results get_statutory_deductions

Overview

APPS.PAY_CN_SOE is a payroll-adjacent PL/SQL package belonging to the Oracle E-Business Suite HRMS/Payroll module. Its identifier and documented object list identify it as a Canadian statutory reporting and Statement of Earnings (SOE) support package used by the Oracle Payroll application. The package is not an application programming interface in the conventional sense; Oracle classifies it under the "OTHER" API classification, which indicates it is an internal-support package rather than a formally supported public API. Its primary business purpose is to supply the SQL text and data retrieval logic that back the Statement of Earnings and related balance/deduction reporting regions displayed against a payroll assignment action.

The package exposes a suite of LONG-returning functions, each of which builds a SQL statement or query fragment for a specific reporting region. These regions correspond to the taxable and non-taxable earnings, statutory and non-statutory deductions, voluntary deductions, balances, payment methods, and leave information sections of the SOE. Because the functions return LONG (rather than a cursor or a collection), the caller is expected to execute the returned SQL dynamically. This design allows the SOE form and associated reports to construct region content without embedding all of the query logic directly in the form or report definition.

The package is owned by APPS and, per the documented metadata, is referenced by zero other packages, confirming its role as a leaf-level utility consumed by external callers such as Oracle Forms and concurrent program definitions rather than by other PL/SQL packages.

Key Procedures and Functions

The documented interface comprises twelve public functions and procedures, all focused on SOE and statutory reporting regions:

• GET_TAXABLE_EARNINGS — returns SQL for the Taxable Earnings region based on an assignment action identifier.
• GET_NON_TAXABLE_EARNINGS — returns SQL for the Non-Taxable Earnings region.
• GET_STATUTORY_DEDUCTIONS — returns SQL for the Statutory Deductions region.
• GET_NON_STATUTORY_DEDUCTIONS — returns SQL for the Non-Statutory Deductions region.
• GET_VOLUNTARY_DEDUCTIONS — returns SQL for the Voluntary Deductions region.
• GET_BALANCES — returns SQL for the balances reporting region.
• GET_PAYMENT_METHODS — returns SQL for the payment methods region.
• GET_OTHER_ELEMENT_INFORMATION — returns SQL for the "other element information" region, the object referenced by the user's search term.
• GET_OTHER_BALANCE_INFORMATION — returns SQL for the "other balance information" region.
• GET_ANNUAL_LEAVE_INFORMATION — returns SQL for the annual leave information region.
• GET_LEAVE_TAKEN — returns SQL for the leave taken region.
• GET_MESSAGES — returns SQL or content for the informational messages region of the SOE.

The header comments in the source excerpt document the first several functions as public with a single input parameter (p_assignment_action_id) of the type PAY_ASSIGNMENT_ACTIONS.assignment_action_id%TYPE, and a RETURN LONG. This pattern is understood to apply consistently across the region-building functions, since each describes a distinct SOE display region keyed by the assignment action. The exact parameter lists of the remaining functions are not reproduced in the metadata and should not be assumed beyond the documented naming and purpose.

Tables Accessed

The package reads metadata and transactional data through APPS synonyms. The documented tables are:

• PAY_ASSIGNMENT_ACTIONS — the driving table; the input identifier selects the payroll assignment action for which the SOE regions are built.
• PAY_ELEMENT_ENTRIES_F, PAY_ELEMENT_LINKS_F, PAY_ELEMENT_TYPES_F — element entry, link, and type definitions used to categorize earnings and deductions into taxable, non-taxable, statutory, non-statutory, and voluntary groups.
• PAY_PAYROLL_ACTIONS, PAY_ACTION_INTERLOCKS — payroll run and action context used to establish which entries belong to a given payroll action.
• PAY_ACCRUAL_PLANS, PAY_ACCRUAL_PLANS_TL — accrual plan definitions and their translated names, supporting leave-related regions.
• HR_SOFT_CODING_KEYFLEX — key flexfield information used to resolve element reporting or costing context.
• FND_APPLICATION, FND_APPLICATION_TL, FND_PRODUCT_INSTALLATIONS — application and product installation metadata used to validate or filter data by installed application and to obtain translated application names.

These tables support the SOE's need to classify every element entry on the assignment action into the correct reporting region, and to resolve the descriptive names of applications, elements, and accrual plans for display.

Usage Notes

PAY_CN_SOE is an internal package (classification "OTHER") and is not intended as a business-facing API. It is typically invoked by the Oracle Payroll Statement of Earnings form and by associated concurrent programs and reports that render Canadian SOE content. Because the region functions return LONG values containing SQL text, callers must execute that SQL dynamically, which places responsibility for the query context (for example, the correct assignment action) on the invoking forms or report logic.

Customizations should avoid direct calls to this package where a supported alternative exists, since Oracle does not document it as a public API and its internal logic may change between releases. Where the metadata lists zero dependent packages, the only supported consumption path is through the standard SOE forms and reports. Developers extending SOE reporting should treat the returned SQL regions as presentation artifacts and should not alter the underlying element classification logic that determines which entries appear in each region.