Search Results pay_hk_exc




Overview
Explore in AI Chat

Overview

PAY_HK_EXC is an Oracle Payroll package owned by the APPS schema and classified as an "OTHER" API within the ETRM repository. It is a Hong Kong (HK) localization component, evidenced both by its naming convention and by its dependency graph, which links it exclusively to Hong Kong statutory objects such as PAY_HK_MPF_RI_BALANCES_V, PAY_HK_RELEVANT_INCOME_V, and PAY_HK_BALANCES_BY_DATE_V2. Its core business function is to support the calculation and derivation of statutory deduction and exception-related values for Hong Kong payroll processing, most notably the Mandatory Provident Fund (MPF) and related relevant-income computations. The package exposes helper logic consumed by HK-specific views and by at least three other packages, and its status is recorded as VALID, confirming that it compiles cleanly against the standard Oracle EBS database objects it depends on. Because it is a supporting utility package rather than a user-facing API, it does not carry a formal seeded or public API classification; it is best understood as internal, reusable HR/payroll logic that the HK legislative reporting layer calls upon.

Key Procedures and Functions

ETRM documents five callable units within this package. The following are named and described at the functional level only; parameter lists are intentionally not reproduced.

  • DATE_EC — Derives an employment/earnings-cutoff style date value used to anchor a statutory computation window, supporting the date-sensitive nature of HK payroll legislative calculations.
  • GET_EXPIRY_DATE — Returns an expiry date, typically associated with the validity window of an eligibility, relevant-income, or contribution determination. This is consumed by the dependent views to filter records that fall within a valid period.
  • CALCULATED_VALUE — The principal computational routine, returning a derived value for a given assignment and period context. This underpins the numerical output surfaced through the HK balances and relevant income views.
  • START_CODE_12MTHS_PREV — Determines a starting reference point (code/date) representing the twelve-month prior window, consistent with HK relevant-income and MPF rules that look back over a rolling twelve-month period.

Collectively these units provide date arithmetic, expiry resolution, twelve-month lookback anchoring, and value calculation—the building blocks the HK statutory reporting layer requires.

Tables Accessed

The package reads and writes through APPS synonyms covering the following base tables:

  • HR_ORGANIZATION_INFORMATION — Provides organization/legal-entity attributes used to determine applicable HK statutory rules and eligibility.
  • PAY_ASSIGNMENT_ACTIONS — Supplies the assignment event history, including hire, termination, and status changes, essential for establishing valid computation windows.
  • PAY_BALANCE_DIMENSIONS — Defines the dimensions against which balances are aggregated, enabling the package to resolve the correct balance context.
  • PAY_DEFINED_BALANCES — The core balance values (contributions, relevant income) the calculations read or influence.
  • PAY_PAYROLL_ACTIONS — Identifies the payroll run/action context in which calculations are performed.
  • PER_TIME_PERIODS — Supplies the payroll period definitions used for date-window and twelve-month lookback logic.

Usage Notes

PAY_HK_EXC is invoked indirectly rather than directly by end users. It is referenced by the HK views PAY_HK_BALANCES_BY_DATE_V2, PAY_HK_MPF_RI_BALANCES_V, and PAY_HK_RELEVANT_INCOME_V, and by three further packages. Consequently, whenever these views or packages are queried—typically through HK statutory reports, MPF relevant-income extracts, or concurrent programs—PAY_HK_EXC executes as part of the call chain. It is not expected to be called directly from a form, and custom code should treat the API as internal. Any customer extension that calls it directly must respect the date-window and expiry semantics described above, and should anticipate that its output feeds the HK statutory view layer.