Jump to

• Request
• Response

Get Pricing Matrix Template

get

/rest/v16/pricingSetup/matrixTemplates/{templateVarName}/

Use this endpoint to retrieve the specified pricing matrix template.

Request

Path Parameters

• templateVarName(required): string

Query Parameters

• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). More than one child can be specified using comma as a separator. Example: ?expand=columns. To include all the children and grandchildren, specify the value of this query parameter to be "all".
• 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.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : PricingMatrixTemplate

Type: object

Show Source

• 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.

{
    "required":[
        "name"
    ],
    "properties":{
        "createdBy":{
            "format":"",
            "description":"The details of the user who created the record.",
            "title":"Created By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "lastModifiedBy":{
            "format":"",
            "description":"The details of the user who modified the record.",
            "title":"Last Modified By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "name":{
            "type":"string",
            "format":"",
            "description":"Name of the Pricing Matrix Template.",
            "title":"Name"
        },
        "variableName":{
            "type":"string",
            "format":"",
            "description":"Unique Variable Name of the Pricing Matrix Template.",
            "title":"Variable Name"
        },
        "active":{
            "type":"boolean",
            "format":"",
            "description":"Indicates if the pricing matrix template is active.",
            "title":"Active"
        },
        "description":{
            "type":"string",
            "format":"",
            "description":"Description of the Pricing Matrix Template.",
            "title":"Description"
        },
        "rateCardCount":{
            "type":"integer",
            "format":"",
            "description":"The count of rate cards linked to this template.",
            "title":"Linked Pricing Matrixes Count",
            "readOnly":true
        },
        "pricingMatrixCount":{
            "type":"integer",
            "format":"",
            "description":"The count of pricing matrixes linked to this template.",
            "title":"Linked Pricing Matrixes Count",
            "readOnly":true
        },
        "dateAdded":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Creation Date of the Pricing Matrix Template.",
            "title":"Date Added",
            "readOnly":true
        },
        "dateModified":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Last Modified date of the Pricing Matrix Template.",
            "title":"Date Modified",
            "readOnly":true
        },
        "columns":{
            "format":"",
            "description":"List of columns for the Pricing Matrix Template. Ignored if rate card template.",
            "title":"Pricing Matrix Template Columns",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/PricingResourceCollection_PricingMatrixTemplateColumn"
                }
            ]
        },
        "allowedChargeDefinitions":{
            "type":"array",
            "format":"",
            "description":"The list of charge definitions that this pricing matrix will apply to.",
            "title":"Allowed Charge Definitions",
            "items":{
                "$ref":"#/definitions/PricingMenuItem"
            }
        },
        "links":{
            "type":"array",
            "format":"",
            "description":"The link relations associated with the resource instance.",
            "title":"Links",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "templateType":{
            "type":"string",
            "format":"",
            "description":"The type of this Pricing Matrix Template.",
            "title":"Template Type",
            "enum":[
                "rateCard",
                "attributeBasedCharge"
            ]
        }
    }
}

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

• Array of: object PricingMenuItem

{
    "type":"array",
    "format":"",
    "description":"The list of charge definitions that this pricing matrix will apply to.",
    "title":"Allowed Charge Definitions",
    "items":{
        "$ref":"#/definitions/PricingMenuItem"
    }
}

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

• object PricingResourceCollection_PricingMatrixTemplateColumn

{
    "format":"",
    "description":"List of columns for the Pricing Matrix Template. Ignored if rate card template.",
    "title":"Pricing Matrix Template Columns",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/PricingResourceCollection_PricingMatrixTemplateColumn"
        }
    ]
}

Nested Schema : Created By

Title: Created By

Read Only: true

The details of the user who created the record.

Match All

Show Source

• object UserDetails

