Search Results pay_au_rec_pkg




Overview
Explore in AI Chat

Overview

PAY_AU_REC_PKG is an Oracle Payroll legislative package that supports Australian (legislation_code = 'AU') payroll processing within Oracle E-Business Suite. Its header comments and shipped source line (pyaurec.pkb 115.7) identify it as an Australian localization component whose purpose is to summarise assignment-level balance results for a given payroll run. The package exists to encapsulate the repeated pattern of retrieving individual balance values and aggregating them into the payment and deduction totals required by Australian payroll reporting and payment calculation.

In practice, PAY_AU_REC_PKG acts as a thin wrapper over the balance calculation engine. It relies on the HR_AUBAL.CALC_ASG_RUN function to compute run balance values for a specific assignment action and effective date, then exposes those values through a small number of convenience procedures. This design allows Australian payroll calculation logic, receipts, or downstream reporting code to obtain a consistent set of run totals without repeatedly re-querying PAY_BALANCE_TYPES and re-invoking the balance function.

Key Procedures and Functions

  • RUN_BALANCES — Sums a single named balance for a specific assignment, assignment action, and effective date. It opens a cursor that selects the balance value from PAY_BALANCE_TYPES, restricting to balance_name and legislation_code = 'AU', and calculates the run value through HR_AUBAL.CALC_ASG_RUN. A NULL result is coalesced to zero. The result is returned through an OUT parameter, making this the fundamental building block used to retrieve one balance at a time.
  • BALANCE_TOTALS — Returns all relevant balance results for a payroll run in a single call rather than five separate invocations. The procedure aggregates the assignment-level totals needed by Australian payroll, including gross pay for the current pay period, other deductions, tax deductions, direct payments, and pre-tax deductions. Each total is supplied through a separate OUT parameter. This bulk-return design reduces cursor overhead and ensures that the set of balances presented to the caller is internally consistent for the same assignment and effective date.

Tables Accessed

  • PAY_BALANCE_TYPES — Read to resolve the supplied balance name to its balance type identifier and to confirm the balance belongs to Australian legislation. This table drives the cursor used inside RUN_BALANCES.
  • PAY_ASSIGNMENT_ACTIONS — Read to validate and resolve the assignment action that anchors the balance calculation, supplying assignment_id and assignment_action_id to HR_AUBAL.CALC_ASG_RUN.
  • PER_ALL_ASSIGNMENTS_F — Referenced for the assignment identifier used in the procedure parameter definitions and in the balance calculation, ensuring balances are computed at the correct assignment level and effective date.

Usage Notes

PAY_AU_REC_PKG is classified as an OTHER API and, according to the documented metadata, is not referenced by any other package. It is therefore not a broadly shared utility; it is invoked directly by Australian payroll calculation or reporting components that need run balance totals for a specific assignment action. Typical invocations occur during payroll run processing, where the caller has already determined the assignment, assignment action, and effective date. The OUT parameters of BALANCE_TOTALS make it suitable for elements or formulas that must capture gross, tax deductions (the value matched by the search term "total_tax_deductions"), pre-tax deductions, direct payments, and other deductions in one pass. Because the package is an internal building block rather than a public API, customisations should call the documented procedures rather than attempting to replicate the underlying balance cursor directly, and should be reviewed carefully prior to upgrades between 12.1.1 and 12.2.2.