Search Results pay_mx_soe_ss_pkg




Overview
Explore in AI Chat

Overview

APPS.PAY_MX_SOE_SS_PKG is a Mexico-specific payroll reporting package within the Oracle E-Business Suite Payroll (PAY) module. Its documented purpose, stated in the package header, is to produce the Statement of Earnings (SOE) — referred to in the source comment as "SS SOE for Mexico." The prefix "SS" denotes the social security oriented variant of the statement of earnings output, and the "MX" country code confirms the localization scope. The package encapsulates the PL/SQL logic needed to assemble the earnings, tax, deduction, and balance information that appears on the Mexican statutory statement of earnings. Because the object is classified as OTHER in the ETRM repository rather than as a public API, it is intended for internal consumption by the Mexican localization reporting layer rather than as a general-purpose integration point. The package was created in 2004 and carries the version header paymxsoe.pkh 120.0, indicating it belongs to the 12.x code line and is present in both 12.1.1 and 12.2.2 environments where the Mexican localization is installed.

Key Procedures and Functions

The documented callable units are predominantly functions that each return a LONG value, consistent with the pattern of accumulating a large contiguous block of formatted report text or XML fragment for a single assignment action. All functions are driven by an assignment action identifier, which anchors the output to one payroll run result for one assignment.

  • EMPLOYEE_EARNINGS — Returns the statement-of-earnings detail for an employee's earnings elements.
  • EMPLOYEE_TAXES — Returns the employee-level tax withholding detail for the statement.
  • TAX_CALC_DETAILS — Returns the supporting calculation detail behind the tax amounts, providing the audit trail required by Mexican reporting conventions.
  • SUMMARY_BALANCES — Returns the summarized balance section of the statement. The source change list records modifications to this function to widen the curr_val and ytd_val fields to varchar2(15), and defines a summ_bal record type carrying balance name, reporting name, and current definition balance identifier.
  • HOURLY_EARNINGS — Returns earnings detail for hourly-paid employees, added in version 115.1.
  • TAXABLE_BENEFITS — Returns the taxable benefit components included in the statement.
  • TAX_BALANCES — Returns tax-related balance figures for the period and year to date.
  • DEDUCTIONS — Returns the deduction detail applied to the assignment action.
  • OTHER_BALANCES — Returns balances that fall outside the earnings, tax, and deduction categories.
  • SETPARAMETERS — Added in version 115.3, this routine initializes the package-level parameters used by the reporting functions before the statement sections are generated.

Tables Accessed

The package reads core Oracle Payroll tables through APPS synonyms. PAY_ASSIGNMENT_ACTIONS and PAY_PAYROLL_ACTIONS supply the assignment action and payroll action context for the requested run. PAY_ACTION_INTERLOCKS provides the processing context linking the action to its run. PAY_RUN_TYPES_F supplies run type definition and classification information used to interpret the results being reported. PLITBLM is the standard Oracle Payroll PL/SQL table used for passing collections of values between payroll routines. The documented statement indicates read-only usage; no inserts or updates are described in the metadata.

Usage Notes

Given its structure — a set of LONG-returning functions keyed to an assignment action plus a parameter-setting routine — the package is most plausibly invoked from the Mexican statement of earnings report, typically an Oracle Reports or BI Publisher output driven by a concurrent program, with SETPARAMETERS called first to establish globals for the run. It may also be called from a payroll form via the statement-of-earnings drill-down. Because the ETRM metadata records zero packages referencing it, it sits at the outer edge of the dependency chain and is not intended as a building block for other PL/SQL APIs. Customizations should treat it as a localization-internal object: it is unsupported for direct external calls, and its LONG return type makes it awkward to consume from SQL. Implementations on 12.1.1 and 12.2.2 should expect identical behavior, as no 12.2-specific change is documented.