Source Document Line Attribute Updates Using a REST API
Use the Source Document Lines REST API to update the source document line unit standalone selling price or contract modification line attributes.
Use this REST API to adjust the revenue basis data imported from source systems to facilitate allocation and revenue recognition of the customer contract. With this service, you can suspend processing of revenue basis data, and update key attributes of source document lines such as the unit standalone selling price, attributes that trigger prospective accounting, or attributes to add lines to existing contracts while using the ready to use integrations.
You can update the following attributes of source document lines using this 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 |
To use the Source Document Lines REST API to update revenue basis data for a source document type, you must first check the 'Allow updates from REST service' option in the Manage Source Document Types page.
Manage Source Document Types page
When you enable the Allow updates from REST service option for a source document type, the application will not validate the source document lines belonging to this source document type. A temporary data transformation status of FUSION_REST_UPDATE is assigned to these lines.
All source document lines with the FUSION_REST_UPDATE data transformation status are available in the REST API.
Query the source document lines to update using attributes such as 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, update the data transformation status to FUSION_REST_INIT.
The Validate Customer Contract Source Data process will process the source document lines with the data transformation status of FUSION_REST_INIT. The lines that pass through the validations are further processed by the Identify Customer Contracts process. The lines that fail the validations can be corrected through the error correction spreadsheet.
The next time you run the Identify Customer Contracts process, it processes the updated source document lines.
To use this feature, complete the required steps in this order:
- Enable the Allow Updates from REST Service checkbox for the source document type you want to make updates through REST API.
- Import the data (from Cloud Applications) into Oracle Revenue Management.
- Run the Validate Customer Contract Source Data process.
- Query the required source document lines and update the necessary attributes using the Source Document Lines REST API.
- Update the Data Transformation Status of all the source document lines to FUSION_REST_INIT.
- Run the Validate Customer Contract Source Data process.
- Correct errors, if any, using the Correct Contract Document Errors in Spreadsheet.
- Run Validate Customer Contract Source Data process to validate the source document lines that are corrected in the spreadsheet.
- Run the Identify Customer Contracts process.
You can now update key attributes of source document lines such as the unit standalone selling price, attributes that trigger prospective accounting, or attributes to add lines to existing contracts through a REST API without having to do additional configurations in the ready to use integrations.
Steps to Enable
You don't need to do anything to enable this feature.
Tips And Considerations
- This feature is applicable to all cloud source document types.
- Use Revenue Basis Data Import (FBDI) to update these attributes for revenue basis data of third party sources.
Key Resources
- Overview of the Source Document Lines REST API
- Enable and Use the Source Document Lines REST API
- Update Source Document Line Attributes
- Refer to the Using Revenue Management guide for further information on processing immaterial changes and how to import revenue data using the Revenue Basis Data Import file-based data import template.
Access Requirements
No new role access is needed to use this feature.