Search Results pay_qpq_api




Overview
Explore in AI Chat

Overview

PAY_QPQ_API is the public PL/SQL API for Oracle Payroll QuickPay processing within Oracle E-Business Suite 12.1.1 and 12.2.2. QuickPay is the mechanism by which a payroll administrator runs a single assignment through payroll on demand, outside the normal payroll cycle, typically to verify element entries, balances, or deductions before committing a full payroll run. The package encapsulates the creation, validation, and lifecycle management of the payroll action record that represents a QuickPay request, insulating callers from the underlying table structures and business rules.

The package is declared AUTHID CURRENT_USER and is owned by APPS. Its header carries the R12 version identifier (pyqpqrhi.pkh 120.0.12010000.2), confirming its presence across the 12.1.1 and 12.2.2 code lines. It exposes seventeen documented procedures and functions and is referenced by five other packages, indicating its role as a shared service rather than a standalone utility.

Key Procedures and Functions

The documented entry points fall into three groups: validation, data manipulation, and process control.

  • USE_QPAY_EXCL_MODEL — Returns 'Y' when the newer QuickPay Exclusions model is available, or 'N' when the obsolete QuickPay Inclusions model is still in use. It raises an exception if the QuickPay upgrade is in progress.
  • CHK_ASG_ON_PAYROLL, CHK_NEW_EFF_DATE, CHK_EFF_DATE, CHK_DATE_EARNED, CHK_FOR_CON_REQUEST — Validation routines. They confirm that the assignment is attached to the payroll, that the effective date and date earned satisfy payroll and consolidation rules, and that no conflicting consolidation request exists.
  • LCK, INS, UPD, DEL — The standard table-handler quartet providing row locking, insert, update, and delete against the payroll action row.
  • DEFAULT_VALUES — Populates default column values for a new QuickPay action record.
  • RETURN_API_DML_STATUS — Returns the DML status of the most recent API operation.
  • START_QUICKPAY_PROCESS, WAIT_QUICKPAY_PROCESS — Submit the QuickPay action for processing and, optionally, wait for its completion.

The global record type g_rec_type mirrors the PAY_PAYROLL_ACTIONS columns, including payroll_action_id, business_group_id, consolidation_set_id, action_status, effective_date, comments, current_task, legislative_parameters, run_type_id, date_earned, pay_advice_date, pay_advice_message, and object_version_number. Note that action_status was widened from length 1 to 9, a change callers must respect.

Tables Accessed

The package reads and writes a defined set of APPS-synonym tables. PAY_PAYROLL_ACTIONS and its sequence-backed sibling PAY_PAYROLL_ACTIONS_S hold the QuickPay action header. PAY_ASSIGNMENT_ACTIONS links the assignment to the action. PAY_CONSOLIDATION_SETS and PER_TIME_PERIODS support date and consolidation validation. PAY_QUICKPAY_EXCLUSIONS supports the exclusions model check, while PAY_ELEMENT_CLASSIFICATIONS, PAY_ELEMENT_ENTRIES_F, PAY_ELEMENT_ENTRY_VALUES_F, PAY_ELEMENT_LINKS_F, PAY_ELEMENT_TYPES_F, PAY_INPUT_VALUES_F, PAY_LEGISLATION_RULES, and PAY_LEGISLATIVE_FIELD_INFO supply element and legislative validation data. FND_SESSIONS is used for session context.

Usage Notes

PAY_QPQ_API is principally invoked by the QuickPay window in the Oracle Payroll forms, and by the concurrent programs that submit and monitor QuickPay runs. Custom code performing bulk or automated QuickPay should call the validation functions before INS, call START_QUICKPAY_PROCESS to submit, and use WAIT_QUICKPAY_PROCESS or RETURN_API_DML_STATUS to determine outcome. Because validation depends on legislative rules and the exclusions model, customisations should always test USE_QPAY_EXCL_MODEL rather than assuming either model. Direct DML against PAY_PAYROLL_ACTIONS should be avoided in favour of these documented entry points.