Search Results get_installment




Overview

The APPS.AR_PREPAYMENTS package is a public PL/SQL API within Oracle Receivables that manages the full lifecycle of customer prepayments in Oracle E-Business Suite 12.1.1 and 12.2.2. A prepayment is a receipt recorded against a customer before a corresponding invoice is raised, effectively creating an unapplied or on-account credit balance that is subsequently applied to future transactions. This package provides the programmatic interface for creating such prepayment receipts, matching them against invoices, refunding unapplied balances, and retrieving the selection rules used to identify which prepayments are eligible for application. The package exposes a header dated 2001 with a revision reference of 120.9, indicating a long-standing, stable component of the Receivables API set. Its API classification is recorded as OTHER, meaning it is not a formal FND-style standard API, though its Create_Prepayment procedure follows the familiar standard API parameter conventions (API version, initialization message list, commit flag, validation level, and return status outputs).

Key Procedures and Functions

The metadata documents six public procedures and functions:

  • CREATE_PREPAYMENT — The primary entry point for creating a prepayment receipt and placing it on prepayment status. It accepts standard API control parameters alongside receipt information such as currency code, user currency code, and exchange rate type. It writes to the cash receipts tables and returns the standard return status, message count, and message data outputs.
  • REFUND_PREPAYMENTS — Processes the refund of a prepayment balance back to the customer, interacting with the refund bank account and receipt method held in the package globals G_REFUND_BANK_ACCOUNT_ID and G_REFUND_RECEIPT_METHOD_ID.
  • MATCH_PREPAYMENT — Applies or matches an existing prepayment against an invoice or debit item, generating the corresponding receivable application records.
  • GET_INSTALLMENT — Retrieves installment details associated with a prepayment or related payment schedule, supporting the matching process.
  • RULE_SELECT_PREPAYMENTS — Evaluates and returns the selection rules used to determine which prepayments qualify for application or refund.
  • SELECT_PREPAYMENTS — Returns the set of prepayments that satisfy the defined selection criteria, typically used by batch auto-application logic.

Tables Accessed

The package operates across the core Receivables and Trading Community tables. AR_CASH_RECEIPTS, AR_CASH_RECEIPTS_ALL, and AR_CASH_RECEIPT_HISTORY store the header, line, and history records for the generated prepayment receipt. AR_PAYMENT_SCHEDULES and AR_RECEIVABLE_APPLICATIONS hold the installment and application records created during matching. AR_RECEIPT_METHODS, AP_BANK_ACCOUNTS, and CE_BANK_ACCOUNTS supply receipt method and refund bank account definitions. Customer identification draws on HZ_PARTIES, HZ_CUST_ACCOUNTS, and HZ_CUST_SITE_USES. RA_CUSTOMER_TRX supports invoice matching, while FND_CURRENCIES resolves currency attributes and FND_CONCURRENT_REQUESTS and WF_EVENT_T support concurrent processing and workflow event publication.

Usage Notes

AR_PREPAYMENTS is invoked primarily from Oracle Receivables forms and concurrent programs that handle prepayment entry, application, and refund. Custom integrations may call Create_Prepayment directly to load prepayment receipts, observing the standard API parameter contract. The package is referenced by three other packages, indicating it participates in a broader call chain. Because the header notes noship, the package name and signature should be treated as internal and subject to change across patches; custom code should validate behavior against the specific 12.1.1 or 12.2.2 instance in use.