Search Results pqh_budgets_api




Overview
Explore in AI Chat

Overview

PQH_BUDGETS_API is an Oracle E-Business Suite PL/SQL application programming interface owned by the APPS schema and classified as an API within the ETRM documentation set. It belongs to the Oracle HRMS budget management modules under the PQH (Public Sector / HR Budgeting) product family, which governs position budgeting and budget allocation for public sector and workforce planning deployments. The package exposes a controlled, business-rule-validated interface for maintaining budget records stored in the underlying budget table, insulating callers from the physical data model and from the validation logic that governs budget creation, modification, and removal.

The package is a foundational element of the budget object hierarchy. According to the documented dependency metadata, it is referenced by four other packages — PQH_APPLY_BUDGET, PQH_BUDGET_DATA_MIGRATION, PQH_BVR_UPD, and PQH_WKS_INS — in addition to recursive references within its own body. This indicates that budget maintenance is a service consumed both by transactional budget application processes and by bulk data migration and worksheet insertion routines. Internally, PQH_BUDGETS_API depends on the HR_API utility package and the SYS.STANDARD package, confirming its role as a validated HRMS API that follows Oracle's standard API conventions.

Key Procedures and Functions

The documented interface consists of three procedures:

  • CREATE_BUDGET — Inserts a new budget record into the budget schema. Callers use this procedure to establish a budget for a position, organization, or budget period. The API applies the required validations and derivations before the row is written, ensuring that the record conforms to HRMS budget rules.
  • UPDATE_BUDGET — Modifies an existing budget record. This procedure is the supported mechanism for amending budget amounts or attributes after a budget has been created, and it re-applies validation logic so that dependent data remains consistent.
  • DELETE_BUDGET — Removes a budget record. Deletion through the API ensures that referential and business-rule checks are performed before the row is removed, rather than relying on direct SQL against the base table.

The parameter signatures of these procedures are not reproduced in the available ETRM metadata; implementers should obtain the exact argument lists from the package specification in the database or from Oracle's HRMS API documentation before coding against the interface.

Tables Accessed

The documented base table accessed through APPS synonyms is PQH_BUDGETS. This table stores the budget records that the API creates, updates, and deletes. All three documented procedures operate on this single table, which is consistent with the package's focused responsibility: it is the maintenance API for the budget entity, while related processes such as budget application and worksheet handling are handled by the packages that reference it.

Usage Notes

PQH_BUDGETS_API is typically invoked from three contexts. First, from the HRMS budget forms, where user actions on budget records are routed through the API rather than directly to the table. Second, from concurrent programs and batch processes — notably PQH_BUDGET_DATA_MIGRATION, which uses the API to load budget data during implementation or conversion. Third, from custom extensions and other PL/SQL packages that must create or maintain budgets as part of a larger business flow. Because the package validates all input, direct DML against PQH_BUDGETS should be avoided; using the API preserves data integrity and protects customizations from future changes to the underlying validation logic. As with all APPS APIs, the package should be called with the correct initialization of the HR security context so that business group and security profile restrictions are honored.