Create Award Deobligation Modifications Using Public API

CLM customers can now use a dedicated API to create a modification that de-obligates funds from an approved Award. When the API request is submitted successfully, the system automatically generates the required Award modification and processes the de-obligation without requiring users to manually create the modification document.
Prior to this release, users were required to manually create and process Award modifications to de-obligate funds from approved Awards. This manual process increased administrative effort, introduced the potential for data entry errors, and limited automation opportunities for customers integrating CLM with external financial and acquisition systems.

This enhancement streamlines the de-obligation process by enabling customers to automate Award funding adjustments through a standard API. It reduces manual effort, improves data accuracy, and helps organizations process funding changes more efficiently while supporting integration with external business systems.
With this release, to modify awards created through PDOI or CLM interface, use the "PO_PDOI_MOD_PVT.create_award_mod" procedure. This API is applicable to only quantity-based lines.

Use the procedure to modify the following components of an award:

  • Update UDA attributes.
  • Change quantity, price, and fund values regardless of whether the award line is open or closed.
  • Update goods-based CLINs.

Scope of the API

  • Updating any UDA attribute is supported.
  • New lines cannot be added to a modification.
  • Award lines that refer to backing requisitions are supported.
  • Charge account changes cannot be made.
  • The GL date must be populated for the De-obligation process. If the profile "PO: Validate GL Period" is set to Redefault (R), then the date will be defaulted as system date if the existing GL date is in closed period.
  • Only quantity, price, and funded value changes are supported.
  • Only goods-based CLINs are supported.
  • Includes a logic to skip SGD and PDF generation.

Currently the API can process one modification at a time. But this API can be looped to create several modifications.

Steps to enable and configure

  • Verify that the CLM environment is updated to the release containing the Award De-Obligation Modification API. 
  • Ensure users or integration accounts have the required API access privileges and Award modification permissions. 
  • Configure or update external integrations to invoke the new API endpoint. 
  • Provide the required Award and funding de-obligation details in the API request payload. 
  • Submit the API request and review the response for successful processing. 
  • Validate that the system-generated modification has been created and approved according to organizational workflows. 

Tips and considerations

  • The Award must be in an approved status before a de-obligation modification can be created through the API. 
  • Ensure the requested de-obligation amount does not violate funding or accounting validation rules. 
  • Standard modification approval and audit processes continue to apply to system-generated modifications. 
  • Validate integration error handling to capture and respond to API validation or processing failures. 
  • Test the API in a non-production environment before deploying automated integrations to production. 
  • Review user roles and security privileges to ensure only authorized users and integrations can perform de-obligation actions.

Key resources

Oracle Contract Lifecycle Management for Public Sector Implementation Guide
Transfer of Information
R12.2.13 TOI: Implement and Use Contract Lifecycle Management for Public Sector - API for Modification to De-Obligate Award Funds