Search Results get_assessed_ri




Overview
Explore in AI Chat

Overview

The APPS.PAY_HK_PAYSLIP_ARCHIVE package is a Hong Kong–specific Oracle Payroll database object that supports the generation and archival of payslip (payment advice) data for Hong Kong legislation. Because Hong Kong payroll reporting carries statutory disclosure requirements — including itemised earnings, MPF (Mandatory Provident Fund) contributions, and assessed remuneration for tax purposes — the payslip is a legally significant document. This package encapsulates the PL/SQL logic required to assemble that data from core Oracle HRMS and Payroll tables, and to persist an archived representation suitable for later retrieval, reprinting, or audit. It is classified as an "OTHER" API, meaning it is not a public business API governed by Oracle's API change policy but rather an internal support package invoked by other Hong Kong payroll objects. In the ETRM metadata, the package is listed as VALID and owned by the APPS schema, and it is documented for both Oracle EBS 12.1.1 and 12.2.2.

Key Procedures and Functions

The ETRM metadata documents six procedures or functions within this package. Their names indicate the following responsibilities:

  • RANGE_CODE — Handles range-based selection or grouping logic, likely determining which assignment actions or payroll runs fall within a processing range for archival.
  • INITIALIZATION_CODE — Performs setup and initialisation of internal variables, temporary collections, or context before the main archival logic executes.
  • ASSIGNMENT_ACTION_CODE — Processes assignment action level data, retrieving payroll results and element entries associated with individual assignment actions.
  • ARCHIVE_CODE — Executes the core archival routine, writing the assembled payslip data to the archive structures.
  • GET_SCHEME_NAME — A function returning the name of a scheme, most likely the MPF scheme associated with the assignment or organisation, used for display on the payslip.
  • GET_ASSESSED_RI — A function returning assessed remuneration or related income figures, consistent with Hong Kong tax reporting terminology.

No parameter lists are documented in the ETRM metadata, and none are inferred here.

Tables Accessed

The package reads from a set of core HRMS and Payroll tables via APPS synonyms. Organisational context is derived from HR_ORGANIZATION_INFORMATION and HR_ORGANIZATION_UNITS. Payroll processing data comes from PAY_ASSIGNMENT_ACTIONS, PAY_PAYROLL_ACTIONS, and PAY_RUN_RESULTS. Person data is sourced from PER_ALL_PEOPLE_F. Supporting configuration and detail tables include PAY_ACCRUAL_PLANS, PAY_ACTION_INFORMATION, PAY_ACTION_INTERLOCKS, PAY_ELEMENT_ENTRIES_F, PAY_ELEMENT_LINKS_F, PAY_ELEMENT_TYPES_F, PAY_INPUT_VALUES_F, PAY_EXTERNAL_ACCOUNTS, PAY_ORG_PAYMENT_METHODS_F, and PAY_PERSONAL_PAYMENT_METHODS_F. These provide the element classifications, input values, and payment method details needed to render a complete payslip.

Usage Notes

PAY_HK_PAYSLIP_ARCHIVE is referenced by three other packaged objects — notably the Hong Kong assignment element views PAY_HK_ASG_ELEMENTS_V, PAY_HK_ASG_ELEMENT_PAYMENTS_V, and PAY_HK_ASG_MPF_DATA_V — indicating it is invoked indirectly during payslip view generation or concurrent archival processing. It is typically called from Hong Kong payroll concurrent programs or from custom reporting code that needs to archive or retrieve historical payslip content. Because it is not a governed public API, direct custom calls should be undertaken with caution and revalidated during patching or upgrades between 12.1.1 and 12.2.2, as internal logic may change.