Update Pricing Attribute
patch
/rest/v16/pricingSetup/attributes/{attributeVarName}/
Use this endpoint to update the specified pricing attribute.
Request
Supported Media Types
- application/json
Path Parameters
Root Schema : PricingAttribute
Type:
Show Source
object
-
arrayType:
boolean()
Title:
Array Type
Indicates whether Pricing Attribute is an array type. -
attributeLevel:
string()
Title:
Attribute Level
Allowed Values:[ "Header", "Line", "Charge" ]
Pricing Attribute Level. -
createdBy:
Created By
Title:
Created By
Read Only:true
The details of the user who created the record. -
dataType:
string()
Title:
Data Type
Allowed Values:[ "Boolean", "Currency", "String", "Decimal", "Date", "Integer", "Text Area" ]
Data Type of the Pricing Attribute. -
dateAdded:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
Date Added
Read Only:true
Creation date of the Pricing Attribute. -
dateModified:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
Date Modified
Read Only:true
Last modified date of the Pricing Attribute. -
description:
string()
Title:
Description
Description of the Pricing Attribute. -
lastModifiedBy:
Last Modified By
Title:
Last Modified By
Read Only:true
The details of the user who modified the record. -
links:
array Links
Title:
Links
Read Only:true
The link relations associated with the resource instance. -
lookupType:
string()
Title:
Lookup Type
The lookup type variable name for the Pricing Attribute. -
lookupTypeLabel:
string()
Title:
Lookup Type Display Label
Read Only:true
The lookup type display label for the Pricing Attribute. -
mappings:
Attribute Mappings
Title:
Attribute Mappings
Read Only:true
List of mappings for the Pricing Attribute. -
name:
string()
Title:
Name
Name of the Pricing Attribute. -
templateVariableKey:
string()
Title:
Template Variable Key
Read Only:true
Allowed Values:[ "Custom", "Quantity", "BomItemVariableName", "ChargeAttribute", "PriceAsOf", "RequestedRatePlanNumber", "ServiceDuration", "ServiceDurationPeriod", "RequestedAgreementNumber", "BuyingAccountID", "Currency Code", "PartNumber", "Customer ID", "Line Price As Of" ]
Pricing Attribute template variable key. -
valid:
boolean()
Title:
Valid
Read Only:true
Indicates whether Pricing Attribute is valid. -
variableName:
string()
Title:
Variable Name
Variable Name of the Pricing Attribute.
Nested Schema : Created By
Title:
Created By
Read Only:
true
The details of the user who created the record.
Match All
Show Source
Nested Schema : Last Modified By
Title:
Last Modified By
Read Only:
true
The details of the user who modified the record.
Match All
Show Source
Nested Schema : Links
Type:
array
Title:
Links
Read Only:
true
The link relations associated with the resource instance.
Show Source
Nested Schema : Attribute Mappings
Title:
Attribute Mappings
Read Only:
true
List of mappings for the Pricing Attribute.
Match All
Show Source
Nested Schema : UserDetails
Type:
Show Source
object
-
emailId:
string()
Title:
Email Id
Email Id of the user -
firstName:
string()
Title:
First Name
First Name of the user -
lastName:
string()
Title:
Last Name
Last Name of the user
Nested Schema : PricingResourceCollection_PricingMappedDataSourceAttribute
Type:
Show Source
object
-
count:
integer()
Title:
Count
Read Only:true
The number of resource instances returned in the current range. -
createdBy:
Created By
Title:
Created By
Read Only:true
The details of the user who created the record. -
hasMore:
boolean()
Title:
HasMore
Read Only:true
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
-
lastModifiedBy:
Last Modified By
Title:
Last Modified By
Read Only:true
The details of the user who modified the record. -
limit:
integer()
Title:
Limit
Read Only:true
The actual paging size used by the server. -
links:
array Links
Title:
Links
Read Only:true
The link relations associated with the resource instance. -
offset:
integer()
Title:
OffSet
Read Only:true
The offset value used in the current page. -
totalResults:
integer()
Title:
Total Results
Read Only:true
Captures the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.
Nested Schema : Created By
Title:
Created By
Read Only:
true
The details of the user who created the record.
Match All
Show Source
Nested Schema : Last Modified By
Title:
Last Modified By
Read Only:
true
The details of the user who modified the record.
Match All
Show Source
Nested Schema : Links
Type:
array
Title:
Links
Read Only:
true
The link relations associated with the resource instance.
Show Source
Nested Schema : PricingMappedDataSourceAttribute
Type:
Show Source
object
-
attributeLabel:
string()
Title:
Attribute Label
Read Only:true
The label of the Pricing Data Source Attribute. -
createdBy:
Created By
Title:
Created By
Read Only:true
The details of the user who created the record. -
dataSourceAttribute:
string()
Title:
Data Source Attribute.
Read Only:true
The mapped data source attribute. -
dataSourceLabel:
string()
Title:
Data Source Label
Read Only:true
The mapped label of the data source. -
dataSourceProviderVariableName:
string()
Title:
Data Source Provider Variable Name
Read Only:true
The variable name of the data source provider. -
dateAdded:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
Date Added
Read Only:true
Creation date of the Pricing Rule. -
dateModified:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
Date Modified
Read Only:true
Last modified date of the Pricing Rule. -
id:
integer()
Title:
Id
Read Only:true
The Unique Identifier of the Pricing Data Source Attribute. -
lastModifiedBy:
Last Modified By
Title:
Last Modified By
Read Only:true
The details of the user who modified the record. -
links:
array Links
Title:
Links
Read Only:true
The link relations associated with the resource instance. -
orderNumber:
integer()
Title:
Order Number
The position(starting from 1) of the Pricing Data Source Attribute in the ordered list. -
readOnly:
boolean()
Title:
Read Only
Read Only:true
Indicates if the attribute has any restrictions for edits. -
validMapping:
boolean()
Title:
Has Valid Mapping
Read Only:true
Indicates whether the Pricing Data Source Attribute has a valid mapping -
variableName:
string()
Title:
Variable Name
Read Only:true
The variable name of the Pricing Data Source Attribute.
Nested Schema : Created By
Title:
Created By
Read Only:
true
The details of the user who created the record.
Match All
Show Source
Nested Schema : Last Modified By
Title:
Last Modified By
Read Only:
true
The details of the user who modified the record.
Match All
Show Source
Nested Schema : Links
Type:
array
Title:
Links
Read Only:
true
The link relations associated with the resource instance.
Show Source
Response
204 Response
Success