Jump to

• Request
• Response
• Examples

Update one charge

patch

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

Request

Path Parameters

• OrderChargeId(required): integer(int64)
  Value that uniquely identifies the transaction.
• 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.

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "RollupFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":false
        },
        "PrimaryFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":false
        },
        "ChargeDefinition":{
            "maxLength":"255",
            "type":"string",
            "description":"Charge definition that defines the price type, charge type, and subtype.",
            "nullable":true
        },
        "PricedQuantityUOMCode":{
            "maxLength":"3",
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure for the priced quantity.",
            "nullable":true
        },
        "TierAppliesToCode":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "ChargeTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the charge type.",
            "nullable":false
        },
        "ChargeDefinitionCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the charge definition.",
            "nullable":false
        },
        "PriceTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the price type.",
            "nullable":false
        },
        "ChargeCurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"Abbreviation that identifies the charge currency.",
            "nullable":false
        },
        "AverageUnitSellingPrice":{
            "type":"number",
            "description":"Weighted average of the selling price. This average is the total sales revenue divided by total units sold.",
            "nullable":true
        },
        "GSAUnitPrice":{
            "type":"number",
            "description":"Price for each unit. Determined from the price list on the pricing strategy.",
            "nullable":true
        },
        "SequenceNumber":{
            "type":"integer",
            "description":"Sequence number for the charge.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "ApplyTo":{
            "maxLength":"255",
            "type":"string",
            "description":"Specifies where pricing applies the charge: for the item, for shipping, or for the return.",
            "nullable":true,
            "x-queryable":false
        },
        "CanAdjustFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":false,
            "default":false
        },
        "PricePeriodicityCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the price periodicity.",
            "nullable":true
        },
        "chargeComponents":{
            "title":"Charge Components",
            "type":"array",
            "description":"The Charge Components resource manages price details for the order line, including price elements and amounts.",
            "items":{
                "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-charges-chargeComponents-item-patch-request"
            }
        },
        "ChargeCurrency":{
            "maxLength":"255",
            "type":"string",
            "description":"Charge currency.",
            "nullable":true,
            "x-queryable":false
        },
        "BlockAllowance":{
            "type":"number",
            "description":"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.",
            "nullable":true
        },
        "PricedQuantity":{
            "type":"number",
            "description":"Abbreviation that identifies the unit of measure for the priced quantity, such as Ton.",
            "nullable":true
        },
        "ChargeSubType":{
            "maxLength":"255",
            "type":"string",
            "description":"Charge subtype.",
            "nullable":true
        },
        "ChargeSubtypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the charge subtype.",
            "nullable":false
        },
        "TierAppliesTo":{
            "maxLength":"80",
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "UsagePriceLockFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true
        },
        "ApplyToCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies where pricing applies the charge: for the item, for shipping, or for the return.",
            "nullable":false
        },
        "PricePeriodicity":{
            "maxLength":"255",
            "type":"string",
            "description":"Periodicity for recurring price types, such as month, quarter, or year.",
            "nullable":true
        },
        "ChargeType":{
            "maxLength":"255",
            "type":"string",
            "description":"Charge type, such as item sale, service sale, financing, lease, shipping, restocking penalties, and so on.",
            "nullable":true
        },
        "PricedQuantityUOM":{
            "maxLength":"255",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "chargeTiers":{
            "title":"Charge Tiers",
            "type":"array",
            "description":"The Charge Tiers resource manages details about tier definitions for charges. This resource is not currently used.",
            "items":{
                "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-charges-chargeTiers-item-patch-request"
            }
        },
        "BlockSize":{
            "type":"number",
            "description":"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.",
            "nullable":true
        },
        "PriceType":{
            "maxLength":"255",
            "type":"string",
            "description":"Price type, such as one time, recurring, and so on.",
            "nullable":true
        }
    }
}

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

• Array of: object schema

{
    "title":"Charge Components",
    "type":"array",
    "description":"The Charge Components resource manages price details for the order line, including price elements and amounts.",
    "items":{
        "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-charges-chargeComponents-item-patch-request"
    }
}

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

• Array of: object schema

