Search Results get_add_cont_refund_ind

Overview

PQP_GB_TP_TYPE2_FUNCTIONS is a PL/SQL package body owned by the APPS schema in Oracle E-Business Suite. In the context of Oracle EBS 12.1.1 and 12.2.2, it supports the United Kingdom (GB) legislative payroll requirements, specifically those relating to Teachers' Pensions (TP) Type 2 reporting and additional contributions. The package encapsulates business logic used to derive pensionable pay balances, retrieve payroll element and assignment context information, evaluate eligibility conditions such as teacher qualification, and compute additional contribution amounts and refund indicators.

The package is classified as OTHER within the ETRM documentation, indicating that it is not an end-user-facing API but rather an internal implementation unit invoked by other payroll and benefits processing components. The documented internal debug procedures use HR_UTILITY and FND_NUMBER calls to provide tracing capability, reflecting standard Oracle HRMS diagnostic practices. The package exposes twelve documented procedures and functions, which collectively let dependent code obtain balance identifiers, resolve element entries, gather statutory and assignment attributes, and perform the Teacher's Pension Type 2 calculations required for statutory returns.

Key Procedures and Functions

GET_PAY_BAL_ID is the function most commonly located by users. It resolves and returns the identifier of the payroll balance record needed by the Teacher's Pension Type 2 processing. Rather than accepting a balance name directly in application logic, callers use this routine to obtain the correct PAY_BALANCE_TYPES identifier from the balance definitions registered in the system. This is the entry point referenced by the search term "get_pay_bal_id".

GET_PAY_ELE_IDS_FROM_BAL derives the associated payroll element identifiers from a supplied balance, enabling downstream logic to move between balance-based and element-based representations of pensionable pay. This is essential because balance feeds aggregate element entry values, and the Teacher's Pension calculation must attribute amounts back to the individual elements.

GET_EET_INFO, GET_ASG_INFO, and GET_AAT_INFO retrieve element entry, assignment, and assignment attribute information respectively. These functions supply the context records required to evaluate an individual's pensionable service and contribution position.

CHK_TEACHER_QUAL_FOR_TP2 tests whether a person satisfies the qualification criteria for Teacher's Pension Type 2 treatment, returning a flag used to gate inclusion. GET_ADD_CONT_VALUE, GET_ADD_CONT_REFUND_IND, GET_TOTAL_ADD_CONT, and GET_TOTAL_ADD_CONT_SIGN handle additional contribution calculations: the contribution value, the refund indicator, the aggregated total, and the sign of that total. GET_FINANCIAL_YEAR determines the financial year applicable to the calculation, which governs rate and threshold selection. CHK_LEA_RUN validates whether the Local Education Authority payroll run qualifies for processing.

Tables Accessed

The package reads benefit and payroll configuration and results data through APPS synonyms including BEN_EXT_RSLT_DTL, BEN_EXT_RCD, PAY_BALANCE_FEEDS_F, PAY_BALANCE_TYPES, PAY_ELEMENT_ENTRIES_F, PAY_ELEMENT_TYPES_F, PAY_INPUT_VALUES_F, PAY_PAYROLL_ACTIONS, PAY_ASSIGNMENT_ACTIONS, and PAY_USER_COLUMN_INSTANCES_F. Balance and element definitions are consulted to resolve balance and element identifiers and their feed relationships.

Person and assignment context is obtained from PER_ALL_ASSIGNMENTS_F and PER_ALL_PEOPLE_F, with payroll period information from PER_TIME_PERIODS. Teacher's Pension-specific assignment attributes are read from PQP_ASSIGNMENT_ATTRIBUTES_F, while HR_LOCATION_EXTRA_INFO supplies location-level statutory details used to determine the applicable Local Education Authority context.

Usage Notes

PQP_GB_TP_TYPE2_FUNCTIONS is invoked internally rather than directly by end users. It is referenced by one other package, which calls its functions to obtain balance identifiers, validate Teacher's Pension Type 2 eligibility, and compute additional contribution totals during UK payroll processing. Typical invocation occurs from the payroll run and related Teacher's Pension reporting flows, where GET_PAY_BAL_ID supplies the balance handle and the remaining functions compute qualifying amounts. Custom extensions should not modify this package body; instead they should call its public functions and rely on the documented identifiers. Diagnostic tracing can be enabled through the package's debug routines when troubleshooting balance resolution or contribution calculation discrepancies.