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

Get one charge

get

/fscmRestApi/resources/11.13.18.05/salesOrdersForOrderHubRequests/{OrderKey}/child/lines/{linesUniqID}/child/charges/{chargesUniqID}

Request

Path Parameters
  • Value that uniquely identifies the sales order. This value is derived by concatenating the value of SourceOrderSystem, a colon, and the value of SourceOrderId. For orders created through the Oracle Order Management Cloud work area, the SourceOrderId is same as the HeaderId. For example, if SourceOrderSystem is LEG and SourceOrderId is R13_Sample_Order, the value of this attribute is LEG:R13_Sample_Order.
  • This is the hash key of the attributes which make up the composite key for the Charges resource and used to uniquely identify an instance of Charges. The client should not generate the hash key value. Instead, the client should query on the Charges collection resource in order to navigate to a specific instance of Charges to get the hash key.
  • 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.
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
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.

There's no request body for this operation.

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 : salesOrdersForOrderHubRequests-lines-charges-item-response
Type: object
Show Source
  • Maximum Length: 80
    Specifies where pricing applies the charge: for the item, for shipping, or for the return.
  • Maximum Length: 30
    Abbreviation that identifies where pricing applies the charge: for the item, for shipping, or for the return.
  • Value that indicates the average selling price of the unit. This average is the total sales revenue divided by total units sold.
  • Value that indicates the block allowance for a non-tiered consumption charge. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.
  • Number that represents the size of the block for charge calculation for a tier. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.
  • Charge Components
    Title: Charge Components
    The Charge Components resource manages price details for the order line, including price elements and amounts.
  • Maximum Length: 1000
    Value that indicates the charge currency.
  • Maximum Length: 1000
    Abbreviation that identifies the charge currency. Charge types include Goods sale, Service sale, Financing Vs. Lease, Shipping related charges, Restocking Penalties, Special charges, and so on.
  • Maximum Length: 80
    Charge definition that defines the price type, charge type, and charge subtype.
  • Maximum Length: 30
    Abbreviation that identifies the charge definition. A charge definition defines the price type, charge type, and charge subtype.
  • Maximum Length: 80
    Type of charge subtype. A charge definition defines the price type, charge type, and charge subtype.
  • Maximum Length: 30
    Abbreviation that identifies the charge subtype.
  • Charge Tiers
    Title: Charge Tiers
    The Charge Tiers resource manages details about tier definitions for charges. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.
  • Maximum Length: 80
    Type of a given charge. Charge types include Goods sale, Service sale, Financing Vs. Lease, Shipping related charges, Restocking Penalties, Special charges, and so on.
  • Maximum Length: 30
    Abbreviation that identifies the type of a given charge. Charge types include Goods sale, Service sale, Financing Vs. Lease, Shipping related charges, Restocking Penalties, Special charges, and so on.
  • Price for each unit. Determined from the price list on the pricing strategy.
  • Links
  • Abbreviation that identifies the unit of measure for the priced quantity, such as Ton.
  • Maximum Length: 25
    Unit of measure for priced quantity.
  • Maximum Length: 3
    Abbreviation that identifies the unit of measure for priced quantity, such as Ton.
  • Maximum Length: 25
    Periodicity for recurring price types, such as month, quarter, or year.
  • Maximum Length: 30
    Abbreviation that identifies the price periodicity.
  • Maximum Length: 240
    Type of price, such as one time, recurring, and so on.
  • Maximum Length: 30
    Abbreviation that identifies the type of price, such as one time, recurring, and so on.
  • Maximum Length: 1
    Contains one of the following values: true or false. If true, then the charge is the primary charge. If false, then the charge is not the primary charge. For Oracle Fusion application priced orders, the default value is set based on the pricing setup. For pre-priced orders, the value is entered by the user.
  • Maximum Length: 1
    Contains one of the following values: true or false. If true, then the charge is a rollup or an aggregate charge. If false, then the charge is not a rollup or an aggregate charge. For Oracle Fusion application priced orders, the default value is set based on the pricing setup. For pre-priced orders, the default value is false.
  • Sequence number for the charge.
  • Maximum Length: 120
    Value that uniquely identifies the charge. The source application that captured the transaction applies this value.
  • Maximum Length: 80
    Value that identifies whether the applicability of the tier is for all tiers or the highest tier. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.
  • Maximum Length: 30
    Abbreviation that identifies the applicability of the tier whether all tiers or the highest tier. A list of accepted values is defined in the lookup type ORA_QP_TIER_GRADUATED_TYPES. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.
  • Maximum Length: 1000
    Abbreviation that identifies the currency that pricing used to price the transaction.
  • Maximum Length: 3
    Abbreviation that identifies the unit of measure for the ordered quantity.
  • Maximum Length: 1
    Contains one of the following values: true or false. If true, then use the usage pricing. If false, then do not use the usage pricing. This attribute does not have a default value. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.
