Jump to

• Request
• Response
• Examples

Get all charges

get

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

Request

Path Parameters

• OrderKey(required): string
  Value that uniquely identifies the sales order. This value is derived by concatenating the value of SourceOrderSystem, a colon, and the value of SourceOrderId. For orders created through the Oracle Order Management Cloud work area, the SourceOrderId is same as the HeaderId. For example, if SourceOrderSystem is LEG and SourceOrderId is R13_Sample_Order, the value of this attribute is LEG:R13_Sample_Order.
• 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: Find 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.
  • findBySourceChargeId: Find 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.
• 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:
  

  • ApplyTo; string; Specifies where pricing applies the charge: for the item, for shipping, or for the return.
  • ApplyToCode; string; Abbreviation that identifies where pricing applies the charge: for the item, for shipping, or for the return.
  • AverageUnitSellingPrice; number; Value that indicates the average selling price of the unit. 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.
  • ChargeCurrency; string; Value that indicates the charge currency.
  • ChargeCurrencyCode; string; Abbreviation that identifies the charge currency. Charge types include Goods sale, Service sale, Financing Vs. Lease, Shipping related charges, Restocking Penalties, Special charges, and so on.
  • ChargeDefinition; string; Charge definition that defines the price type, charge type, and charge subtype.
  • ChargeDefinitionCode; string; Abbreviation that identifies the charge definition. A charge definition defines the price type, charge type, and charge subtype.
  • ChargeSubType; string; Type of charge subtype. A charge definition defines the price type, charge type, and charge subtype.
  • ChargeSubtypeCode; string; Abbreviation that identifies the charge subtype.
  • ChargeType; string; Type of a given charge. Charge types include Goods sale, Service sale, Financing Vs. Lease, Shipping related charges, Restocking Penalties, Special charges, and so on.
  • ChargeTypeCode; string; Abbreviation that identifies the type of a given charge. Charge types include Goods sale, Service sale, Financing Vs. Lease, Shipping related charges, Restocking Penalties, Special charges, and so on.
  • GSAUnitPrice; number; Price for each unit. Determined from the price list on the pricing strategy.
  • PricePeriodicity; string; Periodicity for recurring price types, such as month, quarter, or year.
  • PricePeriodicityCode; string; Abbreviation that identifies the price periodicity.
  • PriceType; string; Type of price, such as one time, recurring, and so on.
  • PriceTypeCode; string; Abbreviation that identifies the type of price, such as one time, recurring, and so on.
  • PricedQuantity; number; Abbreviation that identifies the unit of measure for the priced quantity, such as Ton.
  • PricedQuantityUOM; string; Unit of measure for priced quantity.
  • PricedQuantityUOMCode; string; Abbreviation that identifies the unit of measure for priced quantity, such as Ton.
  • 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 or an aggregate charge. If false, then the charge is not a rollup or an aggregate charge. For Oracle Fusion application priced orders, the default value is set based on the pricing setup. For pre-priced orders, the default value is false.
  • SequenceNumber; integer; Sequence number for the charge.
  • SourceChargeId; string; Value that uniquely identifies the charge. The source application that captured the transaction 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.
  • TransactionalCurrencyCode; string; Abbreviation that identifies the currency that pricing used to price the transaction.
  • TransactionalUOMCode; string; Abbreviation that identifies the unit of measure for the ordered quantity.
  • UsagePriceLockFlag; boolean; Contains one of the following values: true or false. If true, then use the usage pricing. If false, then do not use the usage pricing. This attribute does not have a default value. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.
• 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 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 : salesOrdersForOrderHubRequests-lines-charges

Type: object

Show Source

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

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"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."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/salesOrdersForOrderHubRequests-lines-charges-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object salesOrdersForOrderHubRequests-lines-charges-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/salesOrdersForOrderHubRequests-lines-charges-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 : salesOrdersForOrderHubRequests-lines-charges-item-response

Type: object

Show Source

• ApplyTo: string
  Maximum Length: 80

  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
  Value that indicates the average selling price of the unit. 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.
• 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: 1000

  Value that indicates the charge currency.
