Jump to

• Request
• Response
• Examples

Get one total

get

/fscmRestApi/resources/11.13.18.05/salesOrdersForOrderHub/{OrderKey}/child/totals/{OrderTotalId}

Request

Path Parameters

• OrderKey(required): string
  Value that uniquely identifies the sales order. It can have the following formats.
  
  - Concatenation of SourceOrderSystem, a colon, and the value of SourceTransactionId. For orders created through the Oracle Fusion Cloud Order Management work area, the SourceTransactionId is same as the HeaderId. For example, if SourceOrderSystem is LEG and SourceTransactionId is R13_Sample_Order, the value of this attribute is LEG:R13_Sample_Order. This format of the OrderKey in the URL always returns the latest version of the sales order. When a draft exists, that becomes the latest version of the sales order. When invoking GET sales order using this OrderKey format, the URLs in the "links" section point to the latest version of the sales order and the corresponding child objects.
  Example: /salesOrdersForOrderHub/LEG:R13_Sample_Order points to the latest version of the order with SourceTransactionId "R13_Sample_Order" in the SourceOrderSystem "LEG".
  
  - Primary key of the sales order, which is HeaderId. This format of the OrderKey is useful when the order has multiple revisions because it helps in accessing either the older version or the latest version of the order. When there's a draft revision then HeaderId can be used to access the processing order. When invoking GET sales order using this OrderKey format, the URLs in the "links" section also point to that specific version of the sales order and the corresponding child objects. Only the Get operation is supported on older revisions of the order.
  Example: /salesOrdersForOrderHub/12345 points to an order with HeaderId 12345.
  
  When a q parameter or query finder is used to GET an order that has multiple versions then the latest version has the OrderKey in the format <sourceOrderSystem>:<SourceTransactionId> whereas reference orders have OrderKey in the format of HeaderId.
• OrderTotalId(required): integer(int64)
  Value that uniquely identifies the total for the sales order.

Query Parameters

• dependency: string
  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>
• expand: string
  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).
• fields: string
  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
• links: string
  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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

There's no request body for this operation.

Back to Top

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.

Body ()

Root Schema : salesOrdersForOrderHub-totals-item-response

Type: object

Show Source

• CurrencyCode: string
  Maximum Length: 15

  Currency that the sales order total uses.
• CurrencyName: string
  Read Only: true

  Maximum Length: 255

  Name of the currency that the sales order total uses.
• DisplayName: string
  Maximum Length: 255

  Display name of the sales order total, displayed in the language that the sales order uses.
• EstimatedFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then Oracle Fusion Pricing estimates the total. For example, pricing might estimate total for a usage price. If false, then Oracle Fusion Pricing does not estimate the total.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrderTotalId: integer (int64)
  Value that uniquely identifies the total for the sales order.
• PrimaryFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the total is the primary total. If false, then the total is not the primary total. Each sales order includes only one primary total.
• TotalAmount: number
  Amount calculated for the sales order total.
• TotalCode: string
  Maximum Length: 30

  Abbreviation that identifies the definition that defines properties for the sales order total.
• totalComponents: array Total Components
  Title: Total Components

  The Total Components resource retrieves the components that determine the total price of a sales order.
• TotalGroup: string
  Maximum Length: 240

  Group of related totals. For example, total for a one-time charge, or total for adjustments on a one-time charge.
• TotalName: string
  Read Only: true

  Maximum Length: 255

  Name of the definition that defines properties for the sales order total.

{
    "type":"object",
    "properties":{
        "TotalCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the definition that defines properties for the sales order total.",
            "nullable":false,
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"Currency that the sales order total uses.",
            "nullable":true,
            "x-queryable":false
        },
        "PrimaryFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the total is the primary total. If false, then the total is not the primary total. Each sales order includes only one primary total.",
            "nullable":false,
            "x-queryable":false
        },
        "OrderTotalId":{
            "type":"integer",
            "description":"Value that uniquely identifies the total for the sales order.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TotalGroup":{
            "maxLength":"240",
            "type":"string",
            "description":"Group of related totals. For example, total for a one-time charge, or total for adjustments on a one-time charge.",
            "nullable":true,
            "x-queryable":false
        },
        "DisplayName":{
            "maxLength":"255",
            "type":"string",
            "description":"Display name of the sales order total, displayed in the language that the sales order uses.",
            "nullable":true,
            "x-queryable":false
        },
        "TotalName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the definition that defines properties for the sales order total.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EstimatedFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then Oracle Fusion Pricing estimates the total. For example, pricing might estimate total for a usage price. If false, then Oracle Fusion Pricing does not estimate the total.",
            "nullable":false,
            "x-queryable":false
        },
        "TotalAmount":{
            "type":"number",
            "description":"Amount calculated for the sales order total.",
            "nullable":false,
            "x-queryable":true
        },
        "totalComponents":{
            "title":"Total Components",
            "type":"array",
            "description":"The Total Components resource retrieves the components that determine the total price of a sales order.",
            "items":{
                "$ref":"#/components/schemas/salesOrdersForOrderHub-totals-totalComponents-item-response"
            }
        },
        "CurrencyName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the currency that the sales order total uses.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

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

