Search Results pay_batch_element_entry_api




Overview
Explore in AI Chat

Overview

PAY_BATCH_ELEMENT_ENTRY_API is an Oracle-provided PL/SQL API in the APPS schema that supports the creation, maintenance, and removal of batch element entries within Oracle Payroll. Its role is to manage the persistent structures that hold payroll batch data — batch headers, batch lines, and batch control totals — which together represent collections of element entries submitted for processing. Rather than inserting and updating PAY_BATCH_HEADERS, PAY_BATCH_LINES, and PAY_BATCH_CONTROL_TOTALS directly, Oracle E-Business Suite applications and custom extensions call this API so that validation, session handling, and message logging are performed consistently. In EBS 12.1.1 and 12.2.2 the object is documented as VALID, has an API classification of API, and exposes nine public procedures.

Key Procedures and Functions

The package exposes three families of operations, each applied at three levels of the batch structure.

Note that parameter lists are intentionally not reproduced here; refer to the ETRM package specification for exact signatures. The CREATE operations accept or default input value information drawn from PAY_INPUT_VALUES_F and element definitions from PAY_ELEMENT_TYPES_F, while the UPDATE and DELETE operations act on records already persisted in the batch tables.

Tables Accessed

The package operates against the following tables through APPS synonyms:

  • PAY_BATCH_HEADERS — the primary target for CREATE_BATCH_HEADER, UPDATE_BATCH_HEADER, and DELETE_BATCH_HEADER.
  • PAY_BATCH_LINES — written and maintained by the batch line procedures.
  • PAY_BATCH_CONTROL_TOTALS — managed by the batch total procedures.
  • PAY_ELEMENT_TYPES_F and PAY_INPUT_VALUES_F — read to validate the element and its input values referenced by a batch line.
  • PAY_MESSAGE_LINES — used to record diagnostic or error messages generated during processing.
  • FND_SESSIONS — provides the application session context.
  • PAY_UPGRADE_STATUS — consulted for upgrade-state control.
  • DUAL — used for simple scalar evaluation.

Usage Notes

PAY_BATCH_ELEMENT_ENTRY_API belongs to the Oracle Payroll family of batch element entry (BEE) APIs. It is typically invoked indirectly: PAY_BATCH_ELEMENT_ENTRY_API is referenced by 21 other packages, including CN_PAYRUN_PVT, PAYPLNK, the HXT time-and-labour packages (HXT_BATCH_PROCESS, HXT_TIME_COLLECTION, HXT_RETRIEVAL_ROLLBACK, and others), and a series of country-specific extensions such as PAY_JP_BEE_UTILITY_PKG, PAY_KR_BEE_UPLOAD, PAY_NL_IZA_UPLOAD, and PAY_MX_PTU_CALC. It also references HR_API and STANDARD. In practice the package is called from batch upload routines, time-collection interfaces, and country localisations that need to load element entries without the Payroll Batch Element Entry form. Custom code implementing a BEE upload should call these procedures rather than writing to the batch tables directly, so that validation, message logging, and session handling remain consistent. Because the procedures are documented as an API, Oracle supports calls made through the published specification, while direct DML against the underlying tables is unsupported.