• ChargeCurrencyCode: string
  Maximum Length: 1000

  Abbreviation that identifies the charge currency. Charge types include Goods sale, Service sale, Financing Vs. Lease, Shipping related charges, Restocking Penalties, Special charges, and so on.
• ChargeDefinition: string
  Maximum Length: 80

  Charge definition that defines the price type, charge type, and charge subtype.
• ChargeDefinitionCode: string
  Maximum Length: 30

  Abbreviation that identifies the charge definition. A charge definition defines the price type, charge type, and charge subtype.
• ChargeSubType: string
  Maximum Length: 80

  Type of charge subtype. A charge definition defines the price type, charge type, and 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 is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.
• ChargeType: string
  Maximum Length: 80

  Type of a given charge. Charge types include Goods sale, Service sale, Financing Vs. Lease, Shipping related charges, Restocking Penalties, Special charges, and so on.
• ChargeTypeCode: string
  Maximum Length: 30

  Abbreviation that identifies the type of a given charge. Charge types include Goods sale, Service sale, Financing Vs. Lease, Shipping related charges, Restocking Penalties, Special charges, and so on.
• 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.
• PricedQuantity: number
  Abbreviation that identifies the unit of measure for the priced quantity, such as Ton.
• PricedQuantityUOM: string
  Maximum Length: 25

  Unit of measure for priced quantity.
• PricedQuantityUOMCode: string
  Maximum Length: 3

  Abbreviation that identifies the unit of measure for priced quantity, such as Ton.
• PricePeriodicity: string
  Maximum Length: 25

  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: 240

  Type of price, such as one time, recurring, and so on.
• PriceTypeCode: string
  Maximum Length: 30

  Abbreviation that identifies the type of price, such as one time, recurring, and so on.
• 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 or an aggregate charge. If false, then the charge is not a rollup or an aggregate charge. For Oracle Fusion application priced orders, the default value is set based on the pricing setup. For pre-priced orders, the default value is false.
• SequenceNumber: integer (int32)
  Sequence number for the charge.
• SourceChargeId: string
  Maximum Length: 120

  Value that uniquely identifies the charge. The source application that captured the transaction 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.
• TransactionalCurrencyCode: string
  Maximum Length: 1000

  Abbreviation that identifies the currency that pricing used to price the transaction.
• TransactionalUOMCode: string
  Maximum Length: 3

  Abbreviation that identifies the unit of measure for the ordered quantity.
• UsagePriceLockFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then use the usage pricing. If false, then do not use the usage pricing. This attribute does not have a default value. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.

