Jump to

• Request
• Response

Get all price adjustment categories

get

/crmRestApi/resources/11.13.18.05/priceAdjustmentCategories

Request

Query Parameters

• 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
  
  

  • OSS_PRICE_ADJUSTMENT_STEPS_AK1 Finds the price adjustment steps by adjustment category code.
    Finder Variables
    • AdjustmentCategoryCode; string; The adjustment category code used to locate related adjustment steps.
  • OSS_PRICE_ADJUSTMENT_STEPS_AK2 Find price adjustment steps by sequence number.
    Finder Variables
    • AdjustmentStepSequenceNumber; number; The sequence number used to identify a specific adjustment step.
  • PrimaryKey Find a specific price adjustment step by its unique identifier.
    Finder Variables
    • AdjustmentStepId; integer; The unique identifier of the price adjustment step.
• 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:
  

  • AdjustmentCategoryCode; string; Code that identifies the adjustment category.
  • AdjustmentCategoryName; string; Name of the adjustment category.
  • AdjustmentStepId; integer; Unique identifier of the adjustment step.
  • AdjustmentStepSequenceNumber; number; The order in which this adjustment step is applied.
  • AdjustmentStepTypeCode; string; Code representing the type of adjustment step.
  • AdjustmentStepTypeName; string; Name representing the type of adjustment step.
  • AllowAfterActivationFlag; boolean; Indicates whether the step is allowed after activation.
  • AllowOverApplicationFlag; boolean; Indicates whether the adjustment can be over-applied.
  • BillLineAttribute; string; Attribute that determines which billing line the adjustment applies to.
  • ChargeLevelFlag; boolean; Indicates whether the step applies at the charge level.
  • CreatedBy; string; The user who created the price adjustment category.
  • CreationDate; string; The date and time the record was created.
  • DisplayPreferenceCode; string; Code for controlling the display preference of this step.
  • DisplayPreferenceName; string; Name corresponding to the display preference code.
  • LastUpdateDate; string; Date and time when the record was last updated.
  • LastUpdateLogin; string; The login session used during the last update.
  • LastUpdatedBy; string; The user who last updated the price adjustment category.
  • ObjectVersionNumber; integer; Number used to track the version of the record.
  • UserEnterableFlag; boolean; Indicates whether the step can be entered by user.
• 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: 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 : priceAdjustmentCategories

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":{
        "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."
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/priceAdjustmentCategories-item-response"
            }
        },
        "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"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    },
    "x-hints":{
        "usage":"LOV",
        "group":"OEC"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object priceAdjustmentCategories-item-response

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

Back to Top