Results for “adjust_retro_allowances”

16 results




Overview
Explore in AI Chat

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

Overview

PAY_AU_PAYMENT_SUMMARY is an Oracle E-Business Suite payroll package body owned by the APPS schema that supports the Australian (AU) payment summary reporting process. A payment summary in the Australian legislative context is the statutory year-end statement of earnings, tax withheld, and other reportable amounts that an employer must issue to each employee and to the Australian Taxation Office. This package assembles the archived legislative values required to produce those statements rather than performing payroll calculation itself.

The package is classified as OTHER in the ETRM metadata, indicating it is not a public or supported API surface but an internal implementation invoked by the Australian payment summary concurrent programs. Its documented version header references release 12.1 line-level fixes and a broad change history from 2001 onward, including adjustments for fringe benefits, union names, Employment Termination Payment (ETP) dates, lump sum amounts, and termination date handling across financial years.

Key Procedures and Functions

The package exposes ten documented procedures and functions:

  • ADJUST_RETRO_ALLOWANCES — Adjusts retroactive allowance balances for inclusion in the payment summary, ensuring corrections to prior-period allowances are reflected.
  • RANGE_CODE — Resolves or assigns the range code used to categorise payment summary records, typically tied to organisational or assignment-set grouping.
  • INITIALIZATION_CODE — Performs initialisation logic, setting up internal identifiers and context before archival processing begins.
  • ASSIGNMENT_ACTION_CODE — Handles assignment action processing, including the action lock referenced in the change history for the payment summary report.
  • ARCHIVE_CODE — Drives the archiving of balance and legislative values into the archive items consumed by the report.
  • GET_ARCHIVE_VALUE — Retrieves a previously archived value for a given archive item, used throughout the report to obtain consolidated year-to-date figures.
  • SPAWN_DATA_FILE — Generates the output data file that carries the assembled payment summary records for downstream processing.
  • GET_LUMPSUME_VALUE — Returns the lump sum E amount, excluding certain untaxed lump sum D amounts per the documented Bug #2075782 fix.
  • ADJUST_RETRO_FW — Adjusts retroactive Fortnightly/Weekly style amounts, aligning period payments with the reportable basis.
  • GET_FOREIGN_LEAVE_PAYMENTS — Returns foreign leave payment amounts that must be reported separately on the payment summary.

Tables Accessed

The package reads and writes several APPS-synonym tables. FF_USER_ENTITIES, FF_ARCHIVE_ITEMS, FF_DATABASE_ITEMS, and FF_GLOBALS_F form the FastFormula infrastructure used to store and retrieve the archived legislative values. PAY_ASSIGNMENT_ACTIONS and PAY_PAYROLL_ACTIONS supply assignment action and payroll run context. PAY_BALANCE_TYPES and PAY_DEFINED_BALANCES identify the balances used by calc_all_balances calls referenced in the change history. PER_ALL_PEOPLE_F provides employee details, including current and terminated employees. Organisational and assignment-set data come from HR_ALL_ORGANIZATION_UNITS, HR_ORGANIZATION_INFORMATION, HR_ASSIGNMENT_SETS, HR_ASSIGNMENT_SET_AMENDMENTS, and HR_LOCATIONS_ALL. FND_TERRITORIES_TL resolves territory descriptions.

Usage Notes

PAY_AU_PAYMENT_SUMMARY is invoked indirectly by the Australian payment summary concurrent program, which triggers the archive and data-file generation routines. It is referenced by seven other packages, reflecting dependencies within the Australian payroll legislative reporting layer.

Because it is not classified as a supported API, custom code should not call these procedures directly; integrators should rely on the delivered concurrent programs instead. The documented handling of terminated employees, ETP payment dates, next-financial-year termination logic, and lump sum exclusions means the package is sensitive to effective-dating and financial-year boundaries. Testing customisations against 12.1.1 and 12.2.2 is advisable, as the header indicates specific release-level fixes applied to this body.