Search Results get_contract_subsidy_amount

Overview

OKL_SUBSIDY_PROCESS_PVT is a private (PVT) PL/SQL package in the APPS schema that supports the Oracle Lease and Finance Management (OKL) subsidy processing framework within Oracle E-Business Suite 12.1.1 and 12.2.2. Subsidies in ETRM represent third-party or vendor-funded contributions that reduce the cost of a lease or loan to the lessee, and the package provides the internal calculation, validation, and booking logic required to determine whether a contract or asset is subsidized, how much subsidy applies, and how the resulting financial impact should be reflected in funding and billing.

The package is the private implementation layer beneath the public APIs that drive lease origination, activation, termination, funding, and asset management. It is classified as PVT precisely because it is not intended for direct invocation by external integrators; instead, it is consumed by the public OKL packages and by the subsidy processing workflow. Its procedures are invoked throughout the contract lifecycle, from deal creation through activation, and into funding, rebooking, and early termination.

Key Procedures and Functions

The documented API surface contains sixteen procedures and functions, grouped by purpose:

• Validation: IS_CONTRACT_SUBSIDIZED and IS_ASSET_SUBSIDIZED determine whether a given contract or asset qualifies for subsidy treatment, returning the eligibility result used by downstream logic.
• Calculation: CALCULATE_SUBSIDY_AMOUNT, CALCULATE_ASSET_SUBSIDY, and CALCULATE_CONTRACT_SUBSIDY compute the subsidy basis and derived amounts for a contract, an individual asset, or the contract as a whole.
• Retrieval: GET_SUBSIDY_AMOUNT, GET_ASSET_SUBSIDY_AMOUNT, GET_CONTRACT_SUBSIDY_AMOUNT, GET_FUNDING_SUBSIDY_AMOUNT, and GET_PARTIAL_SUBSIDY_AMOUNT return previously determined or partially applicable subsidy figures for use by pricing, funding, and stream generation.
• Booking and synchronization: CREATE_BILLING_TRX creates the billing transaction associated with subsidy processing, while REBOOK_SYNCHRONIZE synchronizes subsidy data during rebooking operations.
• Termination and basis: GET_RELK_TERMN_BASIS derives the termination basis used when subsidy-bearing contracts are terminated early.

These routines are internal to the subsidy engine and are exposed only indirectly through the packages that reference them.

Tables Accessed

The package reads and writes across the ETRM contract, subsidy, and receivables data model:

• Contract structure: OKC_K_HEADERS_B, OKC_K_LINES_B, OKC_K_LINES_TL, OKC_LINE_STYLES_B, OKC_RULES_B, OKC_RULE_GROUPS_B, OKC_STATUSES_B, and OKC_K_PARTY_ROLES_B / OKC_RG_PARTY_ROLES provide the contract, line, rule, status, and party role context that determines subsidy applicability.
• Subsidy definitions: OKL_SUBSIDIES_B and OKL_SUBSIDIES_TL store the subsidy setup and translated descriptions, while OKL_STRM_TYPE_B identifies the stream types affected by subsidy treatment.
• Financial and logging: AR_PAYMENT_SCHEDULES_ALL is accessed for billing transaction creation, FND_LOG_MESSAGES captures debug and error logging, and HZ_CUSTOMER_PROFILES supplies customer profile context. PO_VENDORS is referenced through the dependency list for vendor-related subsidy sourcing.

Usage Notes

OKL_SUBSIDY_PROCESS_PVT is never called directly from a form or concurrent program. It is invoked by thirteen higher-level packages, including OKL_ACTIVATE_CONTRACT_PUB, OKL_DEAL_CREAT_PVT, OKL_FUNDING_PVT, OKL_PRICING_PVT, OKL_LA_STREAM_PVT, OKL_STREAM_GENERATOR_PVT, OKL_ACTIVATE_ASSET_PVT, OKL_ASSET_SUBSIDY_PVT, OKL_SPLIT_ASSET_PVT, OKL_AM_LEASE_LOAN_TRMNT_PVT, and OKL_QA_DATA_INTEGRITY, as well as through its own wrapper OKL_SUBSIDY_PROCESS_PVT_W. Customizations should invoke the public APIs rather than this private package, since its signatures are not part of the supported interface and may change between releases. The presence of OKL_QA_DATA_INTEGRITY as a dependent indicates the package is also used by ETRM diagnostic routines to validate subsidy data integrity.