1. Using Revenue Management
  2. Overview of the Source Document Lines REST API

Overview of the Source Document Lines REST API

Use the Source Document Lines Rest API to edit data from source document lines imported from Fusion source applications.

You can use the service to change or add data on the source document line to help allocation and revenue recognition treatment.

With this service, you can update attributes such as:

  • The unit standalone selling price
  • Attributes to trigger prospective accounting
  • Attributes to add lines to existing contracts

This feature is applicable to all cloud source document types.

To use the Source Document Lines REST API to update source document line data for a source document type, you must first enable the Allow updates from REST service option for your source document type in the Manage Source Document Types page.

When you enable the Allow updates from REST service option for a cloud source document type, the application assigns a temporary data transformation status of FUSION_REST_UPDATE to the source document lines. All the source document lines with a data transformation status of FUSION_REST_UPDATE are available in the REST API and you can update the eligible attributes.

Query the source document lines using attributes such as the source document number, item, customer purchase order number, and source document line unique identifiers. You can then update the eligible attributes in each source document line using the REST API. After updating the required attributes, set the source document line's data transformation status attribute to FUSION_REST_INIT. The line is now eligible for further processing by the application.

Run the Validate Customer Contract Source Data process to validate the source document lines updated by the REST API to ensure the changes are correct. Any lines that don't pass the validation are eligible for correction using the Correct Contract Document Errors spreadsheet.

Enable and Use the Source Document Lines REST API

To validate your updated source document lines:

  1. Navigate to the Setup and Maintenance work area.
  2. Search for the Manage Source Document Types task.
  3. In the Manage Source Document Types page, enable the Allow Updates from REST Service checkbox for the source document type you want to update.
  4. Import the data from Cloud Applications into Oracle Revenue Management.
  5. Run the Validate Customer Contract Source Data process.
  6. Query the required source document lines and update the necessary attributes using the Source Document Lines REST API.
  7. Update the Data Transformation Status of all the source document lines to FUSION_REST_INIT.
  8. Run the Validate Customer Contract Source Data process.
  9. If there are any errors, correct them using the Correct Contract Document Errors spreadsheet.
  10. Run the Validate Customer Contract Source Data process to validate that the source document lines that were corrected in the spreadsheet.
  11. Run the Identify Customer Contracts process.
Note: You can also use the Revenue Basis Data Import file-based data import (FBDI) template to update these attributes for revenue basis data of third-party sources.

See the Using Revenue Management guide for information about how to import revenue data using the Revenue Basis Data Import file-based data import template.

Update Source Document Line Attributes

Use the Source Document Lines REST API to update eligible attributes in each source document line.

This table lists the source document line attributes that can be updated using the REST API.

Source Document Line Attributes

Attribute Name Column Name
Immaterial Change Type IMMATERIAL_CHANGE_CODE
Contract Revision Date CONTRACT_MODIFICATION_DATE
Termination Date TERMINATION_DATE
Add to existing contract ADD_TO_CONTRACT_FLAG
Action code for adding new line to existing contract ADD_TO_CONTRACT_ACTION_CODE
Document Type Code of the Parent Line INITIAL_DOCUMENT_TYPE_CODE
Parent source document line unique identifier number 1 to 5 INITIAL_DOC_LINE_ID_INT_1 to 5
Parent source document line unique identifier character 1 to 5 INITIAL_DOC_LINE_ID_CHAR_1 to 5
Parent Line Source System INITIAL_SOURCE_SYSTEM
Unit SSP UNIT_SSP
Data Transformation Status DATA_TRANSFORMATION_STATUS

After you update the attributes as required, set the Data Transformation Status attribute to FUSION_REST_INIT to enable the line for further processing.

For more information, see the REST API for Oracle Fusion Cloud Financials guide.