Get Rate Card Template Columns
get
/rest/v16/pricingSetup/rateCardTemplates/{templateVarName}/columns
Use this endpoint to retrieve all columns for the specified rate card template.
Request
Path Parameters
Query Parameters
-
fields: string
This parameter filters the resource attributes. Only the specified attributes are returned, which means that if no attributes are specified, all attributes are returned.
-
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<VarName>=<variableValue>
The following are the available finder names and corresponding finder variables:- findByKeyword: Find rate card template column using name, VarName and description
Finder Variable:- keyword;string: The search text. The character '%' if present will be treated as a wild card otherwise, the default is 'contains' search
- findByKeyword: Find rate card template column using name, VarName and description
-
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.
-
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 attributes. 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
Filter (a 'where' clause) to restrict the items returned in the collection. By default, no filtering is applied.
-
totalResults: boolean
The resource collection representation will include the total row count when "?totalResults=true", otherwise the count is not included. The default value is "false".
Response
Supported Media Types
- application/json
200 Response
Success
Root 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