Search Results retention_level




Overview
Explore in AI Chat

Overview

APPS.PA_PROJECT_RETENTION_V is a reporting view in the Oracle E-Business Suite Projects (PA) module that consolidates project retention balances for billing and revenue analysis. Retention refers to the portion of a contract invoice amount withheld by a customer until satisfactory completion of the work; this view exposes retained, billed, and written-off amounts per project and customer so that finance and project accounting users can monitor the outstanding retention position across engagements.

The object is registered as a view owned by the APPS schema, with FND Design Data reference PA.PA_PROJECT_RETENTION_V, and is documented as VALID in ETRM for release 12.2.2. The design data classifies the view type as Internal, and the documentation carries the standard Oracle Internal Use Only warning: Oracle Corporation does not support direct access to applications data through this object except from standard Oracle Applications programs. In practice the view functions as a read-only reporting surface for retention information and is consumed by Oracle's own retention inquiry and billing-related concurrent programs rather than as a supported public interface.

Underlying Base Objects

Per the documented dependency information, PA_PROJECT_RETENTION_V is defined over the following base objects:

  • PA_PROJECT_RETENT (the primary underlying entity, referenced in the project dependencies block).
  • PA_SUMMARY_PROJECT_RETN (SYNONYM) — the summarized retention amounts that supply the retained, billed, and write-off figures.
  • PA_PROJECT_CUSTOMERS (SYNONYM) — supplies the project-to-customer relationship and identifiers.
  • PA_CUSTOMERS_V (VIEW) — provides the customer name and customer number attributes.
  • PA_LOOKUPS (VIEW) — resolves the retention level code to its descriptive name.

The view therefore joins retention summary data to project customer assignments and lookup-denormalized descriptions, producing a flat, query-friendly record set. Because several dependencies are synonyms or views rather than base tables, the view shields consumers from the underlying normalized structure in PA_SUMMARY_PROJECT_RETN and its associated retention billing rule tables.

Key Columns

The projected columns and their documented meanings are:

  • PROJECT_ID — Identifier of the project to which retention is retained.
  • CUSTOMER_ID — Identifier of the customer to which retention is retained.
  • CUSTOMER_NAME — Customer name.
  • CUSTOMER_NUMBER — Customer number.
  • RETENTION_LEVEL_CODE — Code indicating the level of the retention setup (for example, project or top task level).
  • RETENTION_LEVEL_NAME — Descriptive name of the retention level setup, resolved through PA_LOOKUPS.
  • INVPROC_CURRENCY_CODE — Invoice processing currency of the retention setup; all monetary columns are expressed in this currency.
  • TOTAL_RETAINED — Total retained amount for a project or top task based on the retention billing rule.
  • TOTAL_BILLED — Total billed amount for the project or top task based on the retention billing rule.
  • TOTAL_WRITE_OFF — Total write-off amount recorded on retention invoices.
  • RECORD_VERSION_NUMBER — Locking sequence number used for optimistic concurrency control.

All monetary values are held in the invoice processing currency identified by INVPROC_CURRENCY_CODE, so cross-currency aggregation requires conversion in the calling query.

Common Use Cases and Queries

The principal use case is retention analysis: determining how much has been withheld, how much has been billed against retention, and how much has been written off, at project, top task, or customer level. Typical queries filter by project or customer and aggregate the three monetary columns; because the view is internal and unsupported for direct access, queries should be treated as diagnostic or reporting aids rather than as part of a supported integration.

  • Retention position by project for a period-end billing review.
  • Customer-level exposure across all projects, supporting collections follow-up.
  • Reconciliation of retention write-offs against retention invoices.

The documented query text is:

SELECT PROJECT_ID, CUSTOMER_ID, CUSTOMER_NAME, CUSTOMER_NUMBER, RETENTION_LEVEL_CODE, RETENTION_LEVEL_NAME, INVPROC_CURRENCY_CODE, TOTAL_RETAINED, TOTAL_BILLED, TOTAL_WRITE_OFF, RECORD_VERSION_NUMBER FROM APPS.PA_PROJECT_RETENTION_V;

A representative filtered query is:

SELECT PROJECT_ID, CUSTOMER_NAME, INVPROC_CURRENCY_CODE, TOTAL_RETAINED, TOTAL_BILLED, TOTAL_WRITE_OFF FROM APPS.PA_PROJECT_RETENTION_V WHERE PROJECT_ID = :project_id AND TOTAL_RETAINED > 0 ORDER BY CUSTOMER_NAME;