Search Results create_charge




Overview
Explore in AI Chat

Overview

IGS_FI_SS_CHARGES_API_PVT is a private PL/SQL API package owned by the APPS schema in Oracle E-Business Suite, belonging to the Oracle Student System (formerly OSS/Student Systems) financials integration layer. The package name follows the IGS_FI prefix convention used for Student System financial integration objects, with the _SS_ segment indicating student-system charge processing and _API_PVT denoting that the program unit is a private API helper rather than a public, independently callable interface.

The package encapsulates the business logic required to create a financial charge against a student or person record in the Student System. It serves as the implementation layer behind charge-creation requests originating from other Student System components, notably the public wrapper packages that expose the create_charge operation. In Oracle EBS 12.1.1 and 12.2.2 this object remains part of the legacy Student System data model and is not part of the standard Financials (AR/GL) API family. The header revision recorded in the source is 120.1, dated 2005, reflecting its final shipped modification in the 11i/12.x lineage.

Key Procedures and Functions

The ETRM metadata documents a single procedure in this package:

  • CREATE_CHARGE — Creates a charge record for a person within the Student System financials schema. The procedure follows the standard Oracle EBS PL/SQL API conventions, accepting an API version, initialization message list flag, commit flag, and validation level at the top of its signature. Its input parameters describe the person, the fee type, fee category, fee calendar type and calendar instance sequence, course code, attendance type and mode, invoice amount and description, invoice creation date, transaction type, currency code and exchange rate, effective date, and waiver information (waiver flag and waiver reason). It also accepts a source transaction identifier to support linkage and traceability back to the originating transaction.
  • The procedure returns the generated invoice identifier, the standard API return status, message count, and message data, plus a waiver amount output that was added under Enhancement 4506599 (September 2005) to report the amount waived during charge creation.

Change history indicates that a previously referenced subaccount_id parameter was removed from the create_charge signature under Enhancement 2564643 (September 2002), so integration code written against earlier releases may still attempt to supply that argument and must be adjusted for current versions.

Tables Accessed

The ETRM metadata for this object records no explicitly documented table references resolved through APPS synonyms. Based on its name and parameter surface, the package operates on Student System fee and invoice tables — primarily the charge/invoice header and line structures and the fee calendar/instance tables identified by p_fee_cal_type and p_fee_ci_sequence_number — together with the person reference identified by p_person_id. Because the object is classified as PVT and no synonyms are documented, the DML is performed against underlying IGS tables rather than being exposed through a published data-access contract.

Usage Notes

As a private API, IGS_FI_SS_CHARGES_API_PVT is not intended for direct invocation by customer extensions. ETRM indicates it is referenced by two other packages, which act as callers — typically the corresponding public API wrapper and a validation or processing package within the Student System financials module. Charge creation of this kind is generally triggered from Student System forms (such as fee and charge entry screens) or from concurrent programs that post or assess student fees in batch.

Custom code should never call the _PVT procedure directly. Instead, developers should invoke the referencing public API so that wrapper-level validations, message handling, and commitment control are applied consistently. When reading messages after a call, clients should loop over x_msg_count and retrieve text via FND_MSG_PUB, honoring x_return_status of FND_API.G_RET_STS_ERROR or G_RET_STS_UNEXP_ERROR before committing. Because the package belongs to the Student System product family, supportability depends on that product being licensed and installed in the target 12.1.1 or 12.2.2 instance.