Nested Schema : Charge Components
Type: array
Title: Charge Components
The Charge Components resource manages price details for the order line, including price elements and amounts.
Show Source
Nested Schema : Charge Tiers
Type: array
Title: Charge Tiers
The Charge Tiers resource manages details about tier definitions for charges. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.
Show Source
Nested Schema : salesOrdersForOrderHubRequests-lines-charges-chargeComponents-item-response
Type: object
Show Source
Nested Schema : salesOrdersForOrderHubRequests-lines-charges-chargeTiers-item-response
Type: object
Show Source
Links
chargeComponents
Parameters:
  • OrderKey: $request.path.OrderKey
  • chargesUniqID: $request.path.chargesUniqID
  • linesUniqID: $request.path.linesUniqID
The Charge Components resource manages price details for the order line, including price elements and amounts.
chargeTiers
Parameters:
  • OrderKey: $request.path.OrderKey
  • chargesUniqID: $request.path.chargesUniqID
  • linesUniqID: $request.path.linesUniqID
The Charge Tiers resource manages details about tier definitions for charges. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.
Back to Top

Examples

This example describes how to get one charge.

Example cURL Command

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

curl -i -X GET \
-H "Authorization:Basic c2Ntb3BlcmF0aW9uczpXZWxjb21lMQ==" \
-H "REST-Framework-Version:4" \
-H "prefer:return=representation" \
-H "Content-Type:application/json" \
'https://servername/fscmRestApi/resources/version/salesOrdersForOrderHubRequests/GPR%3AR13_Rest_stage_01/child/lines/00050000000EACED00057708000001764CC49C2A000000115231335F526573745F73746167655F30310000000131000000013100000003475052/child/charges/00060000000EACED00057708000001764CC49C2A000000024331000000115231335F526573745F73746167655F30310000000131000000013100000003475052'

Example Response Body

The following shows an example of the response body in JSON format.

{
	"ApplyToCode" : null,
	"ApplyTo" : "Price",
	"AverageUnitSellingPrice" : null,
	"ChargeCurrencyCode" : null,
	"ChargeCurrency" : null,
	"ChargeDefinition" : null,
	"ChargeDefinitionCode" : null,
	"ChargeSubType" : "Price",
	"ChargeSubtypeCode" : null,
	"ChargeType" : "Sale",
	"ChargeTypeCode" : null,
	"GSAUnitPrice" : null,
	"PricePeriodicityCode" : null,
	"PricePeriodicity" : null,
	"PriceType" : "One time",
	"PriceTypeCode" : null,
	"PricedQuantity" : 2,
	"PricedQuantityUOM" : null,
	"PricedQuantityUOMCode" : null,
	"PrimaryFlag" : true,
	"RollupFlag" : null,
	"SequenceNumber" : 1,
	"SourceChargeId" : "C1",
	"TransactionalCurrencyCode" : null,
	"TransactionalUOMCode" : null,
	"links" : [ {
		"rel" : "self",
		"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHubRequests/GPR%3AR13_Rest_stage_01/child/lines/00050000000EACED00057708000001764CC49C2A000000115231335F526573745F73746167655F30310000000131000000013100000003475052/child/charges/00060000000EACED00057708000001764CC49C2A000000024331000000115231335F526573745F73746167655F30310000000131000000013100000003475052",
		"name" : "charges",
		"kind" : "item",
		"properties" : {
			"changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
		}
	}, {
		"rel" : "canonical",
		"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHubRequests/GPR%3AR13_Rest_stage_01/child/lines/00050000000EACED00057708000001764CC49C2A000000115231335F526573745F73746167655F30310000000131000000013100000003475052/child/charges/00060000000EACED00057708000001764CC49C2A000000024331000000115231335F526573745F73746167655F30310000000131000000013100000003475052",
		"name" : "charges",
		"kind" : "item"
	}, {
		"rel" : "parent",
		"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHubRequests/GPR%3AR13_Rest_stage_01/child/lines/00050000000EACED00057708000001764CC49C2A000000115231335F526573745F73746167655F30310000000131000000013100000003475052",
		"name" : "lines",
		"kind" : "item"
	}, {
		"rel" : "child",
		"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHubRequests/GPR%3AR13_Rest_stage_01/child/lines/00050000000EACED00057708000001764CC49C2A000000115231335F526573745F73746167655F30310000000131000000013100000003475052/child/charges/00060000000EACED00057708000001764CC49C2A000000024331000000115231335F526573745F73746167655F30310000000131000000013100000003475052/child/chargeComponents",
		"name" : "chargeComponents",
		"kind" : "collection"
	} ]
}
Back to Top