{
    "title":"Charge Tiers",
    "type":"array",
    "description":"The Charge Tiers resource manages details about tier definitions for charges. This resource is not currently used.",
    "items":{
        "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-charges-chargeTiers-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• 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.
• 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.
• 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 retrieves the components that determine the total price of a sales order.

{
    "type":"object",
    "properties":{
        "SourceMpaId":{
            "maxLength":"50",
            "type":"string",
            "description":"Value that identifies the source of a manual price adjustment.",
            "nullable":true,
            "x-queryable":false
        },
        "RollupFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":false,
            "x-queryable":false
        },
        "Explanation":{
            "maxLength":"1000",
            "type":"string",
            "description":"Explanation of the charge component.",
            "nullable":true,
            "x-queryable":false
        },
        "PricingSourceId":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "TaxIncludedFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":false,
            "default":false,
            "x-queryable":false
        },
        "PricingSourceType":{
            "maxLength":"255",
            "type":"string",
            "description":"Type of the price source.",
            "nullable":true,
            "x-queryable":false
        },
        "ChargeCurrencyUnitPrice":{
            "type":"number",
            "description":"Price or adjustment for each unit displayed in the charge currency that the order line uses.",
            "nullable":true
        },
        "HeaderCurrency":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the currency that the order header uses.",
            "nullable":true,
            "x-queryable":false
        },
        "ChargeCurrencyDurationExtendedAmount":{
            "type":"number",
            "description":"Extended amount for the duration displayed in the currency that the charge uses.",
            "nullable":true
        },
        "HeaderCurrencyDurationExtendedAmount":{
            "type":"number",
            "description":"Extended amount for the duration, displayed in the currency that the order header uses.",
            "nullable":true,
            "x-queryable":false
        },
        "ChargeCurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"Abbreviation that identifies the currency that the charge component uses.",
            "nullable":true,
            "x-queryable":false
        },
        "PriceElementUsageCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the charge component usage.",
            "nullable":true
        },
        "ChargeCurrencyExtendedAmount":{
            "type":"number",
            "description":"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.",
            "nullable":true
        },
        "SequenceNumber":{
            "type":"integer",
            "description":"Sequence number for the charge component.",
            "format":"int32",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "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-lines-charges-chargeComponents-totalComponents-item-patch-request"
            }
        },
        "PriceElementUsage":{
            "maxLength":"255",
            "type":"string",
            "description":"Name that describes charge component usage.",
            "nullable":true
        },
        "ExplanationMessageName":{
            "maxLength":"30",
            "type":"string",
            "description":"Message name of the explanation that displays in the price break down dialog.",
            "nullable":true,
            "x-queryable":false
        },
        "HeaderCurrencyExtendedAmount":{
            "type":"number",
            "description":"Extended amount, displayed in the currency that the order header uses.",
            "nullable":true,
            "x-queryable":false
        },
        "HeaderCurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"Abbreviation that identifies the currency that the order header uses.",
            "nullable":true,
            "x-queryable":false
        },
        "ChargeCurrency":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the currency that the charge component uses.",
            "nullable":true,
            "x-queryable":false
        },
        "HeaderCurrencyUnitPrice":{
            "type":"number",
            "description":"Price or adjustment for each unit of the item, displayed in the currency that the order header uses.",
            "nullable":true,
            "x-queryable":false
        },
        "PercentOfComparisonElement":{
            "type":"number",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "PriceElementCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the price element.",
            "nullable":true
        },
        "PriceElement":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the price element, such as list price, net price, and so on.",
            "nullable":true
        },
        "PricingSourceTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

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-lines-charges-chargeComponents-totalComponents-item-patch-request

{
    "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-lines-charges-chargeComponents-totalComponents-item-patch-request"
    }
}

Nested Schema : salesOrdersForOrderHub-lines-charges-chargeComponents-totalComponents-item-patch-request

Type: object

Show Source

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

