Search Results ap_pmt_callout_pkg




Overview
Explore in AI Chat

Overview

APPS.AP_PMT_CALLOUT_PKG is a PL/SQL callout package within the Oracle E-Business Suite Payables module. Its purpose is to provide a centralized integration point through which external payment systems, banking interfaces, and country-specific extensions can interact with Oracle Payables during the payment lifecycle. The package exposes currency conversion utilities and a set of event-driven callout procedures that are triggered as payments and payable documents move through their life cycle—rejection, completion, clearing, unclearing, voiding, and stop payment. In Oracle EBS 12.1.1 and 12.2.2, this package is classified as an "OTHER" API object, meaning it is not a general-purpose public API but rather a supporting callout mechanism invoked by the payment engine and by localized extensions.

The package header carries the revision marker $Header: apcnfrms.pls 120.7.12010000.2 2008/09/09 09:31:02 vasvenka ship $, indicating it is a shipped, Oracle-maintained object. Because it is a callout package, its procedures are typically invoked indirectly rather than called directly by end users.

Key Procedures and Functions

  • GET_USER_RATE — Returns an exchange rate between a base currency and a payment currency for a given check run. It supports currency conversion where the rate is derived from user-defined or payment-specific sources rather than the standard rate tables.
  • GET_BASE_AMOUNT — The function most relevant to the searched term "get_base_amount." It computes the base-currency equivalent of a payment amount, taking into account the base and payment currency codes, the check run, the exchange rate type, a base currency minimum accounting currency (MAC) indicator, the payment amount, the base currency precision, and the exchange date. It is used to derive accurate base-currency figures for accounting and reporting of foreign-currency payments.
  • DOCUMENTS_PAYABLE_REJECTED — Standard FND_API-style callout invoked when a group of payable documents is rejected, accepting a rejected documents group identifier and returning standard return status, message count, and message data.
  • PAYMENTS_COMPLETED — Invoked when a group of payments completes, accepting a completed payments group identifier and returning standard API status values.
  • PAYMENTS_CLEARED — Triggered when a payment group clears against the bank, accepting a group identifier and returning standard status information.
  • PAYMENTS_UNCLEARED — Triggered when previously cleared payments are reversed or uncleared, accepting a group identifier and returning standard status information.
  • PAYMENT_VOIDED — Invoked when an individual payment is voided, accepting a payment identifier and void date and returning standard status outputs.
  • AP_JAPANBANKCHARGEHOOK — A country-specific (Japan) hook supporting bank charge handling during payment processing.
  • PAYMENT_STOP_INITIATED — Callout fired when a stop payment request is initiated.
  • PAYMENT_STOP_RELEASED — Callout fired when a stop payment request is released.
  • VOID_PAYMENT_ALLOWED — Determines whether a payment may be voided under the prevailing business rules.

Tables Accessed

The package reads and writes a range of Payables base tables (referenced via APPS synonyms), reflecting its role across the payment and invoice life cycle. Payment and check data reside in AP_CHECKS_ALL and AP_CHECKS_S. Batch processing and invoice selection use AP_BATCHES_ALL, AP_BATCHES_S, AP_INV_SELECTION_CRITERIA_ALL, and AP_SELECTED_INVOICES_ALL. Invoice and distribution context is drawn from AP_INVOICES_ALL, AP_INVOICE_LINES_ALL, AP_INVOICE_DISTRIBUTIONS_ALL, and AP_PAYMENT_SCHEDULES_ALL. Payment-to-invoice linkage and relationships are held in AP_INVOICE_PAYMENTS_ALL, AP_INVOICE_PAYMENTS_S, and AP_INVOICE_RELATIONSHIPS. Withholding tax temporary data is accessed through AP_AWT_TEMP_DISTRIBUTIONS_ALL, and product registration information is referenced via AP_PRODUCT_REGISTRATIONS.

Usage Notes

AP_PMT_CALLOUT_PKG is an internal callout package rather than a directly invoked public API. Its procedures are called by the Oracle Payables payment engine, by payment format and banking programs, and by country-specific localization code at the appropriate life-cycle events. The currency functions GET_USER_RATE and GET_BASE_AMOUNT are commonly reached from payment formatting and accounting logic that must determine base-currency values for foreign-currency payments. Customizations in 12.1.1 and 12.2.2 should extend this package only through supported extension mechanisms, and the ETRM metadata records that the package is referenced by zero other packages, confirming its role as a top-level integration hook rather than a shared utility library.