{
    "format":"",
    "description":"The details of the user who created the record.",
    "title":"Created By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

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

• object UserDetails

{
    "format":"",
    "description":"The details of the user who modified the record.",
    "title":"Last Modified By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Links

Type: array

Title: Links

Read Only: true

The link relations associated with the resource instance.

Show Source

• Array of: object Link

{
    "type":"array",
    "format":"",
    "description":"The link relations associated with the resource instance.",
    "title":"Links",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : PricingMenuItem

Type: object

Show Source

• displayValue: string()
  Title: Display Value

  The display value of the menu item.
• value: string()
  Title: Value

  The raw value of the menu item.

{
    "properties":{
        "value":{
            "type":"string",
            "format":"",
            "description":"The raw value of the menu item.",
            "title":"Value"
        },
        "displayValue":{
            "type":"string",
            "format":"",
            "description":"The display value of the menu item.",
            "title":"Display Value"
        }
    }
}

Nested Schema : PricingResourceCollection_PricingMatrixTemplateColumn

Type: object

Show Source

• 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.

{
    "properties":{
        "createdBy":{
            "format":"",
            "description":"The details of the user who created the record.",
            "title":"Created By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "lastModifiedBy":{
            "format":"",
            "description":"The details of the user who modified the record.",
            "title":"Last Modified By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PricingMatrixTemplateColumn"
            }
        },
        "offset":{
            "type":"integer",
            "format":"",
            "description":"The offset value used in the current page.",
            "title":"OffSet",
            "readOnly":true
        },
        "limit":{
            "type":"integer",
            "format":"",
            "description":"The actual paging size used by the server.",
            "title":"Limit",
            "readOnly":true
        },
        "count":{
            "type":"integer",
            "format":"",
            "description":"The number of resource instances returned in the current range.",
            "title":"Count",
            "readOnly":true
        },
        "totalResults":{
            "type":"integer",
            "format":"",
            "description":"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.",
            "title":"Total Results",
            "readOnly":true
        },
        "hasMore":{
            "type":"boolean",
            "format":"",
            "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.",
            "title":"HasMore",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "format":"",
            "description":"The link relations associated with the resource instance.",
            "title":"Links",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : Created By

Title: Created By

Read Only: true

The details of the user who created the record.

Match All

Show Source

• object UserDetails

{
    "format":"",
    "description":"The details of the user who created the record.",
    "title":"Created By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object PricingMatrixTemplateColumn

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/PricingMatrixTemplateColumn"
    }
}

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

• object UserDetails

{
    "format":"",
    "description":"The details of the user who modified the record.",
    "title":"Last Modified By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Links

Type: array

Title: Links

Read Only: true

The link relations associated with the resource instance.

Show Source

• Array of: object Link

{
    "type":"array",
    "format":"",
    "description":"The link relations associated with the resource instance.",
    "title":"Links",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : UserDetails

Type: object

Show Source

• 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

{
    "properties":{
        "firstName":{
            "type":"string",
            "format":"",
            "description":"First Name of the user",
            "title":"First Name"
        },
        "lastName":{
            "type":"string",
            "format":"",
            "description":"Last Name of the user",
            "title":"Last Name"
        },
        "emailId":{
            "type":"string",
            "format":"",
            "description":"Email Id of the user",
            "title":"Email Id"
        }
    }
}

Nested Schema : PricingMatrixTemplateColumn

Type: object

Show Source

• 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.

{
    "required":[
        "dataType"
    ],
    "properties":{
        "createdBy":{
            "format":"",
            "description":"The details of the user who created the record.",
            "title":"Created By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "lastModifiedBy":{
            "format":"",
            "description":"The details of the user who modified the record.",
            "title":"Last Modified By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "id":{
            "type":"integer",
            "format":"",
            "description":"The Unique Identifier of the Rate Card Template column.",
            "title":"Id",
            "readOnly":true
        },
        "orderNumber":{
            "type":"integer",
            "format":"",
            "description":"The sequence number of the column in the template.",
            "title":"Order Number"
        },
        "name":{
            "type":"string",
            "format":"",
            "description":"Name of the Rate Card Template column.",
            "title":"Name"
        },
        "variableName":{
            "type":"string",
            "format":"",
            "description":"Variable Name of the Rate Card Template column.",
            "title":"Variable Name"
        },
        "key":{
            "type":"boolean",
            "format":"",
            "description":"Indicates if the rate card template column is a key.",
            "title":"Active"
        },
        "dataType":{
            "type":"string",
            "format":"",
            "description":"Data Type of the Rate Card Template column.",
            "title":"Data Type",
            "enum":[
                "Boolean",
                "Currency",
                "String",
                "Decimal",
                "Date",
                "Integer"
            ]
        },
        "lookupType":{
            "type":"string",
            "format":"",
            "description":"Lookup Type of the Rate Card Template column.",
            "title":"Lookup Type"
        },
        "lookupTypeLabel":{
            "type":"string",
            "format":"",
            "description":"The lookup type display label of the Rate Card Template column.",
            "title":"Lookup Type Display Label",
            "readOnly":true
        },
        "defaultValue":{
            "type":"string",
            "format":"",
            "description":"Default Value of the Rate Card Template column.",
            "title":"Default Value"
        },
        "defaultOverridable":{
            "type":"boolean",
            "format":"",
            "description":"Indicates if the default value is overridable",
            "title":"Default Overridable"
        },
        "description":{
            "type":"string",
            "format":"",
            "description":"Description of the Rate Card Template column.",
            "title":"Description"
        },
        "active":{
            "type":"boolean",
            "format":"",
            "description":"Indicates if the rate card template column is active.",
            "title":"Active"
        },
        "negotiable":{
            "type":"boolean",
            "format":"",
            "description":"Indicates if the value stored in this rate card template column is negotiable.",
            "title":"Negotiable"
        },
        "required":{
            "type":"boolean",
            "format":"",
            "description":"Indicates if the value of this rate card template column is required.",
            "title":"Required"
        },
        "integrationId":{
            "type":"string",
            "format":"",
            "description":"Identifier for the corresponding entity in QP.",
            "title":"Integration ID",
            "readOnly":true
        },
        "dateAdded":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Creation Date of the Rate Card Template column.",
            "title":"Date Added",
            "readOnly":true
        },
        "dateModified":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Last Modified date of the Rate Card Template column.",
            "title":"Date Modified",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "format":"",
            "description":"The link relations associated with the resource instance.",
            "title":"Links",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "ioType":{
            "type":"string",
            "format":"",
            "description":"The Input/Output Type of the Pricing Matrix column.",
            "title":"Input/Output Type",
            "enum":[
                "input",
                "output"
            ]
        },
        "operator":{
            "type":"string",
            "format":"",
            "description":"The operator to be applied on this Pricing Matrix column.",
            "title":"Operator",
            "enum":[
                "none",
                "<",
                "<=",
                "Not =",
                "=",
                ">",
                ">=",
                "Contains",
                "Not Contains",
                "Starts With",
                "Not Starts With",
                "Ends With",
                "Not Ends With"
            ]
        },
        "pricingAttribute":{
            "type":"string",
            "format":"",
            "description":"The pricing attribute refered to in this Pricing Matrix column.",
            "title":"Pricing Attribute"
        },
        "wildCardSupported":{
            "type":"boolean",
            "format":"",
            "description":"Indicates if this column supports wild card values.",
            "title":"Wild Card Supported"
        },
        "templateType":{
            "type":"string",
            "format":"",
            "description":"The type of the parent Pricing Matrix Template.",
            "title":"Template Type",
            "readOnly":true,
            "enum":[
                "rateCard",
                "attributeBasedCharge"
            ]
        }
    }
}

Nested Schema : Created By

Title: Created By

Read Only: true

The details of the user who created the record.

Match All

Show Source

• object UserDetails

{
    "format":"",
    "description":"The details of the user who created the record.",
    "title":"Created By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

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

• object UserDetails

{
    "format":"",
    "description":"The details of the user who modified the record.",
    "title":"Last Modified By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Links

Type: array

Title: Links

Read Only: true

The link relations associated with the resource instance.

Show Source

• Array of: object Link

{
    "type":"array",
    "format":"",
    "description":"The link relations associated with the resource instance.",
    "title":"Links",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : Link

Type: object

Show Source

• href: string
• name: string
• rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "name":{
            "type":"string"
        }
    }
}

Back to Top