Search Results update_batch_total

Overview

APPS.PAY_BATCH_ELEMENT_ENTRY_API is the public PL/SQL API that governs the creation, maintenance, and removal of batch element entries in Oracle Payroll within Oracle E-Business Suite 12.1.1 and 12.2.2. Batch element entries provide the mechanism by which payroll administrators group element entries into a batch header and one or more batch lines so that element processing, costing, and payment can be coordinated across populations of assignments. The package encapsulates the validation, defaulting, and derivations required before records are written to the underlying batch tables, ensuring that data conforms to Payroll business rules irrespective of the calling interface.

The package is classified as an API and is referenced by 21 other packages in the EBS schema, which confirms its role as a shared, contract-stable interface rather than an internal utility. Source header information identifies the file as pybthapi.pkb, version 120.3, dated 2005/06/21, indicating the object has been stable across the 11i and R12 codelines. The package exposes nine documented procedures and functions, split symmetrically across the header, line, and control total entities, plus private helper routines such as get_upgrade_status and convert_display_to_internal.

Key Procedures and Functions

The API is organised into three functional groups matching the hierarchical structure of a batch. CREATE_BATCH_HEADER establishes the batch parent record; CREATE_BATCH_LINE adds element entry detail beneath an existing header; and CREATE_BATCH_TOTAL inserts a control total used to reconcile the batch against expected counts or amounts. The three corresponding UPDATE procedures — UPDATE_BATCH_HEADER, UPDATE_BATCH_LINE, and UPDATE_BATCH_TOTAL — modify existing records of each type, applying the same validation and display-to-internal conversion logic as the create routines. The DELETE procedures, DELETE_BATCH_HEADER, DELETE_BATCH_LINE, and DELETE_BATCH_TOTAL, remove records in a controlled manner that respects referential dependencies between header, line, and total. Because CREATE_BATCH_TOTAL is one of only nine documented entry points, callers searching for batch total creation should use this procedure rather than writing directly to the control totals table.

Tables Accessed

The package reads and writes PAY_BATCH_HEADERS and PAY_BATCH_LINES, the core batch hierarchy, and PAY_BATCH_CONTROL_TOTALS, which stores reconciliation totals for each batch. Element definitions and entry values are validated against PAY_ELEMENT_TYPES_F and PAY_INPUT_VALUES_F. Error and message text is handled through PAY_MESSAGE_LINES. Upgrade-compatibility checks consult PAY_UPGRADE_STATUS, and session context is obtained from FND_SESSIONS. DUAL is used for single-row computations. All tables are addressed through APPS synonyms, so the same source operates correctly against the AP and HR shared schema in a multi-org installation.

Usage Notes

The package is normally invoked from the Batch Element Entry form and from payroll batch concurrent programs, but the documented API classification means third-party and custom code may call it directly. Callers should supply business group context before invocation, because upgrade status and business group derivation rely on the batch header. Every procedure is transactional in the caller's session; commit and rollback remain the responsibility of the invoking program. Because 21 packages reference this API, modifications to its behaviour can cascade widely, and customisations should be restricted to wrapper packages rather than changes to the body itself.