Search Results pay_us_deposit_advice_pkg




Overview
Explore in AI Chat

Overview

PAY_US_DEPOSIT_ADVICE_PKG is a PL/SQL package owned by the APPS schema in Oracle E-Business Suite, with a VALID status in both 12.1.1 and 12.2.2. It supports the Oracle Payroll (PAY) product family for United States legislation, specifically the generation and management of deposit advice output — the payment remittance documentation that communicates net pay distribution to employees and financial institutions. The package is registered as an API classification of OTHER within the ETRM repository, indicating it is an internal processing package rather than a formally published public API. Its dependency footprint includes PAY_REPORT_CATEGORIES and PAY_REPORT_GROUPS, which associate the deposit advice process with report definitions used when submissions are launched through the concurrent manager. The package is referenced by PAY_US_RULES, confirming that US payroll business rules invoke this unit during payroll action processing.

Key Procedures and Functions

Nine documented program units are contained within the package specification and body:

  • RANGE_CURSOR — Declares a cursor defining the range of assignment or action records to be processed, establishing the driver query for the deposit advice run.
  • CHECK_IF_ASSIGNMENT_PAID — Evaluates whether a given assignment has been paid within the processed period, serving as a gating check before advice output is produced.
  • ARCHIVE_ACTION_CREATION — Creates archive action records, preserving the state of processed payroll actions for audit or reprocessing purposes.
  • SORT_ACTION — Orders the qualifying action records to enforce deterministic processing sequence.
  • ACTION_CREATION — Creates the payroll action rows that represent the deposit advice processing activity within the payroll action framework.
  • ARCHIVE_DEINIT — Performs cleanup and de-initialization of the archive process after execution completes.
  • QUALIFYING_PROC — Applies the qualification criteria that determine which assignments or actions are eligible for deposit advice generation.
  • CHECK_IF_QUALIFIED_FOR_US — Performs US-specific qualification logic, ensuring only assignments meeting US legislative requirements proceed.
  • DAXML_RANGE_CURSOR — Declares the range cursor used for XML-based deposit advice output, supporting the electronic formatting of advice data.

Tables Accessed

The package reads and writes a broad set of Payroll and HR tables through APPS synonyms. Core assignment data is retrieved from PER_ALL_ASSIGNMENTS_F and PAY_ASSIGNMENT_ACTIONS, with PAY_ASSIGNMENT_ACTIONS_S providing the translated or secondary action attributes. Payroll context comes from PAY_PAYROLL_ACTIONS, PAY_ALL_PAYROLLS_F, and PAY_ACTION_INTERLOCKS, which coordinate action sequencing. Payment routing information is sourced from PAY_ORG_PAYMENT_METHODS_F, PAY_PERSONAL_PAYMENT_METHODS_F, PAY_PAYMENT_TYPES, and PAY_PRE_PAYMENTS. Assignment set filtering relies on HR_ASSIGNMENT_SETS and HR_ASSIGNMENT_SET_AMENDMENTS. PAY_ACTION_INFORMATION stores descriptive parameters and results associated with the deposit advice actions. PAY_REPORT_CATEGORIES and PAY_REPORT_GROUPS link the process to its concurrent program report definition.

Usage Notes

PAY_US_DEPOSIT_ADVICE_PKG is an internal payroll processing package and is not intended for direct invocation from custom forms or ad hoc PL/SQL. It is triggered indirectly through the US payroll action processing flow, where PAY_US_RULES references the package to generate deposit advice records during payroll run, prepayment, and archive phases. Administrators typically encounter it through the Submit Processes and Reports concurrent program when running deposit advice generation for US payrolls. Because the package manipulates PAY_ASSIGNMENT_ACTIONS and PAY_PAYROLL_ACTIONS directly, any diagnostics or re-execution should be performed only under Oracle Support guidance, and customizations should never hard-code references to its internal procedures, as their signatures are not published as stable API contracts.