Create a transaction descriptive flex field
post
/fscmRestApi/resources/11.13.18.05/incentiveCompensationTransactions/{TransactionId}/child/TransactionsDFF
Request
Path Parameters
-
TransactionId(required): integer(int64)
The unique identifier of the transaction.
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Business Unit Context for Base Transaction Attributes
Maximum Length:30
The context segment for the descriptive flex field. -
__FLEX_Context_DisplayValue: string
Title:
Business Unit Context for Base Transaction Attributes
-
_Area_Code: string
Title:
Area Code
Maximum Length:360
The geographic transaction attribute for the area code. The area code is a component of a phone number and is usually a 3-digit number that identifies each telephone service area in a country. -
_Billing_Address: number
Title:
Customer Billing Address Location
The unique identifier of the customer billing location. -
_Billing_Contact: number
Title:
Customer Billing Contact
The unique identifier of the contact person at the bill-to location. -
_City: string
Title:
City
Maximum Length:360
The name of the city. -
_City_Display: string
Title:
City
-
_Country: string
Title:
Country
Maximum Length:360
The name of the country. -
_Country_Display: string
Title:
Country
-
_Postal_Code: string
Title:
Postal Code
Maximum Length:360
The postal code of the address. -
_Product_Item_ID: number
Title:
Line Item ID
The unique identifier of the inventory item. -
_Product_Item_ID_Display: string
Title:
Line Item ID
-
_Province: string
Title:
Province
Maximum Length:360
The name of the province. -
_Sales_Channel: string
Title:
Sales Channel
Maximum Length:30
The sales channel represents how the transaction was sold. For example, indirect or direct. -
_Shipping_Address: number
Title:
Shipping Address Location
The unique identifier of the customer's ship-to location. -
_Shipping_Contact: number
Title:
Customer Shipping Contact
The unique identifier of the contact person at the ship-to location. -
_Sold_To_Customer: number
Title:
Customer
The unique identifier of customer who purchased the items or services listed on the transaction. -
_Sold_To_Customer_Display: string
Title:
Customer
The name of the sold-to customer. -
_State: string
Title:
State
Maximum Length:360
The name of the state. -
_State_Display: string
Title:
State
-
TransactionId: integer
(int64)
Title:
Transaction ID
The unique identifier of the transaction.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : incentiveCompensationTransactions-TransactionsDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Business Unit Context for Base Transaction Attributes
Maximum Length:30
The context segment for the descriptive flex field. -
__FLEX_Context_DisplayValue: string
Title:
Business Unit Context for Base Transaction Attributes
-
_Area_Code: string
Title:
Area Code
Maximum Length:360
The geographic transaction attribute for the area code. The area code is a component of a phone number and is usually a 3-digit number that identifies each telephone service area in a country. -
_Billing_Address: number
Title:
Customer Billing Address Location
The unique identifier of the customer billing location. -
_Billing_Contact: number
Title:
Customer Billing Contact
The unique identifier of the contact person at the bill-to location. -
_City: string
Title:
City
Maximum Length:360
The name of the city. -
_City_Display: string
Title:
City
-
_Country: string
Title:
Country
Maximum Length:360
The name of the country. -
_Country_Display: string
Title:
Country
-
_Postal_Code: string
Title:
Postal Code
Maximum Length:360
The postal code of the address. -
_Product_Item_ID: number
Title:
Line Item ID
The unique identifier of the inventory item. -
_Product_Item_ID_Display: string
Title:
Line Item ID
-
_Province: string
Title:
Province
Maximum Length:360
The name of the province. -
_Sales_Channel: string
Title:
Sales Channel
Maximum Length:30
The sales channel represents how the transaction was sold. For example, indirect or direct. -
_Shipping_Address: number
Title:
Shipping Address Location
The unique identifier of the customer's ship-to location. -
_Shipping_Contact: number
Title:
Customer Shipping Contact
The unique identifier of the contact person at the ship-to location. -
_Sold_To_Customer: number
Title:
Customer
The unique identifier of customer who purchased the items or services listed on the transaction. -
_Sold_To_Customer_Display: string
Title:
Customer
The name of the sold-to customer. -
_State: string
Title:
State
Maximum Length:360
The name of the state. -
_State_Display: string
Title:
State
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
TransactionId: integer
(int64)
Title:
Transaction ID
The unique identifier of the transaction.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- LVVO_K__City
-
Parameters:
- finder:
ValidValuesFinder%3BBind_DataSource%3Doracle.apps.incentiveCompensation.cn.transactionProcessing.transactionManagement.flex.TransactionDFF.view.TransactionDFFORA_5FCN_5FCITYVSO
The following properties are defined on the LOV link relation:- Source Attribute: _City; Target Attribute: Id
- Display Attribute: Value
- finder:
- LVVO_K__Country
-
Parameters:
- finder:
ValidValuesFinder%3BBind_DataSource%3Doracle.apps.incentiveCompensation.cn.transactionProcessing.transactionManagement.flex.TransactionDFF.view.TransactionDFFORA_5FCN_5FCOUNTRYVSO
The following properties are defined on the LOV link relation:- Source Attribute: _Country; Target Attribute: Id
- Display Attribute: Value
- finder:
- LVVO_K__Product_Item_ID
-
Parameters:
- finder:
ValidValuesFinder%3BBind_DataSource%3Doracle.apps.incentiveCompensation.cn.transactionProcessing.transactionManagement.flex.TransactionDFF.view.TransactionDFFORA_5FCN_5FBASETRANS_5FITEM_5FNAMEVSO
The following properties are defined on the LOV link relation:- Source Attribute: _Product_Item_ID; Target Attribute: Id
- Display Attribute: Value
- finder:
- LVVO_K__Sold_To_Customer
-
Parameters:
- finder:
ValidValuesFinder%3BBind_DataSource%3Doracle.apps.incentiveCompensation.cn.transactionProcessing.transactionManagement.flex.TransactionDFF.view.TransactionDFFORA_5FCN_5FBASETRANS_5FCUSTOMER_5FNAMEVSO
The following properties are defined on the LOV link relation:- Source Attribute: _Sold_To_Customer; Target Attribute: Id
- Display Attribute: Value
- finder:
- LVVO_K__State
-
Parameters:
- finder:
ValidValuesFinder%3BBind_DataSource%3Doracle.apps.incentiveCompensation.cn.transactionProcessing.transactionManagement.flex.TransactionDFF.view.TransactionDFFORA_5FCN_5FSTATEVSO
The following properties are defined on the LOV link relation:- Source Attribute: _State; Target Attribute: Id
- Display Attribute: Value
- finder:
- LVVO_V___FLEX_Context
-
Parameters:
- finder:
ValidValuesFinder%3BBind_ApplicationId%3D283%2CBind_DescriptiveFlexfieldCode%3DCN_TP_BASETRANS_DFF
The following properties are defined on the LOV link relation:- Source Attribute: __FLEX_Context_DisplayValue; Target Attribute: Name
- Display Attribute: Name, Description
- finder:
- LVVO__City
-
Parameters:
- finder:
ValidValuesFinder%3BBind_DataSource%3Doracle.apps.incentiveCompensation.cn.transactionProcessing.transactionManagement.flex.TransactionDFF.view.TransactionDFFORA_5FCN_5FCITYVSO
The following properties are defined on the LOV link relation:- Source Attribute: _City_Display; Target Attribute: Value
- Display Attribute: Value
- finder:
- LVVO__Country
-
Parameters:
- finder:
ValidValuesFinder%3BBind_DataSource%3Doracle.apps.incentiveCompensation.cn.transactionProcessing.transactionManagement.flex.TransactionDFF.view.TransactionDFFORA_5FCN_5FCOUNTRYVSO
The following properties are defined on the LOV link relation:- Source Attribute: _Country_Display; Target Attribute: Value
- Display Attribute: Value
- finder:
- LVVO__Product_Item_ID
-
Parameters:
- finder:
ValidValuesFinder%3BBind_DataSource%3Doracle.apps.incentiveCompensation.cn.transactionProcessing.transactionManagement.flex.TransactionDFF.view.TransactionDFFORA_5FCN_5FBASETRANS_5FITEM_5FNAMEVSO
The following properties are defined on the LOV link relation:- Source Attribute: _Product_Item_ID_Display; Target Attribute: Value
- Display Attribute: Value
- finder:
- LVVO__Sold_To_Customer
-
Parameters:
- finder:
ValidValuesFinder%3BBind_DataSource%3Doracle.apps.incentiveCompensation.cn.transactionProcessing.transactionManagement.flex.TransactionDFF.view.TransactionDFFORA_5FCN_5FBASETRANS_5FCUSTOMER_5FNAMEVSO
The following properties are defined on the LOV link relation:- Source Attribute: _Sold_To_Customer_Display; Target Attribute: Value
- Display Attribute: Value
- finder:
- LVVO__State
-
Parameters:
- finder:
ValidValuesFinder%3BBind_DataSource%3Doracle.apps.incentiveCompensation.cn.transactionProcessing.transactionManagement.flex.TransactionDFF.view.TransactionDFFORA_5FCN_5FSTATEVSO
The following properties are defined on the LOV link relation:- Source Attribute: _State_Display; Target Attribute: Value
- Display Attribute: Value
- finder:
- LVVO___FLEX_Context
-
Parameters:
- finder:
ValidValuesFinder%3BBind_ApplicationId%3D283%2CBind_DescriptiveFlexfieldCode%3DCN_TP_BASETRANS_DFF
The following properties are defined on the LOV link relation:- Source Attribute: __FLEX_Context; Target Attribute: ContextCode
- Display Attribute: Name
- finder:
Examples
The following example shows how to create a transaction descriptive flex field by submitting a POST request on the REST resource using cURL.
cURL Command
curl --user
sales_cloud_user https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationTransactions/300100185275414/child/TransactionsDFF
Example of Request Body
The following shows an example of the request body in JSON format.
{ "_Area_Code": "12345" }
Response Body
The following shows an example of the response body in JSON format.
{ "TransactionId": 300100185275414, "_Sold_To_Customer": null, "_Sold_To_Customer_Display": null, "_Sales_Channel": null, "_Country": null, "_Country_Display": null, "_State": null, "_City": null, "_City_Display": null, "_Province": null, "_Area_Code": null, "_Postal_Code": null, "_Product_Item_ID": null, "_Product_Item_ID_Display": null, "_Billing_Address": null, "_Billing_Contact": null, "_Shipping_Address": null, "_Shipping_Contact": null, "_Transaction__DFF": null, "productGroup": null, "productGroup_Display": null, "catalogItemId": null, "corporate": null, "Team": null, "individual": null, "trigger": null, "productsold": null, "performance": null, "category": null, "task": null, "__FLEX_Context": "204", "__FLEX_Context_DisplayValue": "204", ... }
Note:
The TransactionId changes when a DFF is created. You must use the updated TransactionId to view the changes. You can get the updated TransactionId using this GET request:https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationTransactions?q=[TransactionNumber={TransactionNumber}];[TransactionType={TransactionType}]