Search Results get_retention_params

Overview

IGS_FI_GEN_008 is a PL/SQL package owned by the APPS schema in Oracle E-Business Suite, classified under the Student System (IGS) financials product family. It was created on 25-AUG-2003 by shtatiko as part of Enhancement 3045007, "Payment Plans," and has been maintained continuously through subsequent enhancements and bug fixes. The package aggregates a collection of generic utility procedures and functions that are called from multiple points across the Payment Plans, retention, audit, and special fees areas of the Student System. It is not a self-contained business process; instead, it functions as a shared library that other IGS financial packages invoke to resolve payment plan attributes, compute balances and retention amounts, validate transfer and adjustment conditions, and mask sensitive card data. Because the routines are generic and widely referenced — the package is referenced by 17 other packages — changes to its behavior can have broad downstream impact, and it should be treated as a shared dependency rather than an isolated unit.

Key Procedures and Functions

The 17 documented callable units span several functional areas:

• Payment plan queries: GET_PLAN_DETAILS, GET_PLAN_BALANCE, CHK_ACTIVE_PAY_PLAN, GET_START_DATE, and GET_PARTY_NUMBER resolve plan identifiers, active plan status, effective start dates, and party references.
• Invoice and adjustment handling: GET_INVOICE_NUMBER, added by uudayapr in October 2003 under Enhancement 3117341 as part of the Audit and Special Fees build, returns the invoice number associated with a fee or audit transaction. CHK_CHG_ADJ, added by rmaddipa in July 2004 under Enhancement 3787816 for the Manual Reversal build, validates whether a charge adjustment is permissible.
• Retention calculations: GET_RETENTION_PARAMS, GET_TEACH_RETENTION, GET_FEE_RETENTION_AMOUNT, GET_NS_USEC_RETENTION, and GET_SPECIAL_RETENTION_AMT, most of which were added or expanded under Retention Enhancement 3880438 (September 2004).
• Balance resolution: GET_STD_BALANCE returns the latest standard balance for a supplied person identifier, added by svuppala in May 2005 under Bug 4226849. GET_COMPLETE_WITHDR_RET_AMT computes complete withdrawal return amounts and gained the p_v_nonzero_billable_cp_flag parameter under Bug 4297359.
• Validation and data protection: CHK_SPA_REC_EXISTS (Bug 4625955) checks for existing records; MASK_CARD_NUMBER (Bug 4660773, October 2005) masks credit card numbers for display; CHK_UNIT_PRG_TRANSFER (Bug 5113295, May 2006) validates unit and program transfer conditions.

Tables Accessed

The package reads and writes through APPS synonyms across the student financials and trading community schemas. Payment plan tables include IGS_FI_PP_INSTLMNTS and IGS_FI_PP_STD_ATTRS. Fee and invoice data is drawn from IGS_FI_BALANCES, IGS_FI_FEE_AS_ALL, IGS_FI_FEE_AS_ITEMS, IGS_FI_FEE_AS_RT, IGS_FI_F_CAT_FEE_LBL_ALL, IGS_FI_F_TYP_CA_INST_ALL, IGS_FI_INV_INT_ALL, and IGS_FI_CREDITS_ALL. Retention processing uses IGS_FI_FEE_RET_SCHD and IGS_FI_TP_RET_SCHD. Calendar and offering context come from IGS_CA_INST_ALL and IGS_PS_UNIT_OFR_OPT_ALL, while GET_PARTY_NUMBER resolves against HZ_PARTIES in the Trading Community Architecture.

Usage Notes

IGS_FI_GEN_008 is invoked internally by other IGS financial packages rather than called directly from Oracle Forms. Its routines surface indirectly through Payment Plan setup and maintenance, fee assessment, retention and withdrawal processing, manual reversal, and audit and special fees flows. GET_INVOICE_NUMBER is typically reached during audit and special fee generation, where the caller needs the invoice reference returned to it. Because MASK_CARD_NUMBER handles credit card data, callers should respect its masking contract and avoid alternative unmasked retrieval. Customizations should wrap rather than modify the package, and any extension must be regression tested against the 17 referencing packages, particularly after upgrades between 12.1.1 and 12.2.2.