Search Results create_payment_detail




Overview
Explore in AI Chat

Overview

The APPS.PER_BF_PAYMENT_DETAILS_API package body provides the supported programmatic interface for maintaining payment detail records associated with Oracle Payroll and Oracle Human Resources personal payment methods. In Oracle EBS 12.1.1 and 12.2.2, payment details represent the allocation of a payable amount to a specific personal payment method for a given assignment, and are consumed downstream by the payroll and third-party payment (BF) processes such as the payment/cheque writer and the electronic funds transfer routines.

The package encapsulates the validation and persistence logic required to create, change, and remove payment detail rows in PER_BF_PAYMENT_DETAILS, shielding callers from direct DML on the underlying table. A key internal behavior is currency validation: the private procedure chk_currency_code derives the applicable personal payment method (either from the supplied ID or by looking up the existing payment detail when an update is performed), resolves the currency from the organization payment method through the effective-dated PAY_ORG_PAYMENT_METHODS_F and PAY_PERSONAL_PAYMENT_METHODS_F tables, and raises HR_50403_NEED_PD_CURR when a currency code is missing or inconsistent.

Key Procedures and Functions

  • CREATE_PAYMENT_DETAIL — Inserts a new payment detail record. It performs the currency and amount validation described above before writing to PER_BF_PAYMENT_DETAILS, ensuring the payment detail is assigned to a valid, effective-dated personal payment method.
  • UPDATE_PAYMENT_DETAIL — Modifies an existing payment detail. This is the procedure most commonly targeted by the search term "update_payment_detail". When a payment detail ID is supplied, the package treats the call as an update and resolves the personal payment method from the existing row rather than requiring it from the caller, then revalidates the currency and amount.
  • DELETE_PAYMENT_DETAIL — Removes a payment detail record, typically invoked when a payment allocation is reversed or a payment is cancelled.

Tables Accessed

  • PER_BF_PAYMENT_DETAILS — The primary table maintained by this API; it stores the payment detail rows inserted, updated, or deleted by the three procedures.
  • PAY_PERSONAL_PAYMENT_METHODS_F — Read to resolve the personal payment method and its organization payment method, using effective date filtering.
  • PAY_ORG_PAYMENT_METHODS_F — Read to obtain the currency code associated with the organization payment method.
  • PER_BF_BALANCE_AMOUNTS — Referenced for balance amount information associated with payment details.
  • PER_BF_PROCESSED_ASSIGNMENTS — Referenced to track assignments already processed for payment purposes.

Usage Notes

The API is an API-classified, server-side PL/SQL interface owned by APPS. It is normally invoked by Oracle Payroll payment processing logic, related concurrent programs, and any custom code that must create or amend payment details without risking data integrity violations. Because the package performs its own validation, direct inserts or updates against PER_BF_PAYMENT_DETAILS should be avoided. The package is referenced by one other package in the ETRM metadata, confirming its role as a dependent building block rather than a top-level entry point. Calls should be made against the APPS synonym, passing valid personal payment method and effective date values consistent with the underlying effective-dated tables; otherwise the currency validation logic will raise the standard HR error message.