Get all charges
get
/fscmRestApi/resources/11.13.18.05/salesOrdersForOrderHub/{OrderKey}/child/lines/{linesUniqID}/child/charges
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. -
linesUniqID(required): string
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
-
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 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- PrimaryKey: Finds a charge for a line according to the primary key.
Finder Variables:- OrderChargeId; integer; Value that uniquely identifies the pricing charge.
- findBySourceChargeId: Finds a charge for a line according to the source charge identifier.
Finder Variables:- SourceChargeId; string; Value that uniquely identifies the charge. The source application applies this value.
- findBySourceIdAndParentId: Finds order charge with identifier of the charge and identifier of the parent entity for the charge.
Finder Variables:- ParentEntityId; string; Value that identifies the parent entity for the charge.
- SourceChargeId; string; Value that uniquely identifies the order charge.
- PrimaryKey: Finds a charge for a line according to the primary key.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
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 -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- ApplyToCode; string; Abbreviation that identifies where pricing applies the charge: for the item, for shipping, or for the return.
- AverageUnitSellingPrice; number; Weighted average of the selling price. This average is the total sales revenue divided by total units sold.
- BlockAllowance; number; 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.
- BlockSize; number; 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.
- CanAdjustFlag; boolean; Contains one of the following values: true or false. If true, then the charge is eligible for adjustment. If false, then the charge is not eligible for adjustment. 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.
- ChargeCurrencyCode; string; Abbreviation that identifies the charge currency.
- ChargeDefinition; string; Charge definition that defines the price type, charge type, and subtype.
- ChargeDefinitionCode; string; Abbreviation that identifies the charge definition.
- ChargePeriod; string; Charge period for the usage charge. The charge period determines how frequently Pricing and Subscription Management add up the usages for a usage charge.
- ChargePeriodCode; string; Abbreviation that identifies the charge period for the usage charge. The charge period determines how frequently Pricing and Subscription Management add up the usages for a usage charge.
- ChargeSubType; string; Charge subtype.
- ChargeSubtypeCode; string; Abbreviation that identifies the charge subtype.
- ChargeType; string; Charge type, such as item sale, service sale, financing, lease, shipping, restocking penalties, and so on.
- ChargeTypeCode; string; Abbreviation that identifies the charge type.
- GSAUnitPrice; number; Price for each unit. Determined from the price list on the pricing strategy.
- OrderChargeId; integer; Value that uniquely identifies the transaction.
- PricePeriodicity; string; Periodicity for recurring price types, such as month, quarter, or year.
- PricePeriodicityCode; string; Abbreviation that identifies the price periodicity.
- PriceType; string; Price type, such as one time, recurring, and so on.
- PriceTypeCode; string; Abbreviation that identifies the price type.
- PricedQuantity; number; Abbreviation that identifies the unit of measure for the priced quantity, such as Ton.
- PricedQuantityUOMCode; string; Abbreviation that identifies the unit of measure for the priced quantity.
- PrimaryFlag; boolean; 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.
- RollupFlag; boolean; Contains one of the following values: true or false. If true, then the charge is a rollup charge. If false, then the charge is not a rollup 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.
- SequenceNumber; integer; Sequence number for the charge.
- SourceChargeId; string; Value that uniquely identifies the charge. The source application applies this value.
- TierAppliesTo; string; 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.
- TierAppliesToCode; string; 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.
- TieredFlag; boolean; Contains one of the following values: true or false. If true, then the charge has a tier defined. If false, then the charge does not have a tier defined. 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.
- UsagePriceLockFlag; boolean; Contains one of the following values: true or false. If true, then the usage pricing is used. If false, then the usage pricing isn't used. 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.
- UsageUOM; string; Unit of measure for the usage price of the product.
- UsageUOMCode; string; Abbreviation that identifies the unit of measure for the usage price of the product.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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 TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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 : salesOrdersForOrderHub-lines-charges
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : salesOrdersForOrderHub-lines-charges-item-response
Type:
Show Source
object
-
ApplyTo: string
Maximum Length:
255
Specifies where pricing applies the charge: for the item, for shipping, or for the return. -
ApplyToCode: string
Maximum Length:
30
Abbreviation that identifies where pricing applies the charge: for the item, for shipping, or for the return. -
AverageUnitSellingPrice: number
Weighted average of the selling price. This average is the total sales revenue divided by total units sold.
-
BlockAllowance: number
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.
-
BlockSize: number
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.
-
CanAdjustFlag: boolean
Maximum Length:
1
Default Value:false
Contains one of the following values: true or false. If true, then the charge is eligible for adjustment. If false, then the charge is not eligible for adjustment. 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. -
chargeComponents: array
Charge Components
Title:
Charge Components
The Charge Components resource manages price details for the order line, including price elements and amounts. -
ChargeCurrency: string
Maximum Length:
255
Charge currency. -
ChargeCurrencyCode: string
Maximum Length:
15
Abbreviation that identifies the charge currency. -
ChargeDefinition: string
Maximum Length:
255
Charge definition that defines the price type, charge type, and subtype. -
ChargeDefinitionCode: string
Maximum Length:
30
Abbreviation that identifies the charge definition. -
ChargePeriod: string
Read Only:
true
Maximum Length:25
Charge period for the usage charge. The charge period determines how frequently Pricing and Subscription Management add up the usages for a usage charge. -
ChargePeriodCode: string
Read Only:
true
Maximum Length:3
Abbreviation that identifies the charge period for the usage charge. The charge period determines how frequently Pricing and Subscription Management add up the usages for a usage charge. -
ChargeSubType: string
Maximum Length:
255
Charge subtype. -
ChargeSubtypeCode: string
Maximum Length:
30
Abbreviation that identifies the charge subtype. -
chargeTiers: array
Charge Tiers
Title:
Charge Tiers
The Charge Tiers resource manages details about tier definitions for charges. This resource is not currently used. -
ChargeType: string
Maximum Length:
255
Charge type, such as item sale, service sale, financing, lease, shipping, restocking penalties, and so on. -
ChargeTypeCode: string
Maximum Length:
30
Abbreviation that identifies the charge type. -
GSAUnitPrice: number
Price for each unit. Determined from the price list on the pricing strategy.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrderChargeId: integer
(int64)
Read Only:
true
Value that uniquely identifies the transaction. -
PricedQuantity: number
Abbreviation that identifies the unit of measure for the priced quantity, such as Ton.
-
PricedQuantityUOM: string
Maximum Length:
255
Unit of measure for priced quantity, such as Ton. Oracle Product Lifecycle Management Cloud or a service in Oracle Order Management Cloud provides this value. -
PricedQuantityUOMCode: string
Maximum Length:
3
Abbreviation that identifies the unit of measure for the priced quantity. -
PricePeriodicity: string
Maximum Length:
255
Periodicity for recurring price types, such as month, quarter, or year. -
PricePeriodicityCode: string
Maximum Length:
30
Abbreviation that identifies the price periodicity. -
PriceType: string
Maximum Length:
255
Price type, such as one time, recurring, and so on. -
PriceTypeCode: string
Maximum Length:
30
Abbreviation that identifies the price type. -
PrimaryFlag: boolean
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. -
RollupFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then the charge is a rollup charge. If false, then the charge is not a rollup 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. -
SequenceNumber: integer
(int32)
Sequence number for the charge.
-
SourceChargeId: string
Maximum Length:
120
Value that uniquely identifies the charge. The source application applies this value. -
TierAppliesTo: string
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. -
TierAppliesToCode: string
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. -
TieredFlag: boolean
Read Only:
true
Maximum Length:1
Default Value:false
Contains one of the following values: true or false. If true, then the charge has a tier defined. If false, then the charge does not have a tier defined. 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. -
UsagePriceLockFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then the usage pricing is used. If false, then the usage pricing isn't used. 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. -
UsageUOM: string
Read Only:
true
Maximum Length:25
Unit of measure for the usage price of the product. -
UsageUOMCode: string
Read Only:
true
Maximum Length:3
Abbreviation that identifies the unit of measure for the usage price of the product.
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 resource is not currently used.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : salesOrdersForOrderHub-lines-charges-chargeComponents-item-response
Type:
Show Source
object
-
ChargeCurrency: string
Maximum Length:
255
Name of the currency that the charge component uses. -
ChargeCurrencyCode: string
Maximum Length:
15
Abbreviation that identifies the currency that the charge component uses. -
ChargeCurrencyDurationExtendedAmount: number
Extended amount for the duration displayed in the currency that the charge uses.
-
ChargeCurrencyExtendedAmount: number
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.
-
ChargeCurrencyUnitPrice: number
Price or adjustment for each unit displayed in the charge currency that the order line uses.
-
Explanation: string
Maximum Length:
1000
Explanation of the charge component. -
ExplanationMessageName: string
Maximum Length:
30
Message name of the explanation that displays in the price break down dialog. -
HeaderCurrency: string
Maximum Length:
255
Name of the currency that the order header uses. -
HeaderCurrencyCode: string
Maximum Length:
15
Abbreviation that identifies the currency that the order header uses. -
HeaderCurrencyDurationExtendedAmount: number
Extended amount for the duration, displayed in the currency that the order header uses.
-
HeaderCurrencyExtendedAmount: number
Extended amount, displayed in the currency that the order header uses.
-
HeaderCurrencyUnitPrice: number
Price or adjustment for each unit of the item, displayed in the currency that the order header uses.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrderChargeComponentId: integer
(int64)
Read Only:
true
Value that uniquely identifies the transaction. -
PercentOfComparisonElement: number
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.
-
PriceElement: string
Maximum Length:
255
Name of the price element, such as list price, net price, and so on. -
PriceElementCode: string
Maximum Length:
30
Abbreviation that identifies the price element. -
PriceElementUsage: string
Maximum Length:
255
Name that describes charge component usage. -
PriceElementUsageCode: string
Maximum Length:
30
Abbreviation that identifies the charge component usage. -
PricingSourceId: string
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. -
PricingSourceType: string
Maximum Length:
255
Type of the price source. -
PricingSourceTypeCode: string
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. -
RollupFlag: boolean
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 is not a rollup value. 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. -
SequenceNumber: integer
(int32)
Sequence number for the charge component.
-
SourceChargeComponentId: string
Maximum Length:
50
Value that uniquely identifies the charge component. The source application assigns this value. -
SourceMpaId: string
Maximum Length:
50
Value that identifies the source of a manual price adjustment. -
TaxIncludedFlag: boolean
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 does not include tax. 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. -
totalComponents: array
Total Components
Title:
Total Components
The Total Components resource manages the components that determine the total price of a sales order.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Total Components
Type:
array
Title:
Total Components
The Total Components resource manages the components that determine the total price of a sales order.
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.
Nested Schema : salesOrdersForOrderHub-lines-charges-chargeComponents-totalComponents-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : salesOrdersForOrderHub-lines-charges-chargeTiers-item-response
Type:
Show Source
object
-
AdjustmentAmount: number
Amount to be adjusted or the price for each unit or block for the item. In Oracle Subscription Management Cloud, this attribute is mapped to the list price.
-
ApplicationMethod: string
Maximum Length:
80
Method of application for the charge tier. In Oracle Subscription Management Cloud, this attribute is called PriceFormat. -
ApplicationMethodCode: string
Maximum Length:
30
Abbreviation that identifies the application method to use for tiered pricing. A list of accepted values is defined in the lookup type ORA_QP_APPLICATION_METHODS. -
BlockSize: number
Number that represents the size of the block for charge calculation for a tier.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrderChargeId: integer
(int64)
Value that uniquely identifies the charge.
-
OrderChargeTierId: integer
(int64)
Value that uniquely identifies the charge tier.
-
SourceOrderChargeTierId: string
Maximum Length:
50
Value that uniquely identifies the charge tier in the source application. -
TierFrom: number
Number that indicates the starting value of the tier.
-
TierSequenceNumber: number
Sequence number for the charge tier.
-
TierTo: number
Number that indicates the ending value of the tier.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Examples
This example describes how to get all charges.
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/lines/linesUniqID/child/charges"
Example Response Body
The following shows an example of the response body in JSON format.
{ "items" : [ { "OrderChargeId" : 300100187170599, "SourceChargeId" : "SC1", "PriceTypeCode" : "ONE_TIME", "PriceType" : "One time", "ChargeTypeCode" : "ORA_SALE", "ChargeType" : "Sale", "ChargeDefinitionCode" : "QP_SALE_PRICE", "ChargeDefinition" : "Sale Price", "ChargeSubtypeCode" : "ORA_PRICE", "ChargeSubType" : "Price", "PricedQuantity" : 1, "ChargeCurrencyCode" : "USD", "ChargeCurrency" : "US Dollar", "PricedQuantityUOMCode" : "Ea", "PricedQuantityUOM" : "Each", "PricePeriodicityCode" : null, "PricePeriodicity" : null, "SequenceNumber" : 1, "PrimaryFlag" : true, "RollupFlag" : false, "AverageUnitSellingPrice" : null, "CanAdjustFlag" : false, "GSAUnitPrice" : null, "ApplyToCode" : "PRICE", "ApplyTo" : "Price", "links" : [ { "rel" : "self", "href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_charges_01/child/lines/00020000000EACED00057708000110F0850DA7250000000EACED00057708000110F0850DA726/child/charges/300100187170599", "name" : "charges", "kind" : "item", "properties" : { "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78" } }, { "rel" : "canonical", "href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_charges_01/child/lines/00020000000EACED00057708000110F0850DA7250000000EACED00057708000110F0850DA726/child/charges/300100187170599", "name" : "charges", "kind" : "item" }, { "rel" : "parent", "href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_charges_01/child/lines/00020000000EACED00057708000110F0850DA7250000000EACED00057708000110F0850DA726", "name" : "lines", "kind" : "item" }, { "rel" : "child", "href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_charges_01/child/lines/00020000000EACED00057708000110F0850DA7250000000EACED00057708000110F0850DA726/child/charges/300100187170599/child/chargeComponents", "name" : "chargeComponents", "kind" : "collection" } ] }, { "OrderChargeId" : 300100187170605, "SourceChargeId" : "SC2", "PriceTypeCode" : "RECURRING", "PriceType" : "Recurring", "ChargeTypeCode" : "ORA_SALE", "ChargeType" : "Sale", "ChargeDefinitionCode" : "QP_RECURRING_SALE_PRICE", "ChargeDefinition" : "Recurring Sale Price", "ChargeSubtypeCode" : "ORA_PRICE", "ChargeSubType" : "Price", "PricedQuantity" : null, "ChargeCurrencyCode" : "USD", "ChargeCurrency" : "US Dollar", "PricedQuantityUOMCode" : null, "PricedQuantityUOM" : null, "PricePeriodicityCode" : "MTH", "PricePeriodicity" : "Month", "SequenceNumber" : 1, "PrimaryFlag" : false, "RollupFlag" : false, "AverageUnitSellingPrice" : null, "CanAdjustFlag" : false, "GSAUnitPrice" : null, "ApplyToCode" : "PRICE", "ApplyTo" : "Price", "links" : [ { "rel" : "self", "href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_charges_01/child/lines/00020000000EACED00057708000110F0850DA7250000000EACED00057708000110F0850DA726/child/charges/300100187170605", "name" : "charges", "kind" : "item", "properties" : { "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78" } }, { "rel" : "canonical", "href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_charges_01/child/lines/00020000000EACED00057708000110F0850DA7250000000EACED00057708000110F0850DA726/child/charges/300100187170605", "name" : "charges", "kind" : "item" }, { "rel" : "parent", "href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_charges_01/child/lines/00020000000EACED00057708000110F0850DA7250000000EACED00057708000110F0850DA726", "name" : "lines", "kind" : "item" }, { "rel" : "child", "href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_charges_01/child/lines/00020000000EACED00057708000110F0850DA7250000000EACED00057708000110F0850DA726/child/charges/300100187170605/child/chargeComponents", "name" : "chargeComponents", "kind" : "collection" } ] }, { "OrderChargeId" : 300100187170608, "SourceChargeId" : "SC3", "PriceTypeCode" : "ONE_TIME", "PriceType" : "One time", "ChargeTypeCode" : "ORA_SHIPPING_FREIGHT", "ChargeType" : "Freight", "ChargeDefinitionCode" : "QP_SHIP_FREIGHT", "ChargeDefinition" : "Freight", "ChargeSubtypeCode" : "ORA_PRICE", "ChargeSubType" : "Price", "PricedQuantity" : null, "ChargeCurrencyCode" : "USD", "ChargeCurrency" : "US Dollar", "PricedQuantityUOMCode" : null, "PricedQuantityUOM" : null, "PricePeriodicityCode" : null, "PricePeriodicity" : null, "SequenceNumber" : 2, "PrimaryFlag" : true, "RollupFlag" : false, "AverageUnitSellingPrice" : null, "CanAdjustFlag" : false, "GSAUnitPrice" : null, "ApplyToCode" : "SHIPPING", "ApplyTo" : "Shipping", "links" : [ { "rel" : "self", "href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_charges_01/child/lines/00020000000EACED00057708000110F0850DA7250000000EACED00057708000110F0850DA726/child/charges/300100187170608", "name" : "charges", "kind" : "item", "properties" : { "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78" } }, { "rel" : "canonical", "href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_charges_01/child/lines/00020000000EACED00057708000110F0850DA7250000000EACED00057708000110F0850DA726/child/charges/300100187170608", "name" : "charges", "kind" : "item" }, { "rel" : "parent", "href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_charges_01/child/lines/00020000000EACED00057708000110F0850DA7250000000EACED00057708000110F0850DA726", "name" : "lines", "kind" : "item" }, { "rel" : "child", "href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_charges_01/child/lines/00020000000EACED00057708000110F0850DA7250000000EACED00057708000110F0850DA726/child/charges/300100187170608/child/chargeComponents", "name" : "chargeComponents", "kind" : "collection" } ] } ], "count" : 3, "hasMore" : false, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", "href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_charges_01/child/lines/00020000000EACED00057708000110F0850DA7250000000EACED00057708000110F0850DA726/child/charges", "name" : "charges", "kind" : "collection" } ] }