Jump to

• Request
• Response

Get one adjustment

get

/fscmRestApi/resources/11.13.18.05/salesOrderActionRequests/{ActionRequestId}/child/manualPriceAdjustments/{manualPriceAdjustmentsUniqID}

Request

Path Parameters

• ActionRequestId(required): integer(int64)
  Unique identifier for the master action request.
• manualPriceAdjustmentsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Manual Price Adjustments resource and used to uniquely identify an instance of Manual Price Adjustments. The client should not generate the hash key value. Instead, the client should query on the Manual Price Adjustments collection resource in order to navigate to a specific instance of Manual Price Adjustments 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
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• Metadata-Context: string
  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: string
  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 : salesOrderActionRequests-manualPriceAdjustments-item-response

Type: object

Show Source

• AdjustmentAmount: number
  Amount of the manual price adjustment for a charge, which can be specified as either a fixed amount or a percentage.
• AdjustmentElementBasis: string
  Maximum Length: 255

  Basis used by pricing to calculate the manual price adjustment, which can be either QP_NET_PRICE or QP_LIST_PRICE.
• AdjustmentElementBasisName: string
  Maximum Length: 255

  Name of the basis used by pricing to calculate the manual price adjustment, which can be either Your Price or List Price.
• AdjustmentType: string
  Maximum Length: 255

  Method that pricing uses to calculate the manual price adjustment for the item. A list of accepted values is defined in the lookup type ORA_QP_LINE_ADJ_TYPES.
• AdjustmentTypeCode: string
  Maximum Length: 255

  Abbreviation that identifies the type of manual price adjustment. A list of accepted values is defined in the lookup type ORA_QP_LINE_ADJ_TYPES.
• ChargeDefinition: string
  Maximum Length: 255

  Definition of the charge that pricing uses to apply a manual price adjustment.
• ChargeDefinitionCode: string
  Maximum Length: 255

  Abbreviation that identifies the definition of the charge that pricing uses to apply a manual price adjustment.
• Comments: string
  Maximum Length: 255

  Comments that describe the manual price adjustment.
• EffectiveNumberOfPeriods: number
  Number of periods to use for the price adjustment. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.
• EffectivePeriodFrom: number
  Number that identifies the period when the price adjustment starts. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.
• EffectivePeriodUntil: number
  Number that identifies the period when the price adjustment ends. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.
• EffectivityType: string
  Maximum Length: 255

  Type of effectiveness for the price adjustment, available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages feature.
• EffectivityTypeCode: string
  Maximum Length: 255

  Abbreviation that identifies the type of effectiveness to be used for the price adjustment. A list of accepted values is defined in the lookup type ORA_OSS_PRICE_ADJ_EFFECTIVITY. This abbreviation is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages feature.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PricePeriodicity: string
  Maximum Length: 255

  Price periodicity of the recurring charge where pricing applies the manual price adjustment.
• PricePeriodicityCode: string
  Maximum Length: 255

  Abbreviation that identifies the price periodicity of the recurring charge, where pricing applies the manual price adjustment.
• Reason: string
  Maximum Length: 255

  Reason for the manual price adjustment.
• ReasonCode: string
  Maximum Length: 255

  Abbreviation that identifies the reason for the manual price adjustment.
• SequenceNumber: number
  Sequence that pricing uses to apply the manual price adjustment to other manual price adjustments.
• SourceManualPriceAdjustmentId: string
  Maximum Length: 255

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

  Usage UOM of the usage charge where pricing applies, the manual price adjustment.
• UsageUOMCode: string
  Maximum Length: 255

  Abbreviation that identifies the usage UOM of the usage charge, where pricing applies the manual price adjustment.

{
    "type":"object",
    "properties":{
        "AdjustmentAmount":{
            "type":"number",
            "description":"Amount of the manual price adjustment for a charge, which can be specified as either a fixed amount or a percentage.",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustmentElementBasis":{
            "maxLength":255,
            "type":"string",
            "description":"Basis used by pricing to calculate the manual price adjustment, which can be either QP_NET_PRICE or QP_LIST_PRICE.",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustmentElementBasisName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the basis used by pricing to calculate the manual price adjustment, which can be either Your Price or List Price.",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustmentType":{
            "maxLength":255,
            "type":"string",
            "description":"Method that pricing uses to calculate the manual price adjustment for the item. A list of accepted values is defined in the lookup type ORA_QP_LINE_ADJ_TYPES.",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustmentTypeCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the type of manual price adjustment. A list of accepted values is defined in the lookup type ORA_QP_LINE_ADJ_TYPES.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeDefinition":{
            "maxLength":255,
            "type":"string",
            "description":"Definition of the charge that pricing uses to apply a manual price adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeDefinitionCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the definition of the charge that pricing uses to apply a manual price adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "Comments":{
            "maxLength":255,
            "type":"string",
            "description":"Comments that describe the manual price adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "EffectiveNumberOfPeriods":{
            "type":"number",
            "description":"Number of periods to use for the price adjustment. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.",
            "nullable":true,
            "x-queryable":true
        },
        "EffectivePeriodFrom":{
            "type":"number",
            "description":"Number that identifies the period when the price adjustment starts. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.",
            "nullable":true,
            "x-queryable":true
        },
        "EffectivePeriodUntil":{
            "type":"number",
            "description":"Number that identifies the period when the price adjustment ends. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.",
            "nullable":true,
            "x-queryable":true
        },
        "EffectivityType":{
            "maxLength":255,
            "type":"string",
            "description":"Type of effectiveness for the price adjustment, available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages feature.",
            "nullable":true,
            "x-queryable":true
        },
        "EffectivityTypeCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the type of effectiveness to be used for the price adjustment. A list of accepted values is defined in the lookup type ORA_OSS_PRICE_ADJ_EFFECTIVITY. This abbreviation is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages feature.",
            "nullable":true,
            "x-queryable":true
        },
        "PricePeriodicity":{
            "maxLength":255,
            "type":"string",
            "description":"Price periodicity of the recurring charge where pricing applies the manual price adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "PricePeriodicityCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the price periodicity of the recurring charge, where pricing applies the manual price adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "Reason":{
            "maxLength":255,
            "type":"string",
            "description":"Reason for the manual price adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "ReasonCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the reason for the manual price adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "SequenceNumber":{
            "type":"number",
            "description":"Sequence that pricing uses to apply the manual price adjustment to other manual price adjustments.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceManualPriceAdjustmentId":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the manual price adjustment. The source application assigns this value.",
            "nullable":true,
            "x-queryable":true
        },
        "UsageUOM":{
            "maxLength":255,
            "type":"string",
            "description":"Usage UOM of the usage charge where pricing applies, the manual price adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "UsageUOMCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the usage UOM of the usage charge, where pricing applies the manual price adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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