Search Results igs_fi_charges_api_pvt




Overview
Explore in AI Chat

Overview

IGS_FI_CHARGES_API_PVT is a private PL/SQL package in the Oracle E-Business Suite Student Systems (IGS) product family, owned by APPS. It supports the Student Financials / Charges subsystem by encapsulating the core logic used to create charge records and their associated charge lines. The package header carries the revision marker IGSFI53S.pls, version 120.2, and its documented API is Create_Charge. Because the package is classified as private (PVT), it is not intended to be called directly by external consumers; instead it is invoked by the public wrapper packages and internal processing units that make up the Charges application program interface. The package is referenced by eleven other packages in the ETRM repository, confirming its role as a shared internal engine for charge creation rather than a standalone entry point.

Key Procedures and Functions

A single documented procedure is exposed by this package: CREATE_CHARGE. Its documented purpose is to create a charge in the Charges and Charges Lines tables. The procedure accepts, among other arguments, a charge header record (p_header_rec), a charge lines table (p_line_tbl), and the standard API control parameters for API version, message list initialization, commit behavior, and validation level. It returns to the calling program the identifier of the charge created, the identifiers of the charge lines created, a return status indicating success (S), expected error (E), or unexpected error (U), together with message count and message data. A further output parameter returns the waiver amount for downstream processing.

The history block documents the evolution of the header and line record types. HEADER_REC_TYPE was modified under enhancement 3392095 (Tuition Waivers build) to include waiver_name, and a reference to subaccount_id was removed from the same record under enhancement 2564643. The line record type was extended over successive releases with p_d_gl_date, p_v_residency_status_cd, and unit-related attributes (p_n_unit_type_id, p_v_unit_class, p_v_unit_mode, p_v_unit_level). The current version of the package is documented as 2.0.

Tables Accessed

The package reads and writes a broad set of IGS and FND tables through APPS synonyms. Charge persistence is directed at IGS_FI_CREDITS_ALL and IGS_FI_CR_ACTIVITIES, with charge classification drawn from IGS_FI_CR_TYPES_ALL. Application and accounting context is obtained from IGS_FI_APPLICATIONS, IGS_FI_BALANCE_RULES, IGS_FI_CONTROL_ALL, and IGS_FI_FTCI_ACCTS. Calendar and installment information is sourced from IGS_CA_INST_ALL and IGS_FI_CR_TYPES_ALL. Student and program attributes relevant to charge assessment come from IGS_AS_UNIT_MODE, IGS_PS_UNIT_LEVEL_ALL, IGS_PS_UNIT_OFR_OPT_ALL, IGS_PS_UNIT_TYPE_LVL, and IGS_AD_LOCATION_ALL. Currency descriptions are validated against FND_CURRENCIES_TL, and message text is resolved from FND_NEW_MESSAGES for the standard API message stack.

Usage Notes

IGS_FI_CHARGES_API_PVT is invoked indirectly. Forms, concurrent programs, and custom extensions should call the corresponding public charges API rather than this private package, because the private signature is subject to change between patch levels and is not covered by the public API contract. Typical invocation paths include fee assessment, tuition waiver processing, and financial accounting builds, all of which construct a header record and a line table before delegating to CREATE_CHARGE. Callers must honor the standard API conventions: pass a valid API version, manage the message list and commit flags appropriately, and inspect the return status and message data before treating the transaction as successful. The optional waiver amount output parameter should be consumed by the waiver-related processing that triggered the call. Because the package is referenced by eleven other packages, changes to the header or line record types propagate widely, so extensions that depend on these structures must be revalidated after any Student Systems patch or upgrade.