Search Results pay_cnu_api




Overview
Explore in AI Chat

Overview

PAY_CNU_API is a PL/SQL package owned by the APPS schema that provides the programmatic interface for maintaining contribution usage records within Oracle Payroll. Contribution usages define how employer and employee contributions are classified and directed for statutory and voluntary deductions handled by Oracle Payroll's contribution framework, particularly in support of payroll flows such as pension and other benefit-related contribution processing.

The package conforms to the standard Oracle EBS API architecture. It is classified as an API in the ETRM repository for release 12.2.2 and appears with a VALID status. It follows the conventional pattern of a public API package (PAY_CNU_API) accompanied by a business logic layer (PAY_CNU_BUS1), which encapsulates the underlying validation and database manipulation rules. The API layer presents a controlled, supported entry point for creating, updating, and deleting contribution usage definitions while delegating detailed processing to the private business logic and Oracle's HR_API error-handling utilities.

Key Procedures and Functions

The documented interface exposes three procedures, following the standard insert-update-delete lifecycle pattern used across Oracle Payroll APIs:

  • CREATE_CONTRIBUTION_USAGE — Defines a new contribution usage record. It validates the supplied attributes against the contribution framework rules and inserts a corresponding row into the underlying usage table, returning the standard API outcome through the HR_API error stack.
  • UPDATE_CONTRIBUTION_USAGE — Modifies the attributes of an existing contribution usage. It validates the changes against existing payroll contribution configuration and updates the stored record while preserving referential integrity with related contribution definitions.
  • DELETE_CONTRIBUTION_USAGE — Removes a contribution usage definition. The procedure applies the standard Oracle API deletion semantics, including validation that the record is not referenced by dependent contribution or payroll processing data before the row is removed.

Detailed parameter lists are intentionally not restated here; callers should consult the package specification and the Oracle Payroll API documentation for the exact signature and mandatory columns for each procedure.

Tables Accessed

The documented table access for this package is PAY_FR_CONTRIBUTION_USAGES, referenced through the APPS synonym layer. This table stores the contribution usage definitions that the API procedures insert, update, and delete. The CREATE and DELETE procedures write to this table, while UPDATE modifies existing rows. Queries against the table support the validation performed during each operation, ensuring that contribution usage data remains consistent with the payroll contribution setup.

Usage Notes

PAY_CNU_API is a server-side API and is not intended for direct invocation from the application user interface. It is typically called from:

  • Custom PL/SQL extensions and Oracle EBS concurrent programs that need to maintain contribution usage data programmatically.
  • Other Oracle Payroll packages — the ETRM dependency report indicates that PAY_CNU_BUS1 references this package, reflecting the layered API-to-business-logic design.
  • Integration and data-conversion scripts that load contribution usage definitions during implementation or migration.

Callers should follow standard Oracle API conventions: validate all inputs before calling, check the HR_API error stack for messages after each call, and commit only after successful completion. Because the package depends on HR_API and STANDARD, the calling session must have the appropriate APPS privileges and the standard EBS initialization (FND_GLOBAL.APPS_INITIALIZE) in place. As with all supported APIs, direct DML against PAY_FR_CONTRIBUTION_USAGES should be avoided in favor of this interface to preserve data integrity and upgrade compatibility.