Search Results get_full_terminate_amount
Overview
OKS_IB_UTIL_PVT is an internal (PVT) PL/SQL utility package in the APPS schema of Oracle E-Business Suite Release 12.1.1 and 12.2.2. It supports the Service Contracts (OKS) module's "Install Base" and "IB" (Install Base) integration logic, providing shared helper logic used by the Service Contracts install-base interface, mass update, and extended warranty programs. The package is classified as PVT, meaning it is not a public API and Oracle does not document it for direct customer invocation. It instead acts as a reusable service layer consumed by other packages such as CSI_UTL_PKG, OKS_EXTWARPRGM_PVT, OKS_IBINT_PUB, and OKS_MASS_UPDATE_PVT.
Functionally, the package supplies routines that compute billing, transferred, terminated, and credited amounts for covered service lines; validate business flags on installment and billing lines; resolve customer, party, and resource display information; and populate global temporary data used during mass update and interface processing. It is one of the building blocks that lets Service Contracts present consistent amounts and party names for install-base-driven contract lines.
Key Procedures and Functions
The package exposes roughly thirty-two documented procedures and functions. Representative entries include:
- CHECK_PARTIAL_FLAG, CHECKMULTIPLEOU, CHECKACCOUNT, CHECK_TERMCANCEL_LINES — validation helpers that confirm flag settings, validate cross-operating-unit conditions, verify account context, and confirm termination or cancellation line eligibility before contract or install-base processing proceeds.
- GET_TERMINATE_AMOUNT, COVERAGE_TERMINATE_AMOUNT, GET_FULL_TERMINATE_AMOUNT — compute termination amounts at the line and coverage levels, supporting partial and full termination scenarios.
- GET_BILLED_AMOUNT, GET_ACTUAL_BILLEDAMOUNT — return billed versus actual billed values for coverage and billing lines.
- GET_TRANSFERRED_AMOUNT, COVERAGE_TRANSFER_AMOUNT, GET_ACTUAL_TRANSFERAMOUNT — return transferred versus actual transferred amounts for coverage transfers.
- GET_ACTUAL_CREDITAMOUNT, COVERAGE_TERM_FULL_AMOUNT — return credited amounts and the full coverage term amount.
- GET_PROD_NAME, GETBILLTOSHIPTO, GET_INVOICE_TEXT, GET_BILLCONTACT_NAME, GET_SALESREP_NAME — descriptive lookups that resolve product names, bill-to/ship-to parties, invoice text, billing contact names, and sales representative names.
- POPULATE_GLOBALTEMP — populates a global temporary structure used during mass update or interface processing.
Tables Accessed
The package reads and writes through APPS synonyms. Customer and party data comes from HZ_CUST_ACCOUNTS, HZ_CUST_ACCT_RELATE_ALL, HZ_CUST_ACCT_SITES_ALL, HZ_CUST_SITE_USES_ALL, HZ_PARTIES, HZ_PARTY_SITES, HZ_LOCATIONS, and HZ_RELATIONSHIPS, supporting bill-to/ship-to and account validation. Install-base and system data comes from CSI_ITEM_INSTANCES, CSI_COUNTER_ASSOCIATIONS, and CSI_SYSTEMS_TL, supporting product name and coverage context. Resource lookups use JTF_RS_RESOURCE_EXTNS and JTF_RS_RESOURCE_EXTNS_TL for sales representative names. Supplier site data is read from AP_SUPPLIER_SITES_ALL, and currency information is resolved through FND_CURRENCIES.
Usage Notes
OKS_IB_UTIL_PVT is invoked indirectly through Service Contracts forms, concurrent programs, and interface packages rather than being called directly by customers. It is referenced by CSI_UTL_PKG, OKS_EXTWARPRGM_PVT, OKS_IBINT_PUB, and OKS_MASS_UPDATE_PVT, and is also self-referenced, indicating internal recursion or shared helper reuse. Because it is a PVT-classified package, custom code should not depend on its signatures, as Oracle may change them without notice. For external integration, the public OKS_IBINT_PUB or OKS_MASS_UPDATE_PVT entry points should be used.