Search Results get_total_prepays

Overview

AP_PREPAY_UTILS_PKG is a utility package in the Oracle Payables schema (APPS) that provides the core calculation, inquiry, and locking services required to support prepayment processing in Oracle E-Business Suite Release 12.1.1 and 12.2.2. Prepayments are invoices paid in advance of the goods or services they relate to; once the corresponding standard invoice is received, the prepayment must be applied, adjusted, or recouped against it. AP_PREPAY_UTILS_PKG supplies the shared logic that the Payables application uses to determine how much of a prepayment remains available, how much has already been applied, and whether a prepayment line is currently locked by another user or process.

The package is classified in the ETRM repository as an OTHER API rather than a public, formally supported API. It is nevertheless a foundational dependency for a large portion of the prepayment sub-system, and its status is VALID.

Key Procedures and Functions

The package exposes twenty-six documented procedures and functions. They fall into three functional groups.

• Amount inquiries: GET_PREPAID_AMOUNT, GET_TOTAL_PREPAYS, GET_PREPAY_AMOUNT_APPLIED, GET_PREPAY_AMOUNT_REMAINING, GET_PREPAY_AMOUNT_AVAILABLE, GET_AMT_APPLIED_PER_PREPAY, GET_PP_AMT_APPLIED_ON_DATE, GET_LINE_PREPAY_AMT_REMAINING, GET_LN_PREP_AMT_REMAIN_RECOUP, GET_LN_PP_AMT_REMAINING_NO_TAX, and GET_INC_TAX_PP_AMT_REMAINING. These return the original prepaid amount, the cumulative amount applied to date, the remaining or available balance, and tax-inclusive or tax-exclusive variants of the remaining balance, either at the invoice level or at individual line and distribution level.
• Attribute lookups: GET_PREPAY_NUMBER, GET_PREPAY_DIST_NUMBER, GET_PREPAYMENT_TYPE, and GET_PREPAYMENTS_APPLIED_FLAG resolve the prepayment document number, distribution number, prepayment type, and the indicator that records whether any prepayment has already been applied.
• Concurrency control: LOCK_LINE, UNLOCK_LINE, UNLOCK_LOCKED_LINES, and IS_LINE_LOCKED manage row-level locking on prepayment lines so that concurrent application or unapplication sessions do not corrupt the remaining balance, and so a form session can detect when a line is held elsewhere.

Tables Accessed

The package reads and writes the Payables invoice tables through APPS synonyms. The invoice header tables AP_INVOICES and AP_INVOICES_ALL provide the prepayment identity, type, and flags. AP_INVOICE_DISTRIBUTIONS and AP_INVOICE_DISTRIBUTIONS_ALL supply the accounting distributions from which prepaid amounts and remaining balances are derived. AP_INVOICE_LINES and AP_INVOICE_LINES_ALL hold line-level amounts used by the line-oriented inquiry functions and by the locking routines. AP_INVOICE_PAYMENTS_ALL and AP_PAYMENT_SCHEDULES / AP_PAYMENT_SCHEDULES_ALL establish how much has actually been paid and how much remains payable, while DUAL is used for scalar evaluations.

Usage Notes

AP_PREPAY_UTILS_PKG is referenced by fifteen other database objects, including AP_PREPAY_PKG, AP_INVOICES_UTILITY_PKG, and AP_MATCHING_UTILS_PKG, and by views such as AP_APPLY_PREPAYS_V, AP_UNAPPLY_PREPAYS_V, AP_VIEW_PREPAYS_V, AP_DIST_PREPAY_APPLICATION_V, and AP_INVOICES_V. It is also used by the Oracle iProcurement and Oracle Purchasing views (IGI_MPP_* and IGI_EXP_*). Because much of this activity originates from the Payables workbench forms and the prepayment application concurrent programs, the package is most often invoked indirectly rather than from custom code. Developers who call it directly should treat it as an unsupported internal API, avoid relying on undocumented parameter signatures, and confirm behavior against the specific patch level of 12.1.1 or 12.2.2 in use.