Results for “pay_nz_rec_pkg”

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

Overview

PAY_NZ_REC_PKG is a PL/SQL package body owned by the APPS schema that supports Oracle Payroll localization functionality for New Zealand. Its name and dependency profile — notably the inclusion of HR_NZBAL and HR_NZ_ROUTES — identify it as a New Zealand-specific reconciliation and balance-retrieval utility. It operates within the Oracle EBS 12.1.1 and 12.2.2 Payroll application, providing arithmetic and lookup services over payroll run results, balance classifications, and payroll action sequencing.

The package is classified as OTHER in ETRM, indicating it is not a public, published API but rather an internal utility supporting the New Zealand payroll engine and reporting. It is valid and self-contained: it references several core Payroll and HR tables but is not referenced by any other database object, meaning it is invoked directly by concurrent programs, forms, or New Zealand localization report logic rather than by other PL/SQL packages.

Key Procedures and Functions

ETRM documents eight procedures and functions, all related to payroll period and balance computation:

• PERIOD_PAYMENT_DATE — resolves the payment date associated with a payroll period, drawing on PER_TIME_PERIODS.
• FIRST_ACTION_SEQUENCE — returns the earliest action sequence number for a payroll action, used to scope processing windows in PAY_ASSIGNMENT_ACTIONS.
• LAST_ACTION_SEQUENCE — returns the latest action sequence number for a payroll action, complementing FIRST_ACTION_SEQUENCE to define the range of assignment actions relevant to a run.
• RESULT_PTD — aggregates or retrieves period-to-date results from PAY_RUN_RESULTS and PAY_RUN_RESULT_VALUES.
• RESULT_YTD — retrieves year-to-date results from the same result and result-value structures.
• SINGLE_FEED_BALANCE — extracts a single balance value using the balance feed definition, tying PAY_BALANCE_FEEDS_F, PAY_BALANCE_TYPES, and PAY_BALANCE_CLASSIFICATIONS together.
• VALUE_PTD — returns the period-to-date value for a single input value, drawing on PAY_INPUT_VALUES_F and PAY_RUN_RESULT_VALUES.
• VALUE_YTD — returns the year-to-date value for a single input value, complementing VALUE_PTD.

Tables Accessed

The package reads and derives data from the following tables via APPS synonyms:

• PAY_RUN_RESULTS and PAY_RUN_RESULT_VALUES — the core store of payroll run output, from which PTD and YTD result values are obtained.
• PAY_BALANCE_TYPES, PAY_BALANCE_FEEDS_F, and PAY_BALANCE_CLASSIFICATIONS — metadata used to resolve balance definitions, feed sources, and classification groupings for SINGLE_FEED_BALANCE and the PTD/YTD value functions.
• PAY_ELEMENT_TYPES_F and PAY_INPUT_VALUES_F — element and input value definitions that determine which inputs are aggregated.
• PAY_ASSIGNMENT_ACTIONS — assignment-level action rows used to establish action sequence boundaries.
• PAY_PAYROLL_ACTIONS — the payroll action context for which sequencing and results are resolved.
• PER_TIME_PERIODS — period definitions used to resolve payment dates.
• PER_ASSIGNMENTS_F — assignment details supporting the value and result functions.
• HR_NZBAL and HR_NZ_ROUTES — New Zealand-specific balance and routing structures that give the package its localization character.

Usage Notes

PAY_NZ_REC_PKG is typically invoked indirectly. Because it is referenced by no other database object, its callers are expected to be New Zealand payroll reports, concurrent programs, or form-level logic that need reconciled PTD/YTD values and single-feed balance lookups. The derived date functions (PERIOD_PAYMENT_DATE) and sequence functions (FIRST/LAST_ACTION_SEQUENCE) support reconciliation by defining the time window and assignment action range against which result and value balances are compared. Custom code that requires the same reconciliation semantics should call these packaged routines rather than re-querying the underlying Payroll tables directly, ensuring consistency with Oracle's New Zealand balance treatment.