Results for “run_and_ytd_balances”

AI-generated from documented ETRM metadata — verify critical details on the linked pages.

Overview

The APPS.PAY_NZ_SOE_PKG package body is an Oracle E-Business Suite payroll utility that supports the New Zealand Summary of Earnings (SOE) reporting requirement. New Zealand employers are obligated to provide employees with a statement of gross earnings, PAYE tax deducted, and related payroll balances, either on request or at defined points in the employment lifecycle. This package encapsulates the data-retrieval logic needed to assemble such statements directly from the Oracle Payroll data model.

The object resides in the APPS schema with a status of VALID and is classified under the ETRM taxonomy as an OTHER API (that is, not a formally published public API). It is a read-oriented reporting package: it queries payroll run results, balances, element entries, assignment and address data, and formats them for consumption by a concurrent program, Oracle Forms screen, or custom report. It is referenced by three other database objects, indicating that it also serves as a lower-level building block for related New Zealand payroll reporting packages.

Key Procedures and Functions

Ten documented procedures and functions constitute the package interface:

• GET_HOME_ADDRESS — Retrieves the employee's home address details, typically from PER_ADDRESSES, for inclusion on the SOE statement.
• GET_WORK_ADDRESS — Returns the employee's work location address, derived from HR_LOCATIONS and organization information.
• GET_TAX_CODE — Obtains the employee's applicable New Zealand tax code, driven by payroll element entry values.
• GET_SALARY — Returns salary or pay-rate information for the assignment from the pay basis and element structures.
• BALANCE_TOTALS — Aggregates balance-type values for a given assignment for the reporting period.
• BUSINESS_CURRENCY_CODE — Determines the operating business currency, resolving through FND_CURRENCIES, for correct monetary presentation.
• RUN_AND_YTD_BALANCES — Returns both the current payroll run balances and the year-to-date balances, the core figures of the SOE.
• GET_ASG_LATEST_PAY — Identifies the assignment's most recent payroll run and associated payment details.
• GET_DETAILS — Assembles the composite detail record set used by the SOE output, drawing together the individual accessors.
• FINAL_BALANCE_TOTALS — Produces the closing or final balance figures, distinguished from the interim BALANCE_TOTALS results.

Tables Accessed

The package reads from a broad cross-section of Oracle Payroll and HR tables via APPS synonyms. Payroll results are sourced from PAY_RUN_RESULTS and PAY_RUN_RESULT_VALUES, with runs controlled by PAY_PAYROLL_ACTIONS, PAY_ASSIGNMENT_ACTIONS, and PAY_ACTION_INTERLOCKS. Balance definitions and values come from PAY_BALANCE_TYPES and the HR_NZBAL New Zealand balance structures. Element and input value data are read from PAY_ELEMENT_TYPES_F, PAY_ELEMENT_ENTRIES_F, PAY_ELEMENT_ENTRY_VALUES_F, and PAY_INPUT_VALUES_F. Employee and assignment context is supplied by PER_ALL_ASSIGNMENTS_F, PER_ADDRESSES, and PER_PAY_BASES, with PER_TIME_PERIODS defining the reporting windows. Organizational and location data are drawn from HR_ORGANIZATION_UNITS, HR_ORGANIZATION_INFORMATION, and HR_LOCATIONS, while FND_CURRENCIES and FND_TERRITORIES_TL provide currency and territory reference information.

Usage Notes

PAY_NZ_SOE_PKG is typically invoked from New Zealand localizations of the Oracle Payroll module, most commonly behind a concurrent program or Oracle Forms-based SOE request screen that a payroll administrator runs for a selected assignment or payroll period. Because it is not a published API and is classified as OTHER, it should be treated as an internal implementation object: customizations that call it must be validated after any Oracle payroll patch or upgrade, as signature changes are not governed by Oracle's public API compatibility policy.

Developers integrating with this package should access it through the APPS schema or a synonym, and should respect the New Zealand localization context implied by its dependencies (HR_NZBAL and New Zealand territory data). Cross-version behaviour is consistent across EBS 12.1.1 and 12.2.2, with the principal difference being the online patching and editioning model in 12.2.x, which does not alter the package's read-only reporting semantics.