• Array of: object salesOrdersForOrderHub-totals-totalComponents-item-response

{
    "title":"Total Components",
    "type":"array",
    "description":"The Total Components resource retrieves the components that determine the total price of a sales order.",
    "items":{
        "$ref":"#/components/schemas/salesOrdersForOrderHub-totals-totalComponents-item-response"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : salesOrdersForOrderHub-totals-totalComponents-item-response

Type: object

Show Source

• HeaderCurrencyCode: string
  Read Only: true

  Maximum Length: 15

  Abbreviation that identifies the currency that the order header uses.
• HeaderCurrencyExtendedAmount: number
  Read Only: true

  Extended amount, displayed in currency that the order header uses.
• HeaderCurrencyName: string
  Read Only: true

  Maximum Length: 255

  Name of the currency that the order header uses.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrderChargeComponentId: integer (int64)
  Value that identifies the charge component that stores the sales order total. Pricing might use more than one charge component when it calculates the total. For example, it can sum the values of more than one discount when it calculates the total discount.
• OrderTotalComponentId: integer (int64)
  Value that identifies the charge component that stores the sales order total.
• OrderTotalId: integer (int64)
  Value that identifies the sales order total.
• PriceElement: string
  Read Only: true

  Maximum Length: 255

  Name of the price element. For example, list price, net price, and so on.
• PriceElementCode: string
  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the price element.
• PriceElementUsage: string
  Read Only: true

  Maximum Length: 255

  Name of the price element usage.
• PriceElementUsageCode: string
  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies price element usage.

{
    "type":"object",
    "properties":{
        "OrderTotalComponentId":{
            "type":"integer",
            "description":"Value that identifies the charge component that stores the sales order total.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PriceElementCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the price element.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "HeaderCurrencyExtendedAmount":{
            "type":"number",
            "description":"Extended amount, displayed in currency that the order header uses.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HeaderCurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"Abbreviation that identifies the currency that the order header uses.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OrderTotalId":{
            "type":"integer",
            "description":"Value that identifies the sales order total.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PriceElement":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the price element. For example, list price, net price, and so on.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PriceElementUsageCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies price element usage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "HeaderCurrencyName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the currency that the order header uses.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OrderChargeComponentId":{
            "type":"integer",
            "description":"Value that identifies the charge component that stores the sales order total. Pricing might use more than one charge component when it calculates the total. For example, it can sum the values of more than one discount when it calculates the total discount.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PriceElementUsage":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the price element usage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

totalComponents

Operation: /fscmRestApi/resources/11.13.18.05/salesOrdersForOrderHub/{OrderKey}/child/totals/{OrderTotalId}/child/totalComponents

Parameters:

• OrderKey: $request.path.OrderKey
• OrderTotalId: $request.path.OrderTotalId

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 get one total.

Example cURL Command

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

curl -u username:password "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/OrderKey/child/totals/OrderTotalId"

For example, the following command gets one total:

curl -u username:password "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_sample_order_02/child/totals/300100185757515"

Example Response Body

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

{
	"OrderTotalId" : 300100185757515,
	"TotalName" : "Total Net Price",
	"TotalCode" : "QP_TOTAL_NET_PRICE",
	"TotalAmount" : 950,
	"CurrencyName" : "US Dollar",
	"CurrencyCode" : "USD",
	"TotalGroup" : "2.3.0",
	"PrimaryFlag" : false,
	"EstimatedFlag" : false,
	"DisplayName" : null,
	"links" : [ {
		"rel" : "self",
		"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_sample_order_02/child/totals/300100185757515",
		"name" : "totals",
		"kind" : "item",
		"properties" : {
			"changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78"
		}
	}, {
		"rel" : "canonical",
		"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_sample_order_02/child/totals/300100185757515",
		"name" : "totals",
		"kind" : "item"
	}, {
		"rel" : "parent",
		"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_sample_order_02",
		"name" : "salesOrdersForOrderHub",
		"kind" : "item"
	}, {
		"rel" : "child",
		"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_sample_order_02/child/totals/300100185757515/child/totalComponents",
		"name" : "totalComponents",
		"kind" : "collection"
	} ]
}

Back to Top