1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Order Management
  4. Sales Orders for Order Hub
  5. Order Lines
  6. Charges
  7. Charge Components

Create one charge component

post

/fscmRestApi/resources/11.13.18.05/salesOrdersForOrderHub/{OrderKey}/child/lines/{linesUniqID}/child/charges/{OrderChargeId}/child/chargeComponents

Request

Path Parameters
  • The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
  • The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
  • This is the hash key of the attributes which make up the composite key for the Order Lines resource and used to uniquely identify an instance of Order Lines. The client should not generate the hash key value. Instead, the client should query on the Order Lines collection resource in order to navigate to a specific instance of Order Lines to get the hash key.
Header Parameters
  • 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".
  • 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.
  • 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
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Maximum Length: 255
    Name of the currency that the charge component uses.
  • Maximum Length: 15
    Abbreviation that identifies the currency that the charge component uses.
  • Extended amount for the duration displayed in the currency that the charge uses.
  • Extended amount displayed in the currency that the charge uses. Extended amount equals the unit price multiplied by the quantity on the order line. For a configured item, the extended amount equals the unit price multiplied by the extended quantity on the order line.
  • Price or adjustment for each unit displayed in the charge currency that the order line uses.
  • Maximum Length: 1000
    Explanation of the charge component.
  • Maximum Length: 30
    Message name of the explanation that displays in the price break down dialog.
  • Maximum Length: 255
    Name of the currency that the order header uses.
  • Maximum Length: 15
    Abbreviation that identifies the currency that the order header uses.
  • Extended amount for the duration, displayed in the currency that the order header uses.
  • Extended amount, displayed in the currency that the order header uses.
  • Price or adjustment for each unit of the item, displayed in the currency that the order header uses.
  • Percent that the unit price constitutes of the basis charge component. The default value for the basis is List Price. This attribute stores the margin percent, the percent that net price constitutes of the list price, and so on.
  • Maximum Length: 255
    Name of the price element, such as list price, net price, and so on.
  • Maximum Length: 30
    Abbreviation that identifies the price element.
  • Maximum Length: 255
    Name that describes charge component usage.
  • Maximum Length: 30
    Abbreviation that identifies the charge component usage.
  • Maximum Length: 30
    Value that identifies the source of the lowest level pricing. For example, it contains the Id that identifies a line on the price list, a tier rule, a shipping line, and so on.
  • Maximum Length: 255
    Type of the price source.
  • Maximum Length: 30
    Type of the price source, such as the charge of a segment price list. A list of accepted values is defined in the lookup type ORA_QP_SOURCE_TYPES.
  • Maximum Length: 100
    Identifies the promo code linked to the promotions that resulted in this benefit. This is populated for all promotion charge components by Oracle Fusion Pricing for promotions linked to the promo code.
  • Uniquely identifies the pricing promotion that resulted in this benefit. This gets populated for all promotion charge components by Oracle Fusion Pricing.
  • Uniquely identifies the pricing promotion line that resulted in this benefit. This gets populated for all promotion charge components by Oracle Fusion Pricing.
  • Maximum Length: 1
    Contains one of the following values: true or false. If true, then the value is a rollup value for the charge component. If false, then the value isn't a rollup value. For Oracle Fusion application priced orders, the default value is set based on the pricing setup. For prepriced orders, the default value is false.
  • Sequence number for the charge component.
  • Maximum Length: 50
    Value that uniquely identifies the charge component. The source application assigns this value.
  • Maximum Length: 50
    Value that identifies the source of a manual price adjustment.
  • Maximum Length: 1
    Default Value: false
    Contains one of the following values: true or false. If true, then the price for the charge component includes tax. If false, then the price for the charge component doesn't include tax. For Oracle Fusion application priced orders, the default value is set based on the pricing setup. For prepriced orders, the default value is false.
  • Total Components
    Title: Total Components
    The Total Components resource retrieves the components that determine the total price of a sales order.
