Search Results populate_defined_balances

Overview

APPS.PAY_AU_SOE_PKG is an Oracle E-Business Suite PL/SQL package that supports Australian Statutory Officer or Statement of Earnings style reporting requirements for payroll. It provides a centralized API layer for retrieving payroll, assignment, address, currency, and balance information required to render payment summaries and related statutory documents for Australian legislation. The package encapsulates the logic needed to resolve an employee's home and work addresses, determine salary and payment rates, aggregate gross and deduction balances for current and year-to-date periods, and expose Australian-specific attributes such as superannuation fund details.

The package is classified as an API under ETRM (Owner: APPS, API classification: OTHER) and is documented in both Oracle EBS 12.1.1 and 12.2.2. It exposes sixteen documented procedures and functions, and is referenced by seven other packages, indicating it is a shared utility consumed across multiple payroll and statutory reporting components rather than a standalone end-user feature.

Key Procedures and Functions

The documented entry points serve distinct reporting concerns:

• GET_HOME_ADDRESS — Returns the employee's home address components, including address lines, town/city, postal code, and country name, for inclusion on statutory documents.
• GET_WORK_ADDRESS — Returns the work location address details derived from a location identifier, complementing the home address retrieval.
• GET_SALARY — Derives salary information based on pay basis, assignment, and an effective date.
• BUSINESS_CURRENCY_CODE — Resolves the business group's currency code, used to format monetary figures.
• POPULATE_DEFINED_BALANCES — Introduced under Bug 4169557 to populate Legal Entity (LE) dimension defined balance identifiers, supporting balance dimension setup.
• BALANCE_TOTALS — Aggregates gross pay, other deductions, and tax deductions for both the current pay period and year-to-date.
• GET_ASG_LATEST_PAY — Retrieves the most recent pay information for an assignment.
• GET_DETAILS — Returns supplementary assignment or payment detail used in statutory output.
• FINAL_BALANCE_TOTALS — Produces final aggregated balance totals for reporting.
• SUPER_FUND_NAME — Resolves the Australian superannuation fund name for the employee.
• GET_ELEMENT_PAYMENT_HOURS — Returns hours associated with a payment element.
• GET_ELEMENT_PAYMENT_RATE — Returns the rate associated with a payment element.
• GET_LEAVE_TAKEN_HOURS — Returns the leave hours taken, a common statutory reporting requirement.
• GET_CURRENCY_CODE — Returns the applicable currency code for a given context.
• GET_EFFECTIVE_DATE — Returns an effective date used to drive date-effective queries.
• GET_DOC_EIT — Retrieves document-related Extra Information Type (EIT) values used on statutory forms.

Tables Accessed

The package reads from and writes to several core HRMS and Payroll tables through APPS synonyms. Address data is drawn from PER_ADDRESSES and HR_LOCATION_EXTRA_INFO, with country names resolved via FND_TERRITORIES_TL and currency codes via FND_CURRENCIES. Payroll processing data is sourced from PAY_ASSIGNMENT_ACTIONS, PAY_PAYROLL_ACTIONS, PAY_RUN_RESULTS, PAY_ELEMENT_ENTRIES_F, and PAY_ELEMENT_TYPES_F, which supply pay run results, element entries, and payment hours/rates. Balance-related logic references PAY_BALANCE_DIMENSIONS and PAY_BALANCE_TYPES. Assignment and pay basis information comes from PER_ALL_ASSIGNMENTS_F and PER_PAY_BASES. Business group and organization context is resolved through HR_ORGANIZATION_INFORMATION, while PAY_ACTION_INTERLOCKS supports action-level processing coordination.

Usage Notes

PAY_AU_SOE_PKG is typically invoked from Oracle Payroll Australian statutory reporting flows, including payment summary and Statement of Earnings style concurrent programs, and can be called from custom PL/SQL or Oracle Forms that require Australian payroll attributes. Because it is referenced by seven other packages, changes to its interfaces should be treated as shared API changes and validated against dependent components. Implementations should observe date-effective patterns when calling the date-driven functions, and ensure the assignment and assignment action identifiers passed in correspond to the processing period being reported. As with other ETRM-documented APIs, direct modification is unsupported; extensions should wrap the packaged procedures rather than altering the delivered source.