Search Results pay_au_payment_summary




Overview
Explore in AI Chat

Overview

The APPS.PAY_AU_PAYMENT_SUMMARY package is an Oracle E-Business Suite (EBS) PL/SQL package that supports Australian payroll payment summary processing. It resides in the APPS schema with VALID status in both release 12.1.1 and 12.2.2, and is classified as an OTHER API object rather than a public interface API. Its principal business function is to assemble, adjust, and archive the data required to produce Australian Payment Summaries, the statutory year-end tax documents employers issue to employees (and formerly to the Australian Taxation Office). The package correlates payroll action and assignment action results with defined balances and balance types in order to derive taxable earnings, allowances, lump sum amounts, and withholding figures for the payment summary period.

Because Australian legislation requires reporting of specific components such as lump sum payments, foreign leave payments, and retroactive adjustments, the package contains dedicated routines for handling these categories. It also coordinates the generation of the output data file used by the Australian Taxation Office magnetic media (magtape) submission, and it participates in the year-end reconciliation process.

Key Procedures and Functions

The documented callable units, none of which expose a published parameter list in the ETRM metadata, are as follows:

  • ADJUST_RETRO_ALLOWANCES — Adjusts allowance values arising from retroactive payroll processing so the correct amounts appear on the payment summary.
  • ADJUST_RETRO_FW — Performs the equivalent retroactive adjustment for Fortnightly Withholding (FW) amounts.
  • RANGE_CODE — Derives or sets the range code used to classify payment summary data groupings.
  • INITIALIZATION_CODE — Establishes the initialization code that governs how the summarisation run is set up.
  • ASSIGNMENT_ACTION_CODE — Handles processing logic keyed to the payroll assignment action being summarised.
  • ARCHIVE_CODE — Manages the archiving code applied to payment summary data.
  • GET_ARCHIVE_VALUE — Returns the archive value associated with the summarisation context.
  • SPAWN_DATA_FILE — Produces (spawns) the data file output for the Australian Taxation Office submission.
  • GET_LUMPSUME_VALUE — Retrieves the lump sum E (and related lump sum) values required for payment summary reporting.
  • GET_FOREIGN_LEAVE_PAYMENTS — Retrieves foreign leave payment amounts for inclusion in the summary.

Tables Accessed

The package reads and writes a defined set of EBS tables via APPS synonyms. Core payroll tables include PAY_PAYROLL_ACTIONS, PAY_ASSIGNMENT_ACTIONS, PAY_BALANCE_TYPES, and PAY_DEFINED_BALANCES, which supply the action and balance structures used to aggregate payment amounts. PER_ALL_PEOPLE_F provides person and assignment context. Fast Formula infrastructure is used through FF_USER_ENTITIES, FF_ARCHIVE_ITEMS, FF_DATABASE_ITEMS, and FF_GLOBALS_F, reflecting the package's reliance on Fast Formula database items and globals for deriving or archiving values. Organisational and geographic data are drawn from HR_ALL_ORGANIZATION_UNITS, HR_ORGANIZATION_INFORMATION, HR_LOCATIONS_ALL, and FND_TERRITORIES_TL. Assignment set and amendment handling uses HR_ASSIGNMENT_SETS and HR_ASSIGNMENT_SET_AMENDMENTS.

Usage Notes

PAY_AU_PAYMENT_SUMMARY is an internal engine rather than a standalone API. It is referenced by seven other packages, including PAY_AU_PAYMENT_SUMMARY_AMEND, PAY_AU_PAYMENT_SUMMARY_MAGTAPE, PAY_AU_PAYMENT_SUMMARY_REPORT, PAY_AU_RECON_SUMMARY, and PAY_AU_REC_DET_PAYSUM_MODE, as well as the views PAY_AU_EOY_VALUES_V and PAY_AU_SELFP_VALUES_V. Practically, it is invoked indirectly when users run Australian payment summary and year-end concurrent programs or the magtape generation process. Custom code should not call these procedures directly; instead, organisations should use the supported concurrent programs that wrap this package, and treat any customisation as a targeted extension point requiring regression testing against each patch level.