Nested Schema : Total Components
Type: array
Title: Total Components
The Total Components resource retrieves the components that determine the total price of a sales order.
Show Source
Nested Schema : salesOrdersForOrderHub-lines-charges-chargeComponents-totalComponents-item-post-request
Type: object
Show Source
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : salesOrdersForOrderHub-lines-charges-chargeComponents-item-response
Type: object
Show Source
  • Maximum Length: 255
    Name of the currency that the charge component uses.
  • Maximum Length: 15
    Abbreviation that identifies the currency that the charge component uses.
  • Extended amount for the duration displayed in the currency that the charge uses.
  • Extended amount displayed in the currency that the charge uses. Extended amount equals the unit price multiplied by the quantity on the order line. For a configured item, the extended amount equals the unit price multiplied by the extended quantity on the order line.
  • Price or adjustment for each unit displayed in the charge currency that the order line uses.
  • Maximum Length: 1000
    Explanation of the charge component.
  • Maximum Length: 30
    Message name of the explanation that displays in the price break down dialog.
  • Maximum Length: 255
    Name of the currency that the order header uses.
  • Maximum Length: 15
    Abbreviation that identifies the currency that the order header uses.
  • Extended amount for the duration, displayed in the currency that the order header uses.
  • Extended amount, displayed in the currency that the order header uses.
  • Price or adjustment for each unit of the item, displayed in the currency that the order header uses.
  • Links
  • Read Only: true
    Value that uniquely identifies the transaction.
  • Percent that the unit price constitutes of the basis charge component. The default value for the basis is List Price. This attribute stores the margin percent, the percent that net price constitutes of the list price, and so on.
  • Maximum Length: 255
    Name of the price element, such as list price, net price, and so on.
  • Maximum Length: 30
    Abbreviation that identifies the price element.
  • Maximum Length: 255
    Name that describes charge component usage.
  • Maximum Length: 30
    Abbreviation that identifies the charge component usage.
  • Maximum Length: 30
    Value that identifies the source of the lowest level pricing. For example, it contains the Id that identifies a line on the price list, a tier rule, a shipping line, and so on.
  • Maximum Length: 255
    Type of the price source.
  • Maximum Length: 30
    Type of the price source, such as the charge of a segment price list. A list of accepted values is defined in the lookup type ORA_QP_SOURCE_TYPES.
  • Maximum Length: 100
    Identifies the promo code linked to the promotions that resulted in this benefit. This is populated for all promotion charge components by Oracle Fusion Pricing for promotions linked to the promo code.
  • Uniquely identifies the pricing promotion that resulted in this benefit. This gets populated for all promotion charge components by Oracle Fusion Pricing.
  • Uniquely identifies the pricing promotion line that resulted in this benefit. This gets populated for all promotion charge components by Oracle Fusion Pricing.
  • Maximum Length: 1
    Contains one of the following values: true or false. If true, then the value is a rollup value for the charge component. If false, then the value isn't a rollup value. For Oracle Fusion application priced orders, the default value is set based on the pricing setup. For prepriced orders, the default value is false.
  • Sequence number for the charge component.
  • Maximum Length: 50
    Value that uniquely identifies the charge component. The source application assigns this value.
  • Maximum Length: 50
    Value that identifies the source of a manual price adjustment.
  • Maximum Length: 1
    Default Value: false
    Contains one of the following values: true or false. If true, then the price for the charge component includes tax. If false, then the price for the charge component doesn't include tax. For Oracle Fusion application priced orders, the default value is set based on the pricing setup. For prepriced orders, the default value is false.
  • Total Components
    Title: Total Components
    The Total Components resource retrieves the components that determine the total price of a sales order.
Nested Schema : Total Components
Type: array
Title: Total Components
The Total Components resource retrieves the components that determine the total price of a sales order.
Show Source
Nested Schema : salesOrdersForOrderHub-lines-charges-chargeComponents-totalComponents-item-response
Type: object
Show Source
Links
totalComponents
Parameters:
  • OrderChargeComponentId: $request.path.OrderChargeComponentId
  • OrderChargeId: $request.path.OrderChargeId
  • OrderKey: $request.path.OrderKey
  • linesUniqID: $request.path.linesUniqID
The Total Components resource retrieves the components that determine the total price of a sales order.
Back to Top

Examples

This example describes how to add a component.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/{OrderKey}/child/lines/linesUniqID/child/charges/OrderChargeId/child/chargeComponents"

For example, use the following command:

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Prepriced_Std_01/child/lines/00020000000EACED00057708000110F09BD2F2E60000000EACED00057708000110F09BD2F2E7/child/charges/300100569201214/child/chargeComponents"

Example Request Body

The following example includes the contents of the request body in JSON format to add a new charge component to an order line charge in the existing order.

You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.

You can achieve the same result with Create sales orders using the upsert-mode header parameter. Refer to the examples in the Create sales orders section to see how to update child resource in the existing order.

{
    "SourceChargeComponentId":"C1-CC3",
    "PriceElementCode":"QP_NET_PRICE_PLUS_TAX",
    "PriceElementUsageCode":"NET_PRICE_PLUS_TAX",
    "HeaderCurrencyUnitPrice":16,
    "HeaderCurrencyExtendedAmount":16,
    "RollupFlag":false,
	"SequenceNumber":3
}

Example Response Body

The following example includes the contents of the response body in JSON format:

{
}
Back to Top