{
    "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"
            }
        },
        "OrderTotalId":{
            "type":"integer",
            "description":"Value that identifies the sales order total.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "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"
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• 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.
• OrderChargeId: integer (int64)
  Value that uniquely identifies the charge.
• OrderChargeTierId: integer (int64)
  Value that uniquely identifies the charge tier.
• 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.

{
    "type":"object",
    "properties":{
        "TierSequenceNumber":{
            "type":"number",
            "description":"Sequence number for the charge tier.",
            "nullable":false
        },
        "TierTo":{
            "type":"number",
            "description":"Number that indicates the ending value of the tier.",
            "nullable":true
        },
        "ApplicationMethodCode":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "AdjustmentAmount":{
            "type":"number",
            "description":"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.",
            "nullable":true
        },
        "OrderChargeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "ApplicationMethod":{
            "maxLength":"80",
            "type":"string",
            "description":"Method of application for the charge tier. In Oracle Subscription Management Cloud, this attribute is called PriceFormat.",
            "nullable":true
        },
        "BlockSize":{
            "type":"number",
            "description":"Number that represents the size of the block for charge calculation for a tier.",
            "nullable":true
        },
        "TierFrom":{
            "type":"number",
            "description":"Number that indicates the starting value of the tier.",
            "nullable":false
        },
        "OrderChargeTierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the charge tier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        }
    }
}

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-lines-charges-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "RollupFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "UsageUOM":{
            "maxLength":"25",
            "type":"string",
            "description":"Unit of measure for the usage price of the product.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "ChargeDefinition":{
            "maxLength":"255",
            "type":"string",
            "description":"Charge definition that defines the price type, charge type, and subtype.",
            "nullable":true,
            "x-queryable":true
        },
        "PricedQuantityUOMCode":{
            "maxLength":"3",
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure for the priced quantity.",
            "nullable":true,
            "x-queryable":true
        },
        "TierAppliesToCode":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the charge type.",
            "nullable":false,
            "x-queryable":true
        },
        "ChargeDefinitionCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the charge definition.",
            "nullable":false,
            "x-queryable":true
        },
        "SourceChargeId":{
            "maxLength":"120",
            "type":"string",
            "description":"Value that uniquely identifies the charge. The source application applies this value.",
            "nullable":true,
            "x-queryable":true
        },
        "PriceTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the price type.",
            "nullable":false,
            "x-queryable":true
        },
        "ChargeCurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"Abbreviation that identifies the charge currency.",
            "nullable":false,
            "x-queryable":true
        },
        "AverageUnitSellingPrice":{
            "type":"number",
            "description":"Weighted average of the selling price. This average is the total sales revenue divided by total units sold.",
            "nullable":true,
            "x-queryable":true
        },
        "UsageUOMCode":{
            "maxLength":"3",
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure for the usage price of the product.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GSAUnitPrice":{
            "type":"number",
            "description":"Price for each unit. Determined from the price list on the pricing strategy.",
            "nullable":true,
            "x-queryable":true
        },
        "SequenceNumber":{
            "type":"integer",
            "description":"Sequence number for the charge.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "ApplyTo":{
            "maxLength":"255",
            "type":"string",
            "description":"Specifies where pricing applies the charge: for the item, for shipping, or for the return.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ChargePeriodCode":{
            "maxLength":"3",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CanAdjustFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "ChargePeriod":{
            "maxLength":"25",
            "type":"string",
            "description":"Charge period for the usage charge. The charge period determines how frequently Pricing and Subscription Management add up the usages for a usage charge.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PricePeriodicityCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the price periodicity.",
            "nullable":true,
            "x-queryable":true
        },
        "chargeComponents":{
            "title":"Charge Components",
            "type":"array",
            "description":"The Charge Components resource manages price details for the order line, including price elements and amounts.",
            "items":{
                "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-charges-chargeComponents-item-response"
            }
        },
        "ChargeCurrency":{
            "maxLength":"255",
            "type":"string",
            "description":"Charge currency.",
            "nullable":true,
            "x-queryable":false
        },
        "BlockAllowance":{
            "type":"number",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "PricedQuantity":{
            "type":"number",
            "description":"Abbreviation that identifies the unit of measure for the priced quantity, such as Ton.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeSubType":{
            "maxLength":"255",
            "type":"string",
            "description":"Charge subtype.",
            "nullable":true,
            "x-queryable":true
        },
        "TieredFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "ChargeSubtypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the charge subtype.",
            "nullable":false,
            "x-queryable":true
        },
        "TierAppliesTo":{
            "maxLength":"80",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "UsagePriceLockFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ApplyToCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies where pricing applies the charge: for the item, for shipping, or for the return.",
            "nullable":false,
            "x-queryable":true
        },
        "PricePeriodicity":{
            "maxLength":"255",
            "type":"string",
            "description":"Periodicity for recurring price types, such as month, quarter, or year.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeType":{
            "maxLength":"255",
            "type":"string",
            "description":"Charge type, such as item sale, service sale, financing, lease, shipping, restocking penalties, and so on.",
            "nullable":true,
            "x-queryable":true
        },
        "PricedQuantityUOM":{
            "maxLength":"255",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "OrderChargeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the transaction.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "chargeTiers":{
            "title":"Charge Tiers",
            "type":"array",
            "description":"The Charge Tiers resource manages details about tier definitions for charges. This resource is not currently used.",
            "items":{
                "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-charges-chargeTiers-item-response"
            }
        },
        "BlockSize":{
            "type":"number",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "PriceType":{
            "maxLength":"255",
            "type":"string",
            "description":"Price type, such as one time, recurring, and so on.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

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

• Array of: object salesOrdersForOrderHub-lines-charges-chargeComponents-item-response

{
    "title":"Charge Components",
    "type":"array",
    "description":"The Charge Components resource manages price details for the order line, including price elements and amounts.",
    "items":{
        "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-charges-chargeComponents-item-response"
    }
}

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

• Array of: object salesOrdersForOrderHub-lines-charges-chargeTiers-item-response

{
    "title":"Charge Tiers",
    "type":"array",
    "description":"The Charge Tiers resource manages details about tier definitions for charges. This resource is not currently used.",
    "items":{
        "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-charges-chargeTiers-item-response"
    }
}

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 : salesOrdersForOrderHub-lines-charges-chargeComponents-item-response

Type: object

Show Source

• 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 retrieves the components that determine the total price of a sales order.

{
    "type":"object",
    "properties":{
        "SourceMpaId":{
            "maxLength":"50",
            "type":"string",
            "description":"Value that identifies the source of a manual price adjustment.",
            "nullable":true,
            "x-queryable":false
        },
        "RollupFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":false,
            "x-queryable":false
        },
        "Explanation":{
            "maxLength":"1000",
            "type":"string",
            "description":"Explanation of the charge component.",
            "nullable":true,
            "x-queryable":false
        },
        "PricingSourceId":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "TaxIncludedFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":false,
            "default":false,
            "x-queryable":false
        },
        "OrderChargeComponentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the transaction.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PricingSourceType":{
            "maxLength":"255",
            "type":"string",
            "description":"Type of the price source.",
            "nullable":true,
            "x-queryable":false
        },
        "ChargeCurrencyUnitPrice":{
            "type":"number",
            "description":"Price or adjustment for each unit displayed in the charge currency that the order line uses.",
            "nullable":true,
            "x-queryable":true
        },
        "HeaderCurrency":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the currency that the order header uses.",
            "nullable":true,
            "x-queryable":false
        },
        "ChargeCurrencyDurationExtendedAmount":{
            "type":"number",
            "description":"Extended amount for the duration displayed in the currency that the charge uses.",
            "nullable":true,
            "x-queryable":true
        },
        "HeaderCurrencyDurationExtendedAmount":{
            "type":"number",
            "description":"Extended amount for the duration, displayed in the currency that the order header uses.",
            "nullable":true,
            "x-queryable":false
        },
        "ChargeCurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"Abbreviation that identifies the currency that the charge component uses.",
            "nullable":true,
            "x-queryable":false
        },
        "PriceElementUsageCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the charge component usage.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeCurrencyExtendedAmount":{
            "type":"number",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "SequenceNumber":{
            "type":"integer",
            "description":"Sequence number for the charge component.",
            "format":"int32",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "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-lines-charges-chargeComponents-totalComponents-item-response"
            }
        },
        "PriceElementUsage":{
            "maxLength":"255",
            "type":"string",
            "description":"Name that describes charge component usage.",
            "nullable":true,
            "x-queryable":true
        },
        "ExplanationMessageName":{
            "maxLength":"30",
            "type":"string",
            "description":"Message name of the explanation that displays in the price break down dialog.",
            "nullable":true,
            "x-queryable":false
        },
        "HeaderCurrencyExtendedAmount":{
            "type":"number",
            "description":"Extended amount, displayed in the currency that the order header uses.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceChargeComponentId":{
            "maxLength":"50",
            "type":"string",
            "description":"Value that uniquely identifies the charge component. The source application assigns this value.",
            "nullable":true,
            "x-queryable":true
        },
        "HeaderCurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"Abbreviation that identifies the currency that the order header uses.",
            "nullable":true,
            "x-queryable":false
        },
        "ChargeCurrency":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the currency that the charge component uses.",
            "nullable":true,
            "x-queryable":false
        },
        "HeaderCurrencyUnitPrice":{
            "type":"number",
            "description":"Price or adjustment for each unit of the item, displayed in the currency that the order header uses.",
            "nullable":true,
            "x-queryable":false
        },
        "PercentOfComparisonElement":{
            "type":"number",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "PriceElementCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the price element.",
            "nullable":true,
            "x-queryable":true
        },
        "PriceElement":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the price element, such as list price, net price, and so on.",
            "nullable":true,
            "x-queryable":true
        },
        "PricingSourceTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":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-lines-charges-chargeComponents-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-lines-charges-chargeComponents-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-lines-charges-chargeComponents-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"
    }
}