{
    "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 or an aggregate charge. If false, then the charge is not a rollup or an aggregate charge. For Oracle Fusion application priced orders, the default value is set based on the pricing setup. For pre-priced orders, the default value is false.",
            "nullable":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":true,
            "x-queryable":true
        },
        "ChargeDefinition":{
            "maxLength":"80",
            "type":"string",
            "description":"Charge definition that defines the price type, charge type, and charge subtype.",
            "nullable":true,
            "x-queryable":true
        },
        "PricedQuantityUOMCode":{
            "maxLength":"3",
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure for priced quantity, such as Ton.",
            "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 type of a given charge. Charge types include Goods sale, Service sale, Financing Vs. Lease, Shipping related charges, Restocking Penalties, Special charges, and so on.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeDefinitionCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the charge definition. A charge definition defines the price type, charge type, and charge subtype.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceChargeId":{
            "maxLength":"120",
            "type":"string",
            "description":"Value that uniquely identifies the charge. The source application that captured the transaction applies this value.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "PriceTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the type of price, such as one time, recurring, and so on.",
            "nullable":true,
            "x-queryable":true
        },
        "AverageUnitSellingPrice":{
            "type":"number",
            "description":"Value that indicates the average selling price of the unit. This average is the total sales revenue divided by total units sold.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeCurrencyCode":{
            "maxLength":"1000",
            "type":"string",
            "description":"Abbreviation that identifies the charge currency. Charge types include Goods sale, Service sale, Financing Vs. Lease, Shipping related charges, Restocking Penalties, Special charges, and so on.",
            "nullable":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
        },
        "ApplyTo":{
            "maxLength":"80",
            "type":"string",
            "description":"Specifies where pricing applies the charge: for the item, for shipping, or for the return.",
            "nullable":true,
            "x-queryable":true
        },
        "SequenceNumber":{
            "type":"integer",
            "description":"Sequence number for the charge.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TransactionalUOMCode":{
            "maxLength":"3",
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure for the ordered quantity.",
            "nullable":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/salesOrdersForOrderHubRequests-lines-charges-chargeComponents-item-response"
            }
        },
        "TransactionalCurrencyCode":{
            "maxLength":"1000",
            "type":"string",
            "description":"Abbreviation that identifies the currency that pricing used to price the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeCurrency":{
            "maxLength":"1000",
            "type":"string",
            "description":"Value that indicates the charge currency.",
            "nullable":true,
            "x-queryable":true
        },
        "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":"80",
            "type":"string",
            "description":"Type of charge subtype. A charge definition defines the price type, charge type, and charge subtype.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeSubtypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the charge subtype.",
            "nullable":true,
            "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 use the usage pricing. If false, then do not use the usage pricing. This attribute does not have a default value. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.",
            "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":true,
            "x-queryable":true
        },
        "PricePeriodicity":{
            "maxLength":"25",
            "type":"string",
            "description":"Periodicity for recurring price types, such as month, quarter, or year.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeType":{
            "maxLength":"80",
            "type":"string",
            "description":"Type of a given charge. Charge types include Goods sale, Service sale, Financing Vs. Lease, Shipping related charges, Restocking Penalties, Special charges, and so on.",
            "nullable":true,
            "x-queryable":true
        },
        "PricedQuantityUOM":{
            "maxLength":"25",
            "type":"string",
            "description":"Unit of measure for priced quantity.",
            "nullable":true,
            "x-queryable":true
        },
        "chargeTiers":{
            "title":"Charge Tiers",
            "type":"array",
            "description":"The Charge Tiers resource manages details about tier definitions for charges. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.",
            "items":{
                "$ref":"#/components/schemas/salesOrdersForOrderHubRequests-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":"240",
            "type":"string",
            "description":"Type of price, 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 salesOrdersForOrderHubRequests-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/salesOrdersForOrderHubRequests-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 is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.

Show Source

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

{
    "title":"Charge Tiers",
    "type":"array",
    "description":"The Charge Tiers resource manages details about tier definitions for charges. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.",
    "items":{
        "$ref":"#/components/schemas/salesOrdersForOrderHubRequests-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 : salesOrdersForOrderHubRequests-lines-charges-chargeComponents-item-response

Type: object

Show Source

• ChargeCurrency: string
  Maximum Length: 1000

  Name of the currency that the charge component uses.
• ChargeCurrencyCode: string
  Maximum Length: 1000

  Abbreviation that identifies the currency that the charge component uses.
• ChargeCurrencyDurationExtendedAmount: number
  Extended amount for the duration in the charge currency.
• ChargeCurrencyExtendedAmount: number
  Extended amount in the charge currency. Extended amount equals the unit price multiplied by the line requested quantity for simple products and equals the unit price multiplied by the line extended quantity for configurations.
• ChargeCurrencyUnitPrice: number
  Price or adjustment for each unit displayed in the charge currency for the line unit of measure.
• Explanation: string
  Maximum Length: 1000

  Explanation of the charge component.
• HeaderCurrency: string
  Maximum Length: 1000

  Name of the currency that the order header uses.
• HeaderCurrencyCode: string
  Maximum Length: 1000

  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.
• PriceElement: string
  Maximum Length: 240

  Name of the price element.
• PriceElementCode: string
  Maximum Length: 30

  Abbreviation that identifies the price element, for example, LISTPRICE, NETPRICE, and so on.
• PriceElementUsage: string
  Maximum Length: 240

  Name that describes charge component usage.
• PriceElementUsageCode: string
  Maximum Length: 30

  Abbreviation that identifies the charge component usage.
• RollupFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the value is a rollup or aggregate value for the charge component price element code. If false, then the value is not a rollup aggregate value for the charge component price element code. 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.
• SourceChargeId: string
  Maximum Length: 120

  Value that uniquely identifies the charge. The source application assigns this value.
• SourceManualPriceAdjustmentId: string
  Maximum Length: 50

  Value that uniquely identifies the manual price adjustment. The source application assigns this value.
• SourceParentChargeComponentId: string
  Maximum Length: 50

  Value that uniquely identifies the charge component for the contributing charge. This attribute is used only when the parent charge is a rollup charge.
• TransactionalCurrencyCode: string
  Maximum Length: 1000

  Abbreviation that identifies the currency that pricing used to price the transaction.

{
    "type":"object",
    "properties":{
        "RollupFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the value is a rollup or aggregate value for the charge component price element code. If false, then the value is not a rollup aggregate value for the charge component price element code. 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":true,
            "x-queryable":true
        },
        "HeaderCurrencyExtendedAmount":{
            "type":"number",
            "description":"Extended amount, displayed in the currency that the order header uses.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionalCurrencyCode":{
            "maxLength":"1000",
            "type":"string",
            "description":"Abbreviation that identifies the currency that pricing used to price the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceChargeComponentId":{
            "maxLength":"50",
            "type":"string",
            "description":"Value that uniquely identifies the charge component. The source application assigns this value.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "HeaderCurrencyCode":{
            "maxLength":"1000",
            "type":"string",
            "description":"Abbreviation that identifies the currency that the order header uses.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeCurrency":{
            "maxLength":"1000",
            "type":"string",
            "description":"Name of the currency that the charge component uses.",
            "nullable":true,
            "x-queryable":true
        },
        "Explanation":{
            "maxLength":"1000",
            "type":"string",
            "description":"Explanation of the charge component.",
            "nullable":true,
            "x-queryable":true
        },
        "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":true
        },
        "ChargeCurrencyUnitPrice":{
            "type":"number",
            "description":"Price or adjustment for each unit displayed in the charge currency for the line unit of measure.",
            "nullable":true,
            "x-queryable":true
        },
        "HeaderCurrency":{
            "maxLength":"1000",
            "type":"string",
            "description":"Name of the currency that the order header uses.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceChargeId":{
            "maxLength":"120",
            "type":"string",
            "description":"Value that uniquely identifies the charge. The source application assigns this value.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "PriceElementCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the price element, for example, LISTPRICE, NETPRICE, and so on.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceParentChargeComponentId":{
            "maxLength":"50",
            "type":"string",
            "description":"Value that uniquely identifies the charge component for the contributing charge. This attribute is used only when the parent charge is a rollup charge.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeCurrencyDurationExtendedAmount":{
            "type":"number",
            "description":"Extended amount for the duration in the charge currency.",
            "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":true
        },
        "ChargeCurrencyCode":{
            "maxLength":"1000",
            "type":"string",
            "description":"Abbreviation that identifies the currency that the charge component uses.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceManualPriceAdjustmentId":{
            "maxLength":"50",
            "type":"string",
            "description":"Value that uniquely identifies the manual price adjustment. The source application assigns this value.",
            "nullable":true,
            "x-queryable":true
        },
        "PriceElement":{
            "maxLength":"240",
            "type":"string",
            "description":"Name of the price element.",
            "nullable":true,
            "x-queryable":true
        },
        "PriceElementUsageCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the charge component usage.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeCurrencyExtendedAmount":{
            "type":"number",
            "description":"Extended amount in the charge currency. Extended amount equals the unit price multiplied by the line requested quantity for simple products and equals the unit price multiplied by the line extended quantity for configurations.",
            "nullable":true,
            "x-queryable":true
        },
        "SequenceNumber":{
            "type":"integer",
            "description":"Sequence number for the charge component.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PriceElementUsage":{
            "maxLength":"240",
            "type":"string",
            "description":"Name that describes charge component usage.",
            "nullable":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"
    }
}

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 : salesOrdersForOrderHubRequests-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.
• 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":true,
            "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-hints":{
                "includeInCompactView":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"
            }
        },
        "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":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"
    }
}

Back to Top

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

Example Response Body

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

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

Back to Top