Search Results include_adjustment

Overview

PAY_SG_BAL_UPLOAD is an Oracle E-Business Suite package owned by the APPS schema that delivers balance upload support functions for the Singapore (SG) payroll localization. It is classified in the ETRM repository as an OTHER API, meaning it is not a general-purpose public API but rather a localized extension invoked internally by the core payroll balance upload process. Its header comment block, delivered in script pysgupld.pkh, states the package's purpose explicitly: to provide supporting functions that allow Singapore-specific statutory or earnings balances to be uploaded through the standard Oracle Payroll balance upload facility.

The package was first delivered under version 115.0 on 30-JUN-2000 on the assumption that PAY_BALANCE_UPLOAD (implemented in pybalupl.pkb) would explicitly call the Singapore routines and pass a record of previously processed adjustments. The header notes that the design must be reviewed if a different integration approach is adopted, which signals the package is tightly coupled to the generic upload engine rather than being standalone.

Key Procedures and Functions

The package exposes four documented external functions:

• EXPIRY_DATE — Returns the expiry date of a given balance dimension relative to a supplied date. By version 115.2 the dependency on get_tax_unit was removed and tax_unit_id was dropped from the signature, simplifying the date derivation logic.
• INCLUDE_ADJUSTMENT — Determines whether a particular balance adjustment should be included in the upload processing. Version 115.2 added p_batch_line_id and p_test_batch_line_id arguments, and version 115.3 changed the return type to a number. This is the routine most directly associated with the include_adjustment search term.
• IS_SUPPORTED — Reports whether a balance or upload scenario is supported for the Singapore localization, allowing the generic uploader to route or reject lines that fall outside SG statutory handling.
• VALIDATE_BATCH_LINES — Performs batch-level validation on uploaded balance lines prior to commit, guarding data integrity for SG payroll processing.

Tables Accessed

Per the ETRM metadata, the package references five tables through APPS synonyms:

• PAY_BALANCE_BATCH_LINES — The uploaded balance lines being validated and processed; the primary input to VALIDATE_BATCH_LINES and the source of the batch line identifiers passed to INCLUDE_ADJUSTMENT.
• PAY_TEMP_BALANCE_ADJUSTMENTS — Holds temporary adjustment records used to decide whether an adjustment is included, driving INCLUDE_ADJUSTMENT logic.
• PAY_BALANCE_TYPES — Defines balance dimensions and attributes, used to resolve expiry dates and determine whether a balance is supported.
• PER_TIME_PERIODS — Provides the payroll period definitions needed to calculate expiry dates and validate period consistency.
• HR_ORGANIZATION_INFORMATION — Supplies organization-level classification, typically to identify the Singapore business group or legal entity context.

Usage Notes

PAY_SG_BAL_UPLOAD is not intended for direct invocation by customers. It is called internally by PAY_BALANCE_UPLOAD during execution of the Balance Upload concurrent program. Custom code interacting with the standard upload should not call these functions directly because the version 115.0 header explicitly warns that the interface depends on assumptions about how pybalupl.pkb passes adjustment records. ETRM records zero referencing packages, confirming that the package is a leaf-level localization utility. In 12.1.1 and 12.2.2 the object ships under the same APPS ownership with no change in exposed signatures.