Nested Schema : salesOrdersForOrderHub-lines-charges-chargeTiers-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "TierSequenceNumber":{
            "type":"number",
            "description":"Sequence number for the charge tier.",
            "nullable":false,
            "x-queryable":true
        },
        "TierTo":{
            "type":"number",
            "description":"Number that indicates the ending value of the tier.",
            "nullable":true,
            "x-queryable":true
        },
        "ApplicationMethodCode":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceOrderChargeTierId":{
            "maxLength":"50",
            "type":"string",
            "description":"Value that uniquely identifies the charge tier in the source application.",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustmentAmount":{
            "type":"number",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "OrderChargeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ApplicationMethod":{
            "maxLength":"80",
            "type":"string",
            "description":"Method of application for the charge tier. In Oracle Subscription Management Cloud, this attribute is called PriceFormat.",
            "nullable":true,
            "x-queryable":true
        },
        "BlockSize":{
            "type":"number",
            "description":"Number that represents the size of the block for charge calculation for a tier.",
            "nullable":true,
            "x-queryable":true
        },
        "TierFrom":{
            "type":"number",
            "description":"Number that indicates the starting value of the tier.",
            "nullable":false,
            "x-queryable":true
        },
        "OrderChargeTierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the charge tier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        }
    }
}

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

chargeComponents

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

Parameters:

• OrderChargeId: $request.path.OrderChargeId
• OrderKey: $request.path.OrderKey
• linesUniqID: $request.path.linesUniqID

The Charge Components resource manages price details for the order line, including price elements and amounts.

chargeTiers

Operation: /fscmRestApi/resources/11.13.18.05/salesOrdersForOrderHub/{OrderKey}/child/lines/{linesUniqID}/child/charges/{OrderChargeId}/child/chargeTiers

Parameters:

• OrderChargeId: $request.path.OrderChargeId
• OrderKey: $request.path.OrderKey
• linesUniqID: $request.path.linesUniqID

The Charge Tiers resource manages details about tier definitions for charges. This resource is not currently used.

Back to Top

Examples

This example describes how to update one charge.

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"

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_charges_01/child/lines/00020000000EACED00057708000110F0850DA7250000000EACED00057708000110F0850DA726/child/charges/300100187170599"

Example Request Body

The following example includes the contents of the request body in JSON format. 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.

{
	"CanAdjustFlag": true
}

Example Response Body

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

{
}

Back to Top