Search Results get_tax_year_start

Overview

PAY_HK_IR56 is an Oracle E-Business Suite PL/SQL package owned by the APPS schema that supports Hong Kong statutory reporting obligations. Its primary purpose is to assemble the emolument (income) details required for the Hong Kong Inland Revenue Department's IR56 family of employer's returns, which report the remuneration paid to employees during a tax year. The package extracts balance values, resolves period dates, and derives the tax-year and quarterly boundaries that underpin the IR56 reporting views and concurrent programs delivered with Oracle Payroll for Hong Kong legislation.

The package header carries a version marker of 120.1 (dated 13-DEC-2005) and traces its origin to a 2001 creation. Successive changes added the nocopy hint on OUT parameters, introduced the emolument record structure and balance-value collection, and added date-derivation functions used by a quarters information view. The package is classified as OTHER in the ETRM repository, meaning it is not a public payroll API but rather an internal helper package referenced by other reporting components.

Key Procedures and Functions

The ETRM metadata documents four callable units:

• GET_EMOLUMENTS — Returns a PL/SQL collection of emolument detail records (g_emol_details_tab) for a given assignment, assignment action, tax unit, and reporting year. Each record captures a balance name, balance value, period date range, and a particulars description drawn from HR lookups. This is the package's central data-gathering routine for IR56 output.
• POPULATE_DEFINED_BALANCE_IDS — Populates the internal g_balance_value_tab collection of defined balance identifiers and values. This procedure, added in version 115.2, resolves which defined balances are relevant to Hong Kong IR56 processing so that GET_EMOLUMENTS can aggregate the correct earnings components. This is the object referenced by the search query "populate_defined_balance_ids."
• GET_TAX_YEAR_START — Returns the start date of the applicable tax year for a given assignment and calculation date. The Hong Kong tax year runs from 1 April to 31 March, so this function determines the correct reporting window.
• GET_QUARTERS_START_DATE — Returns the start date of a reporting quarter for a given assignment and source identifier. Added under bug fix 4864213, it is consumed by the view pay_hk_ir56_quarters_info_v.

Two package-level data structures are declared: g_emol_details_rec / g_emol_details_tab for emolument rows, and g_balance_value_tab typed as pay_balance_pkg.t_balance_value_tab.

Tables Accessed

The package operates against a defined set of Payroll and HR tables (through APPS synonyms), including:

• PAY_ASSIGNMENT_ACTIONS — Supplies the assignment action and tax unit context for emolument extraction.
• PAY_BALANCE_TYPES and PAY_DEFINED_BALANCES — Define which balances are eligible for IR56 reporting and provide balance names.
• PAY_BALANCE_DIMENSIONS and PAY_BALANCE_FEEDS_F — Support balance resolution and feed definitions used in computing balance values.
• PAY_ELEMENT_TYPES_F, PAY_ELEMENT_LINKS_F, PAY_ELEMENT_ENTRIES_F, and PAY_INPUT_VALUES_F — Provide the element and entry-level detail from which emoluments are derived.
• PER_PERIODS_OF_SERVICE — Provides assignment service periods to bound the reporting date range.
• PLITBLM — The PL/SQL index-by table utility used for collection handling.

Usage Notes

PAY_HK_IR56 is an internal package rather than a public API, as reflected by its OTHER classification. It is invoked indirectly through the Hong Kong IR56 reporting views and concurrent programs rather than being called directly by end users. The ETRM repository records that it is referenced by two other packages, confirming its role as a shared helper for IR56-related logic.

Typical invocation occurs during IR56 report generation, when the concurrent program or view calls populate_defined_balance_ids to seed the balance collection and then calls get_emoluments to retrieve per-assignment emolument rows. The date functions are called by the quarters information view to segment the tax year. Customizations that require IR56 emolument data should call these routines rather than reimplementing balance aggregation, ensuring consistency with delivered Hong Kong payroll legislation.