Search Results pay_balance_upload




Overview
Explore in AI Chat

Overview

The APPS.PAY_US_BAL_UPLOAD package is a United States–specific payroll balance upload utility within the Oracle E-Business Suite (EBS) 12.1.1 and 12.2.2 Payroll (PAY) module. It provides the country-specific extensions required to support the generic balance upload framework delivered by the PAY_BALANCE_UPLOAD package. The object is registered in the ETRM repository as a VALID package owned by the APPS schema, with an API classification of OTHER.

Its core business purpose is to load, validate, and adjust payroll balance values — such as gross earnings, taxable wages, and withholding balances — into the payroll balance tables, particularly for U.S. legislative and tax-reporting requirements. Balance uploads are commonly used during data conversions, third-party payroll integrations, and retroactive adjustments where balance figures must be reconciled without running a full payroll process.

Key Procedures and Functions

The ETRM metadata documents five procedures or functions within this package. Their purposes are:

  • GET_TAX_UNIT — Returns the applicable tax unit associated with the balance being uploaded. Tax units are used by U.S. payroll to group balances for tax calculation and reporting against the correct jurisdiction.
  • EXPIRY_DATE — Determines the effective expiry date for a balance entry, ensuring uploaded values are valid within the correct time period and do not conflict with the temporal validity rules applied to payroll balances.
  • IS_SUPPORTED — Indicates whether a given balance type or upload scenario is supported by this U.S. implementation, allowing the generic upload framework to route processing appropriately.
  • INCLUDE_ADJUSTMENT — Evaluates whether an adjustment should be included in the upload, supporting the inclusion of correction entries alongside primary balance values.
  • VALIDATE_BATCH_LINES — Validates the individual lines of a balance upload batch prior to processing, applying U.S.-specific business rules and rejecting or flagging invalid records.

As documented, these procedures are invoked by the parent PAY_BALANCE_UPLOAD package rather than called directly by end users.

Tables Accessed

The package references several tables through APPS synonyms:

  • PAY_BALANCE_TYPES — Defines the balance categories being uploaded; used to validate that a supplied balance type exists and to determine its characteristics (for example, whether it is an adjustment-capable balance).
  • PER_TIME_PERIODS — Provides payroll period definitions, enabling the package to resolve and validate the time period associated with each uploaded balance line.
  • HR_ORGANIZATION_INFORMATION — Supplies organization-level attributes, typically for resolving tax units and legislative context for the organization owning the balance.
  • HR_SOFT_CODING_KEYFLEX — Provides the key flexfield structure used for payroll cost allocation and soft coding of uploaded balance entries.

Usage Notes

PAY_US_BAL_UPLOAD is not intended for direct invocation. The ETRM dependency information shows that it is referenced by PAY_BALANCE_UPLOAD and by itself, and it references PAY_BALANCE_UPLOAD in return. This bidirectional relationship confirms that the U.S. package acts as a country-specific plug-in that is called by the generic upload driver.

In practice, the package is exercised when users submit the Balance Upload concurrent program or invoke the generic balance upload API to load U.S. payroll balances — for example during a US payroll data migration, a year-end balance adjustment, or a correction of third-party balance feeds. Validation performed by VALIDATE_BATCH_LINES occurs before records are committed to the balance tables, and the remaining functions determine support, tax unit, expiry, and adjustment treatment for each line. Custom code should call the generic PAY_BALANCE_UPLOAD package, letting it delegate to this U.S. implementation, rather than calling PAY_US_BAL_UPLOAD directly.