Jump to

• Request
• Response

Update a price adjustment category

patch

/crmRestApi/resources/11.13.18.05/priceAdjustmentCategories/{AdjustmentStepId}

Request

Path Parameters

• AdjustmentStepId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AdjustmentCategoryCode: string
  Maximum Length: 30

  Code that identifies the adjustment category.
• AdjustmentStepSequenceNumber: number
  The order in which this adjustment step is applied.
• AdjustmentStepTypeCode: string
  Maximum Length: 30

  Code representing the type of adjustment step.
• AllowAfterActivationFlag: boolean
  Maximum Length: 1

  Indicates whether the step is allowed after activation.
• AllowOverApplicationFlag: boolean
  Maximum Length: 1

  Indicates whether the adjustment can be over-applied.
• BillLineAttribute: string
  Maximum Length: 60

  Attribute that determines which billing line the adjustment applies to.
• ChargeLevelFlag: boolean
  Maximum Length: 1

  Indicates whether the step applies at the charge level.
• DisplayPreferenceCode: string
  Maximum Length: 30

  Code for controlling the display preference of this step.
• ObjectVersionNumber: integer (int32)
  Number used to track the version of the record.
• UserEnterableFlag: boolean
  Maximum Length: 1

  Indicates whether the step can be entered by user.

{
    "type":"object",
    "properties":{
        "AdjustmentCategoryCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code that identifies the adjustment category.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AdjustmentStepSequenceNumber":{
            "type":"number",
            "description":"The order in which this adjustment step is applied.",
            "nullable":false
        },
        "AdjustmentStepTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code representing the type of adjustment step.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AllowAfterActivationFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the step is allowed after activation.",
            "nullable":true
        },
        "AllowOverApplicationFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the adjustment can be over-applied.",
            "nullable":true
        },
        "BillLineAttribute":{
            "maxLength":60,
            "type":"string",
            "description":"Attribute that determines which billing line the adjustment applies to.",
            "nullable":true
        },
        "ChargeLevelFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the step applies at the charge level.",
            "nullable":true
        },
        "DisplayPreferenceCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code for controlling the display preference of this step.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Number used to track the version of the record.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "UserEnterableFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the step can be entered by user.",
            "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 : priceAdjustmentCategories-item-response

Type: object

Show Source

• AdjustmentCategoryCode: string
  Maximum Length: 30

  Code that identifies the adjustment category.
• AdjustmentCategoryName: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Name of the adjustment category.
• AdjustmentStepId: integer (int64)
  Unique identifier of the adjustment step.
• AdjustmentStepSequenceNumber: number
  The order in which this adjustment step is applied.
• AdjustmentStepTypeCode: string
  Maximum Length: 30

  Code representing the type of adjustment step.
• AdjustmentStepTypeName: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Name representing the type of adjustment step.
• AllowAfterActivationFlag: boolean
  Maximum Length: 1

  Indicates whether the step is allowed after activation.
• AllowOverApplicationFlag: boolean
  Maximum Length: 1

  Indicates whether the adjustment can be over-applied.
• BillLineAttribute: string
  Maximum Length: 60

  Attribute that determines which billing line the adjustment applies to.
• ChargeLevelFlag: boolean
  Maximum Length: 1

  Indicates whether the step applies at the charge level.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the price adjustment category.
• CreationDate: string (date-time)
  Read Only: true

  The date and time the record was created.
• DisplayPreferenceCode: string
  Maximum Length: 30

  Code for controlling the display preference of this step.
• DisplayPreferenceName: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Name corresponding to the display preference code.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the price adjustment category.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login session used during the last update.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Number used to track the version of the record.
• UserEnterableFlag: boolean
  Maximum Length: 1

  Indicates whether the step can be entered by user.

{
    "type":"object",
    "properties":{
        "AdjustmentCategoryCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code that identifies the adjustment category.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AdjustmentCategoryName":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Name of the adjustment category.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AdjustmentStepId":{
            "type":"integer",
            "description":"Unique identifier of the adjustment step.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AdjustmentStepSequenceNumber":{
            "type":"number",
            "description":"The order in which this adjustment step is applied.",
            "nullable":false,
            "x-queryable":true
        },
        "AdjustmentStepTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code representing the type of adjustment step.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AdjustmentStepTypeName":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Name representing the type of adjustment step.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AllowAfterActivationFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the step is allowed after activation.",
            "nullable":true,
            "x-queryable":true
        },
        "AllowOverApplicationFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the adjustment can be over-applied.",
            "nullable":true,
            "x-queryable":true
        },
        "BillLineAttribute":{
            "maxLength":60,
            "type":"string",
            "description":"Attribute that determines which billing line the adjustment applies to.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeLevelFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the step applies at the charge level.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the price adjustment category.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplayPreferenceCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code for controlling the display preference of this step.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DisplayPreferenceName":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Name corresponding to the display preference code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login session used during the last update.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the price adjustment category.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Number used to track the version of the record.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "UserEnterableFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the step can be entered by user.",
            "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."
        }
    }
}

Links

AdjustmentDispPrefLookupVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_CHARGE_DISPLAY_PREF

The following properties are defined on the LOV link relation:

• Source Attribute: DisplayPreferenceCode; Target Attribute: LookupCode
• Display Attribute: Meaning

AdjustmentStepTypeLookupVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_ADJ_STEP_TYPE

The following properties are defined on the LOV link relation:

• Source Attribute: AdjustmentStepTypeCode; Target Attribute: LookupCode
• Display Attribute: Meaning

getPriceStepSequenceNumberLimit

Operation: /crmRestApi/resources/11.13.18.05/priceAdjustmentCategories/{AdjustmentStepId}/action/getPriceStepSequenceNumberLimit

Parameters:

• AdjustmentStepId: $request.path.AdjustmentStepId

This method returns the maximum allowed sequence number for price adjustment steps within a category.

Back to Top