Jump to

• Request
• Response

Update one charge tier

patch

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

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.
• chargeTiersUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Charge Tiers resource and used to uniquely identify an instance of Charge Tiers. The client should not generate the hash key value. Instead, the client should query on the Charge Tiers collection resource in order to navigate to a specific instance of Charge Tiers to get the hash key.
• chargesUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Charges resource and used to uniquely identify an instance of Charges. The client should not generate the hash key value. Instead, the client should query on the Charges collection resource in order to navigate to a specific instance of Charges to get the hash key.
• 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

• 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.
• 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
        },
        "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
        },
        "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":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 : 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"
    }
}

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."
        }
    }
}

Back to Top