Update Pricing Matrix Template
patch
/rest/v16/pricingSetup/matrixTemplates/{templateVarName}/
Use this endpoint to update the specified pricing matrix template.
Request
Supported Media Types
- application/json
Path Parameters
Root Schema : PricingMatrixTemplate
Type:
Show Source
object
-
active:
boolean()
Title:
Active
Indicates if the pricing matrix template is active. -
allowedChargeDefinitions:
array Allowed Charge Definitions
Title:
Allowed Charge Definitions
The list of charge definitions that this pricing matrix will apply to. -
columns:
Pricing Matrix Template Columns
Title:
Pricing Matrix Template Columns
Read Only:true
List of columns for the Pricing Matrix Template. Ignored if rate card template. -
createdBy:
Created By
Title:
Created By
Read Only:true
The details of the user who created the record. -
dateAdded:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
Date Added
Read Only:true
Creation Date of the Pricing Matrix Template. -
dateModified:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
Date Modified
Read Only:true
Last Modified date of the Pricing Matrix Template. -
description:
string()
Title:
Description
Description of the Pricing Matrix Template. -
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. -
name(required):
string()
Title:
Name
Name of the Pricing Matrix Template. -
pricingMatrixCount:
integer()
Title:
Linked Pricing Matrixes Count
Read Only:true
The count of pricing matrixes linked to this template. -
rateCardCount:
integer()
Title:
Linked Pricing Matrixes Count
Read Only:true
The count of rate cards linked to this template. -
templateType:
string()
Title:
Template Type
Allowed Values:[ "rateCard", "attributeBasedCharge" ]
The type of this Pricing Matrix Template. -
variableName:
string()
Title:
Variable Name
Unique Variable Name of the Pricing Matrix Template.
Nested Schema : Allowed Charge Definitions
Type:
array
Title:
Allowed Charge Definitions
The list of charge definitions that this pricing matrix will apply to.
Show Source
Nested Schema : Pricing Matrix Template Columns
Title:
Pricing Matrix Template Columns
Read Only:
true
List of columns for the Pricing Matrix Template. Ignored if rate card template.
Match All
Show Source
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 : PricingMenuItem
Type:
Show Source
object
-
displayValue:
string()
Title:
Display Value
The display value of the menu item. -
value:
string()
Title:
Value
The raw value of the menu item.
Nested Schema : PricingResourceCollection_PricingMatrixTemplateColumn
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 : 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 : PricingMatrixTemplateColumn
Type:
Show Source
object
-
active:
boolean()
Title:
Active
Indicates if the rate card template column is active. -
createdBy:
Created By
Title:
Created By
Read Only:true
The details of the user who created the record. -
dataType(required):
string()
Title:
Data Type
Allowed Values:[ "Boolean", "Currency", "String", "Decimal", "Date", "Integer" ]
Data Type of the Rate Card Template column. -
dateAdded:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
Date Added
Read Only:true
Creation Date of the Rate Card Template column. -
dateModified:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
Date Modified
Read Only:true
Last Modified date of the Rate Card Template column. -
defaultOverridable:
boolean()
Title:
Default Overridable
Indicates if the default value is overridable -
defaultValue:
string()
Title:
Default Value
Default Value of the Rate Card Template column. -
description:
string()
Title:
Description
Description of the Rate Card Template column. -
id:
integer()
Title:
Id
Read Only:true
The Unique Identifier of the Rate Card Template column. -
integrationId:
string()
Title:
Integration ID
Read Only:true
Identifier for the corresponding entity in QP. -
ioType:
string()
Title:
Input/Output Type
Allowed Values:[ "input", "output" ]
The Input/Output Type of the Pricing Matrix column. -
key:
boolean()
Title:
Active
Indicates if the rate card template column is a key. -
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
Lookup Type of the Rate Card Template column. -
lookupTypeLabel:
string()
Title:
Lookup Type Display Label
Read Only:true
The lookup type display label of the Rate Card Template column. -
name:
string()
Title:
Name
Name of the Rate Card Template column. -
negotiable:
boolean()
Title:
Negotiable
Indicates if the value stored in this rate card template column is negotiable. -
operator:
string()
Title:
Operator
Allowed Values:[ "none", "<", "<=", "Not =", "=", ">", ">=", "Contains", "Not Contains", "Starts With", "Not Starts With", "Ends With", "Not Ends With" ]
The operator to be applied on this Pricing Matrix column. -
orderNumber:
integer()
Title:
Order Number
The sequence number of the column in the template. -
pricingAttribute:
string()
Title:
Pricing Attribute
The pricing attribute refered to in this Pricing Matrix column. -
required:
boolean()
Title:
Required
Indicates if the value of this rate card template column is required. -
templateType:
string()
Title:
Template Type
Read Only:true
Allowed Values:[ "rateCard", "attributeBasedCharge" ]
The type of the parent Pricing Matrix Template. -
variableName:
string()
Title:
Variable Name
Variable Name of the Rate Card Template column. -
wildCardSupported:
boolean()
Title:
Wild Card Supported
Indicates if this column supports wild card values.
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