Search Results reg_employer




Overview
Explore in AI Chat

Overview

APPS.PAY_NZ_EFT is a legislation-specific PL/SQL package body that supports Electronic Funds Transfer (EFT) direct credit processing for New Zealand payroll in Oracle E-Business Suite 12.1.1 and 12.2.2. The package encapsulates the logic required to format and augment payment data produced by Oracle Payroll for New Zealand employees paid by direct credit. Its primary role is to enrich the XML file generated for the New Zealand Direct Credit payment format with legislatively and institutionally required tags, and to expose lookup logic used during XML generation.

The package is owned by APPS and classified as OTHER in the ETRM repository, indicating it is not a public documented API but an internal implementation unit. The package body carries a header comment dated November 1999 ("Big bang"), with subsequent corrections and enhancements. The most significant functional change was delivered in October 2008 under reference 6891410, described as the New Zealand Direct Credit Enhancement, which introduced the add_custom_xml procedure. A further change in December 2008 (reference 7614146) added a cursor to retrieve a default direct debit date from PER_TIME_PERIODS for use as the batch due date in the NZ Direct Credit XML report.

Key Procedures and Functions

The ETRM metadata documents one procedure for this package:

  • ADD_CUSTOM_XML — Invoked by the XML generation process for the New Zealand Direct Credit format. Its purpose is to add required XML tags to the XML generated for each assignment. The documented tags include BATCH_DUE_DATE, BATCH_CREATION_DATE, NBNZ_HASH_ACCT and REG_EMPLOYER. Internally, the procedure depends on cursors that obtain supporting values; notably a cursor named get_effective_date that selects the effective_date from PAY_PAYROLL_ACTIONS for a given payroll action identifier, and a further cursor that retrieves National Bank of New Zealand (NBNZ) account information using the pre-payment identifier and effective date.

No other procedures or functions are documented in the ETRM metadata. The get_effective_date cursor is an internal construct of add_custom_xml rather than a separately callable API, which explains why user searches for that term resolve to this package.

Tables Accessed

The package reads from the following tables via APPS synonyms:

  • PAY_PAYROLL_ACTIONS — source of the payroll action and its effective date, used to establish the payment/processing date context for XML output.
  • PAY_PRE_PAYMENTS — pre-payment records that identify the payment instruction being formatted.
  • PAY_EXTERNAL_ACCOUNTS and PAY_ORG_PAYMENT_METHODS_F — organisation-level payment method and external (bank) account details for the employer.
  • PAY_PERSONAL_PAYMENT_METHODS_F — employee-level payment method and bank account details.
  • PAY_ASSIGNMENT_ACTIONS — assignment-level action rows that bind payment data to individual assignments.
  • PAY_ACTION_INLOCKS — action interlock records used to coordinate processing across related payroll actions.
  • PER_TIME_PERIODS — source of the default direct debit date used as the batch due date, per change reference 7614146.

Usage Notes

PAY_NZ_EFT is not intended for direct invocation from custom code. It is called by the XML generation process that produces the New Zealand Direct Credit payment file, which is normally initiated through the New Zealand payroll payment concurrent programs and their associated XML publisher or BI Publisher templates. The package executes in the context of a payroll action, so the effective date and batch dates it supplies are consistent with the payroll run being paid.

Because the package is legislation-specific and classified as OTHER rather than as a public API, any dependency on it should be treated as subject to change across patches and upgrades. The ETRM metadata records no packages that reference PAY_NZ_EFT, so it sits at the end of the dependency chain. Implementers extending New Zealand EFT output should generally work through the supported XML generation and template mechanisms rather than modifying or calling this package directly.