Jump to

• Request
• Response

Create one pricing matrix

post

/fscmRestApi/resources/11.13.18.05/priceLists/{PriceListId}/child/items/{PriceListItemId}/child/charges/{PriceListChargeId}/child/pricingMatrixes

Request

Path Parameters

• PriceListChargeId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• PriceListId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• PriceListItemId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ChangeTypeCode: string
  Maximum Length: 30

  Code that designates the type of change for the pricing matrixes for the approval flow.
• dimensions: array Matrix Dimensions
  Title: Matrix Dimensions

  A matrix dimension is a condition with which you can drive price adjustments, discounts, and rate tables.
• EntityApprovalStatusCode: string
  Maximum Length: 30

  Code for the pricing matrices' approval status when the approval flow is enabled. This is null if the feature opt-in is set to No.
• MatrixId: integer (int64)
  Title: Rule Table Id

  Value that uniquely identifies the pricing matrix.
• MatrixName: string
  Title: Name

  Maximum Length: 64

  Name of the pricing matrix.
• rules: array Matrix Rules
  Title: Matrix Rules

  A matrix rule represents a condition based price adjustment, discount, rate table, and other features.

{
    "type":"object",
    "properties":{
        "ChangeTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code that designates the type of change for the pricing matrixes for the approval flow.",
            "nullable":true
        },
        "EntityApprovalStatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code for the pricing matrices' approval status when the approval flow is enabled. This is null if the feature opt-in is set to No.",
            "nullable":true
        },
        "MatrixId":{
            "title":"Rule Table Id",
            "type":"integer",
            "description":"Value that uniquely identifies the pricing matrix.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "MatrixName":{
            "title":"Name",
            "maxLength":64,
            "type":"string",
            "description":"Name of the pricing matrix.",
            "nullable":false
        },
        "dimensions":{
            "title":"Matrix Dimensions",
            "type":"array",
            "description":"A matrix dimension is a condition with which you can drive price adjustments, discounts, and rate tables.",
            "items":{
                "$ref":"#/components/schemas/priceLists-items-charges-pricingMatrixes-dimensions-item-post-request"
            }
        },
        "rules":{
            "title":"Matrix Rules",
            "type":"array",
            "description":"A matrix rule represents a condition based price adjustment, discount, rate table, and other features.",
            "items":{
                "$ref":"#/components/schemas/priceLists-items-charges-pricingMatrixes-rules-item-post-request"
            }
        }
    }
}

Nested Schema : Matrix Dimensions

Type: array

Title: Matrix Dimensions

A matrix dimension is a condition with which you can drive price adjustments, discounts, and rate tables.

Show Source

• Array of: object schema

{
    "title":"Matrix Dimensions",
    "type":"array",
    "description":"A matrix dimension is a condition with which you can drive price adjustments, discounts, and rate tables.",
    "items":{
        "$ref":"#/components/schemas/priceLists-items-charges-pricingMatrixes-dimensions-item-post-request"
    }
}

Nested Schema : Matrix Rules

Type: array

Title: Matrix Rules

A matrix rule represents a condition based price adjustment, discount, rate table, and other features.

Show Source

• Array of: object priceLists-items-charges-pricingMatrixes-rules-item-post-request

{
    "title":"Matrix Rules",
    "type":"array",
    "description":"A matrix rule represents a condition based price adjustment, discount, rate table, and other features.",
    "items":{
        "$ref":"#/components/schemas/priceLists-items-charges-pricingMatrixes-rules-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• ChangeTypeCode: string
  Maximum Length: 30

  Code that designates the type of change for the dimensions for the approval flow.
• DimensionId: integer
  Value that uniquely identifies the dimension.
• DimensionName: string
  Name of the dimension.
• EntityApprovalStatusCode: string
  Maximum Length: 30

  Code for the pricing dimensions' approval status when the approval flow is enabled. This is null if the feature opt-in is set to No.
• MatrixId: integer (int64)
  Value that uniquely identifies the pricing matrix header.

{
    "type":"object",
    "properties":{
        "ChangeTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code that designates the type of change for the dimensions for the approval flow.",
            "nullable":true
        },
        "DimensionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the dimension.",
            "nullable":true
        },
        "DimensionName":{
            "type":"string",
            "description":"Name of the dimension.",
            "nullable":true
        },
        "EntityApprovalStatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code for the pricing dimensions' approval status when the approval flow is enabled. This is null if the feature opt-in is set to No.",
            "nullable":true
        },
        "MatrixId":{
            "type":"integer",
            "description":"Value that uniquely identifies the pricing matrix header.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

Nested Schema : priceLists-items-charges-pricingMatrixes-rules-item-post-request

Type: object

Show Source

• ChangeTypeCode: string
  Maximum Length: 30

  Code that designates the type of change for the matrix rules for the approval flow.
• Dimension1: string
  Name of the first dimension in the matrix.
• Dimension10: string
  Name of the tenth dimension in the matrix.
• Dimension10KeyValue: string
  Value that uniquely identifies the tenth dimension value in the matrix.
• Dimension10Value: string
  Value of the tenth dimension in the matrix.
• Dimension11: string
  Name of the eleventh dimension in the matrix.
• Dimension11KeyValue: string
  Value that uniquely identifies the eleventh dimension value in the matrix.
• Dimension11Value: string
  Value of the eleventh dimension in the matrix.
• Dimension12: string
  Name of the twelfth dimension in the matrix.
• Dimension12KeyValue: string
  Value that uniquely identifies the twelfth dimension value in the matrix.
• Dimension12Value: string
  Value of the twelfth dimension in the matrix.
• Dimension13: string
  Name of the thirteenth dimension in the matrix.
• Dimension13KeyValue: string
  Value that uniquely identifies the thirteenth dimension value in the matrix.
• Dimension13Value: string
  Value of the thirteenth dimension in the matrix.
• Dimension14: string
  Name of the fourteenth dimension in the matrix.
• Dimension14KeyValue: string
  Value that uniquely identifies the fourteenth dimension value in the matrix.
• Dimension14Value: string
  Value of the fourteenth dimension in the matrix.
• Dimension15: string
  Name of the fifteenth dimension in the matrix.
• Dimension15KeyValue: string
  Value that uniquely identifies the fifteenth dimension value in the matrix.
• Dimension15Value: string
  Value of the fifteenth dimension in the matrix.
• Dimension16: string
  Name of the sixteenth dimension in the matrix.
• Dimension16KeyValue: string
  Value that uniquely identifies the sixteenth dimension value in the matrix.
• Dimension16Value: string
  Value of the sixteenth dimension in the matrix.
• Dimension17: string
  Name of the seventeenth dimension in the matrix.
• Dimension17KeyValue: string
  Value that uniquely identifies the seventeenth dimension value in the matrix.
• Dimension17Value: string
  Value of the seventeenth dimension in the matrix.
• Dimension18: string
  Name of the eighteenth dimension in the matrix.
• Dimension18KeyValue: string
  Value that uniquely identifies the eighteenth dimension value in the matrix.
• Dimension18Value: string
  Value of the eighteenth dimension in the matrix.
• Dimension19: string
  Name of the nineteenth dimension in the matrix.
• Dimension19KeyValue: string
  Value that uniquely identifies the nineteenth dimension value in the matrix.
• Dimension19Value: string
  Value of the nineteenth dimension in the matrix.
• Dimension1KeyValue: string
  Value that uniquely identifies the first dimension value in the matrix.
• Dimension1Value: string
  Value of the first dimension in the matrix.
• Dimension2: string
  Name of the second dimension in the matrix.
• Dimension20: string
  Name of the twentieth dimension in the matrix.
• Dimension20KeyValue: string
  Value that uniquely identifies the twentieth dimension value in the matrix.
• Dimension20Value: string
  Value of the twentieth dimension in the matrix.
• Dimension21: string
  Name of the twenty-first dimension in the matrix.
• Dimension21KeyValue: string
  Value that uniquely identifies the twenty-first dimension value in the matrix.
• Dimension21Value: string
  Value of the twenty-first dimension in the matrix.
• Dimension22: string
  Name of the twenty-second dimension in the matrix.
• Dimension22KeyValue: string
  Value that uniquely identifies the twenty-second dimension value in the matrix.
• Dimension22Value: string
  Value of the twenty-second dimension in the matrix.
• Dimension23: string
  Name of the twenty-third dimension in the matrix.
• Dimension23KeyValue: string
  Value that uniquely identifies the twenty-third dimension value in the matrix.
• Dimension23Value: string
  Value of the twenty-third dimension in the matrix.
• Dimension24: string
  Name of the twenty-fourth dimension in the matrix.
• Dimension24KeyValue: string
  Value that uniquely identifies the twenty-fourth dimension value in the matrix.
• Dimension24Value: string
  Value of the twenty-fourth dimension in the matrix.
• Dimension25: string
  Name of the twenty-fifth dimension in the matrix.
• Dimension25KeyValue: string
  Value that uniquely identifies the twenty-fifth dimension value in the matrix.
• Dimension25Value: string
  Value of the twenty-fifth dimension in the matrix.
• Dimension2KeyValue: string
  Value that uniquely identifies the second dimension value in the matrix.
• Dimension2Value: string
  Value of the second dimension in the matrix.
• Dimension3: string
  Name of the third dimension in the matrix.
• Dimension3KeyValue: string
  Value that uniquely identifies the third dimension value in the matrix.
• Dimension3Value: string
  Value of the third dimension in the matrix.
• Dimension4: string
  Name of the fourth dimension in the matrix.
• Dimension4KeyValue: string
  Value that uniquely identifies the fourth dimension value in the matrix.
• Dimension4Value: string
  Value of the fourth dimension in the matrix.
• Dimension5: string
  Name of the fifth dimension in the matrix.
• Dimension5KeyValue: string
  Value that uniquely identifies the fifth dimension value in the matrix.
• Dimension5Value: string
  Value of the fifth dimension in the matrix.
• Dimension6: string
  Name of the sixth dimension in the matrix.
• Dimension6KeyValue: string
  Value that uniquely identifies the sixth dimension value in the matrix.
• Dimension6Value: string
  Value of the sixth dimension in the matrix.
• Dimension7: string
  Name of the seventh dimension in the matrix.
• Dimension7KeyValue: string
  Value that uniquely identifies the seventh dimension value in the matrix.
• Dimension7Value: string
  Value of the seventh dimension in the matrix.
• Dimension8: string
  Name of the eighth dimension in the matrix.
• Dimension8KeyValue: string
  Value that uniquely identifies the eighth dimension value in the matrix.
• Dimension8Value: string
  Value of the eighth dimension in the matrix.
• Dimension9: string
  Name of the ninth dimension in the matrix.
• Dimension9KeyValue: string
  Value that uniquely identifies the ninth dimension value in the matrix.
• Dimension9Value: string
  Value of the ninth dimension in the matrix.
• EntityApprovalStatusCode: string
  Maximum Length: 30

  Code for the pricing matrix rules' approval status when the approval flow is enabled. This is null if the feature opt-in is set to No.
• RuleEndDate: string (date-time)
  Title: End Date

  Date when the matrix rule becomes inactive.
• RuleStartDate: string (date-time)
  Title: Start Date

  Date when the matrix rule becomes active.

{
    "type":"object",
    "properties":{
        "ChangeTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code that designates the type of change for the matrix rules for the approval flow.",
            "nullable":true
        },
        "Dimension1":{
            "type":"string",
            "description":"Name of the first dimension in the matrix.",
            "nullable":true
        },
        "Dimension10":{
            "type":"string",
            "description":"Name of the tenth dimension in the matrix.",
            "nullable":true
        },
        "Dimension10KeyValue":{
            "type":"string",
            "description":"Value that uniquely identifies the tenth dimension value in the matrix.",
            "nullable":true
        },
        "Dimension10Value":{
            "type":"string",
            "description":"Value of the tenth dimension in the matrix.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Dimension10KeyValue"
                ]
            }
        },
        "Dimension11":{
            "type":"string",
            "description":"Name of the eleventh dimension in the matrix.",
            "nullable":true
        },
        "Dimension11KeyValue":{
            "type":"string",
            "description":"Value that uniquely identifies the eleventh dimension value in the matrix.",
            "nullable":true
        },
        "Dimension11Value":{
            "type":"string",
            "description":"Value of the eleventh dimension in the matrix.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Dimension11KeyValue"
                ]
            }
        },
        "Dimension12":{
            "type":"string",
            "description":"Name of the twelfth dimension in the matrix.",
            "nullable":true
        },
        "Dimension12KeyValue":{
            "type":"string",
            "description":"Value that uniquely identifies the twelfth dimension value in the matrix.",
            "nullable":true
        },
        "Dimension12Value":{
            "type":"string",
            "description":"Value of the twelfth dimension in the matrix.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Dimension12KeyValue"
                ]
            }
        },
        "Dimension13":{
            "type":"string",
            "description":"Name of the thirteenth dimension in the matrix.",
            "nullable":true
        },
        "Dimension13KeyValue":{
            "type":"string",
            "description":"Value that uniquely identifies the thirteenth dimension value in the matrix.",
            "nullable":true
        },
        "Dimension13Value":{
            "type":"string",
            "description":"Value of the thirteenth dimension in the matrix.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Dimension13KeyValue"
                ]
            }
        },
        "Dimension14":{
            "type":"string",
            "description":"Name of the fourteenth dimension in the matrix.",
            "nullable":true
        },
        "Dimension14KeyValue":{
            "type":"string",
            "description":"Value that uniquely identifies the fourteenth dimension value in the matrix.",
            "nullable":true
        },
        "Dimension14Value":{
            "type":"string",
            "description":"Value of the fourteenth dimension in the matrix.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Dimension14KeyValue"
                ]
            }
        },
        "Dimension15":{
            "type":"string",
            "description":"Name of the fifteenth dimension in the matrix.",
            "nullable":true
        },
        "Dimension15KeyValue":{
            "type":"string",
            "description":"Value that uniquely identifies the fifteenth dimension value in the matrix.",
            "nullable":true
        },
        "Dimension15Value":{
            "type":"string",
            "description":"Value of the fifteenth dimension in the matrix.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Dimension15KeyValue"
                ]
            }
        },
        "Dimension16":{
            "type":"string",
            "description":"Name of the sixteenth dimension in the matrix.",
            "nullable":true
        },
        "Dimension16KeyValue":{
            "type":"string",
            "description":"Value that uniquely identifies the sixteenth dimension value in the matrix.",
            "nullable":true
        },
        "Dimension16Value":{
            "type":"string",
            "description":"Value of the sixteenth dimension in the matrix.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Dimension16KeyValue"
                ]
            }
        },
        "Dimension17":{
            "type":"string",
            "description":"Name of the seventeenth dimension in the matrix.",
            "nullable":true
        },
        "Dimension17KeyValue":{
            "type":"string",
            "description":"Value that uniquely identifies the seventeenth dimension value in the matrix.",
            "nullable":true
        },
        "Dimension17Value":{
            "type":"string",
            "description":"Value of the seventeenth dimension in the matrix.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Dimension17KeyValue"
                ]
            }
        },
        "Dimension18":{
            "type":"string",
            "description":"Name of the eighteenth dimension in the matrix.",
            "nullable":true
        },
        "Dimension18KeyValue":{
            "type":"string",
            "description":"Value that uniquely identifies the eighteenth dimension value in the matrix.",
            "nullable":true
        },
        "Dimension18Value":{
            "type":"string",
            "description":"Value of the eighteenth dimension in the matrix.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Dimension18KeyValue"
                ]
            }
        },
        "Dimension19":{
            "type":"string",
            "description":"Name of the nineteenth dimension in the matrix.",
            "nullable":true
        },
        "Dimension19KeyValue":{
            "type":"string",
            "description":"Value that uniquely identifies the nineteenth dimension value in the matrix.",
            "nullable":true
        },
        "Dimension19Value":{
            "type":"string",
            "description":"Value of the nineteenth dimension in the matrix.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Dimension19KeyValue"
                ]
            }
        },
        "Dimension1KeyValue":{
            "type":"string",
            "description":"Value that uniquely identifies the first dimension value in the matrix.",
            "nullable":true
        },
        "Dimension1Value":{
            "type":"string",
            "description":"Value of the first dimension in the matrix.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Dimension1KeyValue"
                ]
            }
        },
        "Dimension2":{
            "type":"string",
            "description":"Name of the second dimension in the matrix.",
            "nullable":true
        },
        "Dimension20":{
            "type":"string",
            "description":"Name of the twentieth dimension in the matrix.",
            "nullable":true
        },
        "Dimension20KeyValue":{
            "type":"string",
            "description":"Value that uniquely identifies the twentieth dimension value in the matrix.",
            "nullable":true
        },
        "Dimension20Value":{
            "type":"string",
            "description":"Value of the twentieth dimension in the matrix.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Dimension20KeyValue"
                ]
            }
        },
        "Dimension21":{
            "type":"string",
            "description":"Name of the twenty-first dimension in the matrix.",
            "nullable":true
        },
        "Dimension21KeyValue":{
            "type":"string",
            "description":"Value that uniquely identifies the twenty-first dimension value in the matrix.",
            "nullable":true
        },
        "Dimension21Value":{
            "type":"string",
            "description":"Value of the twenty-first dimension in the matrix.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Dimension21KeyValue"
                ]
            }
        },
        "Dimension22":{
            "type":"string",
            "description":"Name of the twenty-second dimension in the matrix.",
            "nullable":true
        },
        "Dimension22KeyValue":{
            "type":"string",
            "description":"Value that uniquely identifies the twenty-second dimension value in the matrix.",
            "nullable":true
        },
        "Dimension22Value":{
            "type":"string",
            "description":"Value of the twenty-second dimension in the matrix.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Dimension22KeyValue"
                ]
            }
        },
        "Dimension23":{
            "type":"string",
            "description":"Name of the twenty-third dimension in the matrix.",
            "nullable":true
        },
        "Dimension23KeyValue":{
            "type":"string",
            "description":"Value that uniquely identifies the twenty-third dimension value in the matrix.",
            "nullable":true
        },
        "Dimension23Value":{
            "type":"string",
            "description":"Value of the twenty-third dimension in the matrix.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Dimension23KeyValue"
                ]
            }
        },
        "Dimension24":{
            "type":"string",
            "description":"Name of the twenty-fourth dimension in the matrix.",
            "nullable":true
        },
        "Dimension24KeyValue":{
            "type":"string",
            "description":"Value that uniquely identifies the twenty-fourth dimension value in the matrix.",
            "nullable":true
        },
        "Dimension24Value":{
            "type":"string",
            "description":"Value of the twenty-fourth dimension in the matrix.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Dimension24KeyValue"
                ]
            }
        },
        "Dimension25":{
            "type":"string",
            "description":"Name of the twenty-fifth dimension in the matrix.",
            "nullable":true
        },
        "Dimension25KeyValue":{
            "type":"string",
            "description":"Value that uniquely identifies the twenty-fifth dimension value in the matrix.",
            "nullable":true
        },
        "Dimension25Value":{
            "type":"string",
            "description":"Value of the twenty-fifth dimension in the matrix.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Dimension25KeyValue"
                ]
            }
        },
        "Dimension2KeyValue":{
            "type":"string",
            "description":"Value that uniquely identifies the second dimension value in the matrix.",
            "nullable":true
        },
        "Dimension2Value":{
            "type":"string",
            "description":"Value of the second dimension in the matrix.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Dimension2KeyValue"
                ]
            }
        },
        "Dimension3":{
            "type":"string",
            "description":"Name of the third dimension in the matrix.",
            "nullable":true
        },
        "Dimension3KeyValue":{
            "type":"string",
            "description":"Value that uniquely identifies the third dimension value in the matrix.",
            "nullable":true
        },
        "Dimension3Value":{
            "type":"string",
            "description":"Value of the third dimension in the matrix.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Dimension3KeyValue"
                ]
            }
        },
        "Dimension4":{
            "type":"string",
            "description":"Name of the fourth dimension in the matrix.",
            "nullable":true
        },
        "Dimension4KeyValue":{
            "type":"string",
            "description":"Value that uniquely identifies the fourth dimension value in the matrix.",
            "nullable":true
        },
        "Dimension4Value":{
            "type":"string",
            "description":"Value of the fourth dimension in the matrix.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Dimension4KeyValue"
                ]
            }
        },
        "Dimension5":{
            "type":"string",
            "description":"Name of the fifth dimension in the matrix.",
            "nullable":true
        },
        "Dimension5KeyValue":{
            "type":"string",
            "description":"Value that uniquely identifies the fifth dimension value in the matrix.",
            "nullable":true
        },
        "Dimension5Value":{
            "type":"string",
            "description":"Value of the fifth dimension in the matrix.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Dimension5KeyValue"
                ]
            }
        },
        "Dimension6":{
            "type":"string",
            "description":"Name of the sixth dimension in the matrix.",
            "nullable":true
        },
        "Dimension6KeyValue":{
            "type":"string",
            "description":"Value that uniquely identifies the sixth dimension value in the matrix.",
            "nullable":true
        },
        "Dimension6Value":{
            "type":"string",
            "description":"Value of the sixth dimension in the matrix.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Dimension6KeyValue"
                ]
            }
        },
        "Dimension7":{
            "type":"string",
            "description":"Name of the seventh dimension in the matrix.",
            "nullable":true
        },
        "Dimension7KeyValue":{
            "type":"string",
            "description":"Value that uniquely identifies the seventh dimension value in the matrix.",
            "nullable":true
        },
        "Dimension7Value":{
            "type":"string",
            "description":"Value of the seventh dimension in the matrix.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Dimension7KeyValue"
                ]
            }
        },
        "Dimension8":{
            "type":"string",
            "description":"Name of the eighth dimension in the matrix.",
            "nullable":true
        },
        "Dimension8KeyValue":{
            "type":"string",
            "description":"Value that uniquely identifies the eighth dimension value in the matrix.",
            "nullable":true
        },
        "Dimension8Value":{
            "type":"string",
            "description":"Value of the eighth dimension in the matrix.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Dimension8KeyValue"
                ]
            }
        },
        "Dimension9":{
            "type":"string",
            "description":"Name of the ninth dimension in the matrix.",
            "nullable":true
        },
        "Dimension9KeyValue":{
            "type":"string",
            "description":"Value that uniquely identifies the ninth dimension value in the matrix.",
            "nullable":true
        },
        "Dimension9Value":{
            "type":"string",
            "description":"Value of the ninth dimension in the matrix.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Dimension9KeyValue"
                ]
            }
        },
        "EntityApprovalStatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code for the pricing matrix rules' approval status when the approval flow is enabled. This is null if the feature opt-in is set to No.",
            "nullable":true
        },
        "RuleEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"Date when the matrix rule becomes inactive.",
            "format":"date-time",
            "nullable":true
        },
        "RuleStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Date when the matrix rule becomes active.",
            "format":"date-time",
            "nullable":true
        }
    }
}

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 : priceLists-items-charges-pricingMatrixes-item-response

Type: object

Show Source

• ChangeType: string
  Read Only: true

  Maximum Length: 255

  Change type for the pricing matrixes in the approval flow.
• ChangeTypeCode: string
  Maximum Length: 30

  Code that designates the type of change for the pricing matrixes for the approval flow.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the record.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the record was created.
• dimensions: array Matrix Dimensions
  Title: Matrix Dimensions

  A matrix dimension is a condition with which you can drive price adjustments, discounts, and rate tables.
• EntityApprovalStatus: string
  Read Only: true

  Maximum Length: 255

  Approval status of the pricing matrixes when the approval flow is enabled. This status is null if the feature opt-in is set to No.
• EntityApprovalStatusCode: string
  Maximum Length: 30

  Code for the pricing matrices' approval status when the approval flow is enabled. This is null if the feature opt-in is set to No.
• LastUpdateDate: string (date-time)
  Read Only: true

  User who most recently updated the record.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Value that uniquely identifies the matrix.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MatrixId: integer (int64)
  Title: Rule Table Id

  Value that uniquely identifies the pricing matrix.
• MatrixName: string
  Title: Name

  Maximum Length: 64

  Name of the pricing matrix.
• rules: array Matrix Rules
  Title: Matrix Rules

  A matrix rule represents a condition based price adjustment, discount, rate table, and other features.

{
    "type":"object",
    "properties":{
        "ChangeType":{
            "maxLength":255,
            "type":"string",
            "description":"Change type for the pricing matrixes in the approval flow.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChangeTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code that designates the type of change for the pricing matrixes for the approval flow.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EntityApprovalStatus":{
            "maxLength":255,
            "type":"string",
            "description":"Approval status of the pricing matrixes when the approval flow is enabled. This status is null if the feature opt-in is set to No.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EntityApprovalStatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code for the pricing matrices' approval status when the approval flow is enabled. This is null if the feature opt-in is set to No.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"User who most recently updated the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Value that uniquely identifies the matrix.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MatrixId":{
            "title":"Rule Table Id",
            "type":"integer",
            "description":"Value that uniquely identifies the pricing matrix.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MatrixName":{
            "title":"Name",
            "maxLength":64,
            "type":"string",
            "description":"Name of the pricing matrix.",
            "nullable":false,
            "x-queryable":true
        },
        "dimensions":{
            "title":"Matrix Dimensions",
            "type":"array",
            "description":"A matrix dimension is a condition with which you can drive price adjustments, discounts, and rate tables.",
            "items":{
                "$ref":"#/components/schemas/priceLists-items-charges-pricingMatrixes-dimensions-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "rules":{
            "title":"Matrix Rules",
            "type":"array",
            "description":"A matrix rule represents a condition based price adjustment, discount, rate table, and other features.",
            "items":{
                "$ref":"#/components/schemas/priceLists-items-charges-pricingMatrixes-rules-item-response"
            }
        }
    }
}

Nested Schema : Matrix Dimensions

Type: array

Title: Matrix Dimensions

A matrix dimension is a condition with which you can drive price adjustments, discounts, and rate tables.

Show Source

• Array of: object priceLists-items-charges-pricingMatrixes-dimensions-item-response

{
    "title":"Matrix Dimensions",
    "type":"array",
    "description":"A matrix dimension is a condition with which you can drive price adjustments, discounts, and rate tables.",
    "items":{
        "$ref":"#/components/schemas/priceLists-items-charges-pricingMatrixes-dimensions-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 : Matrix Rules

Type: array

Title: Matrix Rules

A matrix rule represents a condition based price adjustment, discount, rate table, and other features.

Show Source

• Array of: object priceLists-items-charges-pricingMatrixes-rules-item-response

{
    "title":"Matrix Rules",
    "type":"array",
    "description":"A matrix rule represents a condition based price adjustment, discount, rate table, and other features.",
    "items":{
        "$ref":"#/components/schemas/priceLists-items-charges-pricingMatrixes-rules-item-response"
    }
}

Nested Schema : priceLists-items-charges-pricingMatrixes-dimensions-item-response

Type: object

Show Source

• ChangeType: string
  Read Only: true

  Maximum Length: 255

  Change type for the dimensions in the approval flow.
• ChangeTypeCode: string
  Maximum Length: 30

  Code that designates the type of change for the dimensions for the approval flow.
• CompareToAttribute: string
  Title: Compare to Attribute

  Read Only: true

  Maximum Length: 80

  Compare to attribute for a dimension.
• ComparisonOperatorCode: string
  Title: Comparison

  Read Only: true

  Maximum Length: 30

  Default Value: E

  Comparison operator for a dimension.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the record.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the record was created.
• DataType: string
  Title: Data Type

  Read Only: true

  Maximum Length: 30

  Default Value: STRING

  Data type for a dimension.
• DefaultIsFixedValue: string
  Title: Default Is Fixed Value

  Read Only: true

  Maximum Length: 1

  Default Value: N

  Default to a fixed value for a dimension.
• DefaultValueDate: string (date)
  Title: Default Value

  Read Only: true

  Default date for a dimension.
• DefaultValueNumber: number
  Title: Default Value

  Read Only: true

  Default number for a dimension.
• DefaultValueString: string
  Title: Default Value

  Read Only: true

  Maximum Length: 100

  Default string for a dimension.
• DefaultValueTimestamp: string (date-time)
  Title: Default Value

  Read Only: true

  Default time stamp for a dimension.
• DimensionId: integer
  Value that uniquely identifies the dimension.
• DimensionName: string
  Name of the dimension.
• DimensionType: string
  Title: ColumnType

  Read Only: true

  Maximum Length: 50

  Type for the dimension.
• DisplaySequence: integer (int32)
  Title: Display Sequence

  Read Only: true

  Display sequence for a dimension.
• DomainType: string
  Title: Domain Type

  Read Only: true

  Maximum Length: 30

  Default Value: NONE

  Domain type for a dimension.
• EntityApprovalStatus: string
  Read Only: true

  Maximum Length: 255

  Approval status of the dimensions when the approval flow is enabled. This status is null if the feature opt-in is set to No.
• EntityApprovalStatusCode: string
  Maximum Length: 30

  Code for the pricing dimensions' approval status when the approval flow is enabled. This is null if the feature opt-in is set to No.
• IsNullable: string
  Title: Allow Null

  Read Only: true

  Maximum Length: 1

  Default Value: N

  Indicates whether the dimension can be a null value.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the record was most recently updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MatrixDimensionId: integer (int64)
  Read Only: true

  Value that uniquely identifies the dimension for a pricing matrix.
• MatrixId: integer (int64)
  Value that uniquely identifies the pricing matrix header.
• NullasWildCard: string
  Title: Null Is Wildcard

  Read Only: true

  Maximum Length: 1

  Default Value: N

  Contains one of the following values: Y or N. If Y, then the dimension can be null for search. If N, then the dimension can't be null for search. The default value is Y.
• RequiredDimensionForClass: string
  Title: Required

  Read Only: true

  Maximum Length: 240

  Default Value: N

  Contains one of the following values: Y or N. If Y, then the dimension is required. If N, then the dimension isn't required. The default value is N.
• ShowDefaultValueDimensionInRules: string
  Title: Fixed Column Is Displayed

  Read Only: true

  Maximum Length: 1

  Default Value: N

  Indicates whether the dimension with a fixed default value needs to be displayed in the matrix rules user interface. The default value is N.
• SourceCodeName: string
  Title: Source Code Name

  Read Only: true

  Maximum Length: 100

  Name of the source code for the matrix dimension.

{
    "type":"object",
    "properties":{
        "ChangeType":{
            "maxLength":255,
            "type":"string",
            "description":"Change type for the dimensions in the approval flow.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChangeTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code that designates the type of change for the dimensions for the approval flow.",
            "nullable":true,
            "x-queryable":true
        },
        "CompareToAttribute":{
            "title":"Compare to Attribute",
            "maxLength":80,
            "type":"string",
            "description":"Compare to attribute for a dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ComparisonOperatorCode":{
            "title":"Comparison",
            "maxLength":30,
            "type":"string",
            "description":"Comparison operator for a dimension.",
            "nullable":true,
            "readOnly":true,
            "default":"E",
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DataType":{
            "title":"Data Type",
            "maxLength":30,
            "type":"string",
            "description":"Data type for a dimension.",
            "nullable":false,
            "readOnly":true,
            "default":"STRING",
            "x-queryable":true
        },
        "DefaultIsFixedValue":{
            "title":"Default Is Fixed Value",
            "maxLength":1,
            "type":"string",
            "description":"Default to a fixed value for a dimension.",
            "nullable":false,
            "readOnly":true,
            "default":"N",
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "DefaultValueDate":{
            "title":"Default Value",
            "type":"string",
            "description":"Default date for a dimension.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DefaultValueNumber":{
            "title":"Default Value",
            "type":"number",
            "description":"Default number for a dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DefaultValueString":{
            "title":"Default Value",
            "maxLength":100,
            "type":"string",
            "description":"Default string for a dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DefaultValueTimestamp":{
            "title":"Default Value",
            "type":"string",
            "description":"Default time stamp for a dimension.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DimensionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the dimension.",
            "nullable":true,
            "x-queryable":true
        },
        "DimensionName":{
            "type":"string",
            "description":"Name of the dimension.",
            "nullable":true,
            "x-queryable":true
        },
        "DimensionType":{
            "title":"ColumnType",
            "maxLength":50,
            "type":"string",
            "description":"Type for the dimension.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"Display sequence for a dimension.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "DomainType":{
            "title":"Domain Type",
            "maxLength":30,
            "type":"string",
            "description":"Domain type for a dimension.",
            "nullable":false,
            "readOnly":true,
            "default":"NONE",
            "x-queryable":true
        },
        "EntityApprovalStatus":{
            "maxLength":255,
            "type":"string",
            "description":"Approval status of the dimensions when the approval flow is enabled. This status is null if the feature opt-in is set to No.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EntityApprovalStatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code for the pricing dimensions' approval status when the approval flow is enabled. This is null if the feature opt-in is set to No.",
            "nullable":true,
            "x-queryable":true
        },
        "IsNullable":{
            "title":"Allow Null",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the dimension can be a null value.",
            "nullable":false,
            "readOnly":true,
            "default":"N",
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the record was most recently updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MatrixDimensionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the dimension for a pricing matrix.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MatrixId":{
            "type":"integer",
            "description":"Value that uniquely identifies the pricing matrix header.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "NullasWildCard":{
            "title":"Null Is Wildcard",
            "maxLength":1,
            "type":"string",
            "description":"Contains one of the following values: Y or N. If Y, then the dimension can be null for search. If N, then the dimension can't be null for search. The default value is Y.",
            "nullable":false,
            "readOnly":true,
            "default":"N",
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "RequiredDimensionForClass":{
            "title":"Required",
            "maxLength":240,
            "type":"string",
            "description":"Contains one of the following values: Y or N. If Y, then the dimension is required. If N, then the dimension isn't required. The default value is N.",
            "nullable":true,
            "readOnly":true,
            "default":"N",
            "x-queryable":true
        },
        "ShowDefaultValueDimensionInRules":{
            "title":"Fixed Column Is Displayed",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the dimension with a fixed default value needs to be displayed in the matrix rules user interface. The default value is N.",
            "nullable":false,
            "readOnly":true,
            "default":"N",
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "SourceCodeName":{
            "title":"Source Code Name",
            "maxLength":100,
            "type":"string",
            "description":"Name of the source code for the matrix dimension.",
            "nullable":true,
            "readOnly":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."
        }
    }
}

Nested Schema : priceLists-items-charges-pricingMatrixes-rules-item-response

Type: object

Show Source

• ChangeType: string
  Read Only: true

  Maximum Length: 255

  Change type for the matrix rules in the approval flow.
• ChangeTypeCode: string
  Maximum Length: 30

  Code that designates the type of change for the matrix rules for the approval flow.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the record.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the record was created.
• Dimension1: string
  Name of the first dimension in the matrix.
• Dimension10: string
  Name of the tenth dimension in the matrix.
• Dimension10KeyValue: string
  Value that uniquely identifies the tenth dimension value in the matrix.
• Dimension10Value: string
  Value of the tenth dimension in the matrix.
• Dimension11: string
  Name of the eleventh dimension in the matrix.
• Dimension11KeyValue: string
  Value that uniquely identifies the eleventh dimension value in the matrix.
• Dimension11Value: string
  Value of the eleventh dimension in the matrix.
• Dimension12: string
  Name of the twelfth dimension in the matrix.
• Dimension12KeyValue: string
  Value that uniquely identifies the twelfth dimension value in the matrix.
• Dimension12Value: string
  Value of the twelfth dimension in the matrix.
• Dimension13: string
  Name of the thirteenth dimension in the matrix.
• Dimension13KeyValue: string
  Value that uniquely identifies the thirteenth dimension value in the matrix.
• Dimension13Value: string
  Value of the thirteenth dimension in the matrix.
• Dimension14: string
  Name of the fourteenth dimension in the matrix.
• Dimension14KeyValue: string
  Value that uniquely identifies the fourteenth dimension value in the matrix.
• Dimension14Value: string
  Value of the fourteenth dimension in the matrix.
• Dimension15: string
  Name of the fifteenth dimension in the matrix.
• Dimension15KeyValue: string
  Value that uniquely identifies the fifteenth dimension value in the matrix.
• Dimension15Value: string
  Value of the fifteenth dimension in the matrix.
• Dimension16: string
  Name of the sixteenth dimension in the matrix.
• Dimension16KeyValue: string
  Value that uniquely identifies the sixteenth dimension value in the matrix.
• Dimension16Value: string
  Value of the sixteenth dimension in the matrix.
• Dimension17: string
  Name of the seventeenth dimension in the matrix.
• Dimension17KeyValue: string
  Value that uniquely identifies the seventeenth dimension value in the matrix.
• Dimension17Value: string
  Value of the seventeenth dimension in the matrix.
• Dimension18: string
  Name of the eighteenth dimension in the matrix.
• Dimension18KeyValue: string
  Value that uniquely identifies the eighteenth dimension value in the matrix.
• Dimension18Value: string
  Value of the eighteenth dimension in the matrix.
• Dimension19: string
  Name of the nineteenth dimension in the matrix.
• Dimension19KeyValue: string
  Value that uniquely identifies the nineteenth dimension value in the matrix.
• Dimension19Value: string
  Value of the nineteenth dimension in the matrix.
• Dimension1KeyValue: string
  Value that uniquely identifies the first dimension value in the matrix.
• Dimension1Value: string
  Value of the first dimension in the matrix.
• Dimension2: string
  Name of the second dimension in the matrix.
• Dimension20: string
  Name of the twentieth dimension in the matrix.
• Dimension20KeyValue: string
  Value that uniquely identifies the twentieth dimension value in the matrix.
• Dimension20Value: string
  Value of the twentieth dimension in the matrix.
• Dimension21: string
  Name of the twenty-first dimension in the matrix.
• Dimension21KeyValue: string
  Value that uniquely identifies the twenty-first dimension value in the matrix.
• Dimension21Value: string
  Value of the twenty-first dimension in the matrix.
• Dimension22: string
  Name of the twenty-second dimension in the matrix.
• Dimension22KeyValue: string
  Value that uniquely identifies the twenty-second dimension value in the matrix.
• Dimension22Value: string
  Value of the twenty-second dimension in the matrix.
• Dimension23: string
  Name of the twenty-third dimension in the matrix.
• Dimension23KeyValue: string
  Value that uniquely identifies the twenty-third dimension value in the matrix.
• Dimension23Value: string
  Value of the twenty-third dimension in the matrix.
• Dimension24: string
  Name of the twenty-fourth dimension in the matrix.
• Dimension24KeyValue: string
  Value that uniquely identifies the twenty-fourth dimension value in the matrix.
• Dimension24Value: string
  Value of the twenty-fourth dimension in the matrix.
• Dimension25: string
  Name of the twenty-fifth dimension in the matrix.
• Dimension25KeyValue: string
  Value that uniquely identifies the twenty-fifth dimension value in the matrix.
• Dimension25Value: string
  Value of the twenty-fifth dimension in the matrix.
• Dimension2KeyValue: string
  Value that uniquely identifies the second dimension value in the matrix.
• Dimension2Value: string
  Value of the second dimension in the matrix.
• Dimension3: string
  Name of the third dimension in the matrix.
• Dimension3KeyValue: string
  Value that uniquely identifies the third dimension value in the matrix.
• Dimension3Value: string
  Value of the third dimension in the matrix.
• Dimension4: string
  Name of the fourth dimension in the matrix.
• Dimension4KeyValue: string
  Value that uniquely identifies the fourth dimension value in the matrix.
• Dimension4Value: string
  Value of the fourth dimension in the matrix.
• Dimension5: string
  Name of the fifth dimension in the matrix.
• Dimension5KeyValue: string
  Value that uniquely identifies the fifth dimension value in the matrix.
• Dimension5Value: string
  Value of the fifth dimension in the matrix.
• Dimension6: string
  Name of the sixth dimension in the matrix.
• Dimension6KeyValue: string
  Value that uniquely identifies the sixth dimension value in the matrix.
• Dimension6Value: string
  Value of the sixth dimension in the matrix.
• Dimension7: string
  Name of the seventh dimension in the matrix.
• Dimension7KeyValue: string
  Value that uniquely identifies the seventh dimension value in the matrix.
• Dimension7Value: string
  Value of the seventh dimension in the matrix.
• Dimension8: string
  Name of the eighth dimension in the matrix.
• Dimension8KeyValue: string
  Value that uniquely identifies the eighth dimension value in the matrix.
• Dimension8Value: string
  Value of the eighth dimension in the matrix.
• Dimension9: string
  Name of the ninth dimension in the matrix.
• Dimension9KeyValue: string
  Value that uniquely identifies the ninth dimension value in the matrix.
• Dimension9Value: string
  Value of the ninth dimension in the matrix.
• EntityApprovalStatus: string
  Read Only: true

  Maximum Length: 255

  Approval status of the matrix rules when the approval flow is enabled. This status is null if the feature opt-in is set to No.
• EntityApprovalStatusCode: string
  Maximum Length: 30

  Code for the pricing matrix rules' approval status when the approval flow is enabled. This is null if the feature opt-in is set to No.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the record was most recently updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MatrixId: integer (int64)
  Read Only: true

  Value that uniquely identifies the matrix header.
• MatrixRuleId: integer (int64)
  Read Only: true

  Value that uniquely identifies the matrix rule.
• RuleEndDate: string (date-time)
  Title: End Date

  Date when the matrix rule becomes inactive.
• RuleStartDate: string (date-time)
  Title: Start Date

  Date when the matrix rule becomes active.

{
    "type":"object",
    "properties":{
        "ChangeType":{
            "maxLength":255,
            "type":"string",
            "description":"Change type for the matrix rules in the approval flow.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChangeTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code that designates the type of change for the matrix rules for the approval flow.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Dimension1":{
            "type":"string",
            "description":"Name of the first dimension in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension10":{
            "type":"string",
            "description":"Name of the tenth dimension in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension10KeyValue":{
            "type":"string",
            "description":"Value that uniquely identifies the tenth dimension value in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension10Value":{
            "type":"string",
            "description":"Value of the tenth dimension in the matrix.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Dimension10KeyValue"
                ]
            },
            "x-queryable":true
        },
        "Dimension11":{
            "type":"string",
            "description":"Name of the eleventh dimension in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension11KeyValue":{
            "type":"string",
            "description":"Value that uniquely identifies the eleventh dimension value in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension11Value":{
            "type":"string",
            "description":"Value of the eleventh dimension in the matrix.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Dimension11KeyValue"
                ]
            },
            "x-queryable":true
        },
        "Dimension12":{
            "type":"string",
            "description":"Name of the twelfth dimension in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension12KeyValue":{
            "type":"string",
            "description":"Value that uniquely identifies the twelfth dimension value in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension12Value":{
            "type":"string",
            "description":"Value of the twelfth dimension in the matrix.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Dimension12KeyValue"
                ]
            },
            "x-queryable":true
        },
        "Dimension13":{
            "type":"string",
            "description":"Name of the thirteenth dimension in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension13KeyValue":{
            "type":"string",
            "description":"Value that uniquely identifies the thirteenth dimension value in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension13Value":{
            "type":"string",
            "description":"Value of the thirteenth dimension in the matrix.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Dimension13KeyValue"
                ]
            },
            "x-queryable":true
        },
        "Dimension14":{
            "type":"string",
            "description":"Name of the fourteenth dimension in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension14KeyValue":{
            "type":"string",
            "description":"Value that uniquely identifies the fourteenth dimension value in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension14Value":{
            "type":"string",
            "description":"Value of the fourteenth dimension in the matrix.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Dimension14KeyValue"
                ]
            },
            "x-queryable":true
        },
        "Dimension15":{
            "type":"string",
            "description":"Name of the fifteenth dimension in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension15KeyValue":{
            "type":"string",
            "description":"Value that uniquely identifies the fifteenth dimension value in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension15Value":{
            "type":"string",
            "description":"Value of the fifteenth dimension in the matrix.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Dimension15KeyValue"
                ]
            },
            "x-queryable":true
        },
        "Dimension16":{
            "type":"string",
            "description":"Name of the sixteenth dimension in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension16KeyValue":{
            "type":"string",
            "description":"Value that uniquely identifies the sixteenth dimension value in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension16Value":{
            "type":"string",
            "description":"Value of the sixteenth dimension in the matrix.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Dimension16KeyValue"
                ]
            },
            "x-queryable":true
        },
        "Dimension17":{
            "type":"string",
            "description":"Name of the seventeenth dimension in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension17KeyValue":{
            "type":"string",
            "description":"Value that uniquely identifies the seventeenth dimension value in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension17Value":{
            "type":"string",
            "description":"Value of the seventeenth dimension in the matrix.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Dimension17KeyValue"
                ]
            },
            "x-queryable":true
        },
        "Dimension18":{
            "type":"string",
            "description":"Name of the eighteenth dimension in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension18KeyValue":{
            "type":"string",
            "description":"Value that uniquely identifies the eighteenth dimension value in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension18Value":{
            "type":"string",
            "description":"Value of the eighteenth dimension in the matrix.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Dimension18KeyValue"
                ]
            },
            "x-queryable":true
        },
        "Dimension19":{
            "type":"string",
            "description":"Name of the nineteenth dimension in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension19KeyValue":{
            "type":"string",
            "description":"Value that uniquely identifies the nineteenth dimension value in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension19Value":{
            "type":"string",
            "description":"Value of the nineteenth dimension in the matrix.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Dimension19KeyValue"
                ]
            },
            "x-queryable":true
        },
        "Dimension1KeyValue":{
            "type":"string",
            "description":"Value that uniquely identifies the first dimension value in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension1Value":{
            "type":"string",
            "description":"Value of the first dimension in the matrix.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Dimension1KeyValue"
                ]
            },
            "x-queryable":true
        },
        "Dimension2":{
            "type":"string",
            "description":"Name of the second dimension in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension20":{
            "type":"string",
            "description":"Name of the twentieth dimension in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension20KeyValue":{
            "type":"string",
            "description":"Value that uniquely identifies the twentieth dimension value in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension20Value":{
            "type":"string",
            "description":"Value of the twentieth dimension in the matrix.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Dimension20KeyValue"
                ]
            },
            "x-queryable":true
        },
        "Dimension21":{
            "type":"string",
            "description":"Name of the twenty-first dimension in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension21KeyValue":{
            "type":"string",
            "description":"Value that uniquely identifies the twenty-first dimension value in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension21Value":{
            "type":"string",
            "description":"Value of the twenty-first dimension in the matrix.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Dimension21KeyValue"
                ]
            },
            "x-queryable":true
        },
        "Dimension22":{
            "type":"string",
            "description":"Name of the twenty-second dimension in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension22KeyValue":{
            "type":"string",
            "description":"Value that uniquely identifies the twenty-second dimension value in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension22Value":{
            "type":"string",
            "description":"Value of the twenty-second dimension in the matrix.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Dimension22KeyValue"
                ]
            },
            "x-queryable":true
        },
        "Dimension23":{
            "type":"string",
            "description":"Name of the twenty-third dimension in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension23KeyValue":{
            "type":"string",
            "description":"Value that uniquely identifies the twenty-third dimension value in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension23Value":{
            "type":"string",
            "description":"Value of the twenty-third dimension in the matrix.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Dimension23KeyValue"
                ]
            },
            "x-queryable":true
        },
        "Dimension24":{
            "type":"string",
            "description":"Name of the twenty-fourth dimension in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension24KeyValue":{
            "type":"string",
            "description":"Value that uniquely identifies the twenty-fourth dimension value in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension24Value":{
            "type":"string",
            "description":"Value of the twenty-fourth dimension in the matrix.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Dimension24KeyValue"
                ]
            },
            "x-queryable":true
        },
        "Dimension25":{
            "type":"string",
            "description":"Name of the twenty-fifth dimension in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension25KeyValue":{
            "type":"string",
            "description":"Value that uniquely identifies the twenty-fifth dimension value in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension25Value":{
            "type":"string",
            "description":"Value of the twenty-fifth dimension in the matrix.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Dimension25KeyValue"
                ]
            },
            "x-queryable":true
        },
        "Dimension2KeyValue":{
            "type":"string",
            "description":"Value that uniquely identifies the second dimension value in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension2Value":{
            "type":"string",
            "description":"Value of the second dimension in the matrix.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Dimension2KeyValue"
                ]
            },
            "x-queryable":true
        },
        "Dimension3":{
            "type":"string",
            "description":"Name of the third dimension in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension3KeyValue":{
            "type":"string",
            "description":"Value that uniquely identifies the third dimension value in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension3Value":{
            "type":"string",
            "description":"Value of the third dimension in the matrix.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Dimension3KeyValue"
                ]
            },
            "x-queryable":true
        },
        "Dimension4":{
            "type":"string",
            "description":"Name of the fourth dimension in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension4KeyValue":{
            "type":"string",
            "description":"Value that uniquely identifies the fourth dimension value in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension4Value":{
            "type":"string",
            "description":"Value of the fourth dimension in the matrix.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Dimension4KeyValue"
                ]
            },
            "x-queryable":true
        },
        "Dimension5":{
            "type":"string",
            "description":"Name of the fifth dimension in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension5KeyValue":{
            "type":"string",
            "description":"Value that uniquely identifies the fifth dimension value in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension5Value":{
            "type":"string",
            "description":"Value of the fifth dimension in the matrix.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Dimension5KeyValue"
                ]
            },
            "x-queryable":true
        },
        "Dimension6":{
            "type":"string",
            "description":"Name of the sixth dimension in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension6KeyValue":{
            "type":"string",
            "description":"Value that uniquely identifies the sixth dimension value in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension6Value":{
            "type":"string",
            "description":"Value of the sixth dimension in the matrix.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Dimension6KeyValue"
                ]
            },
            "x-queryable":true
        },
        "Dimension7":{
            "type":"string",
            "description":"Name of the seventh dimension in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension7KeyValue":{
            "type":"string",
            "description":"Value that uniquely identifies the seventh dimension value in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension7Value":{
            "type":"string",
            "description":"Value of the seventh dimension in the matrix.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Dimension7KeyValue"
                ]
            },
            "x-queryable":true
        },
        "Dimension8":{
            "type":"string",
            "description":"Name of the eighth dimension in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension8KeyValue":{
            "type":"string",
            "description":"Value that uniquely identifies the eighth dimension value in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension8Value":{
            "type":"string",
            "description":"Value of the eighth dimension in the matrix.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Dimension8KeyValue"
                ]
            },
            "x-queryable":true
        },
        "Dimension9":{
            "type":"string",
            "description":"Name of the ninth dimension in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension9KeyValue":{
            "type":"string",
            "description":"Value that uniquely identifies the ninth dimension value in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension9Value":{
            "type":"string",
            "description":"Value of the ninth dimension in the matrix.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Dimension9KeyValue"
                ]
            },
            "x-queryable":true
        },
        "EntityApprovalStatus":{
            "maxLength":255,
            "type":"string",
            "description":"Approval status of the matrix rules when the approval flow is enabled. This status is null if the feature opt-in is set to No.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EntityApprovalStatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code for the pricing matrix rules' approval status when the approval flow is enabled. This is null if the feature opt-in is set to No.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the record was most recently updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MatrixId":{
            "type":"integer",
            "description":"Value that uniquely identifies the matrix header.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MatrixRuleId":{
            "type":"integer",
            "description":"Value that uniquely identifies the matrix rule.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RuleEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"Date when the matrix rule becomes inactive.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "RuleStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Date when the matrix rule becomes active.",
            "format":"date-time",
            "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"
    }
}

Links

dimensions

Operation: /fscmRestApi/resources/11.13.18.05/priceLists/{PriceListId}/child/items/{PriceListItemId}/child/charges/{PriceListChargeId}/child/pricingMatrixes/{MatrixId}/child/dimensions

Parameters:

• MatrixId: $request.path.MatrixId
• PriceListChargeId: $request.path.PriceListChargeId
• PriceListId: $request.path.PriceListId
• PriceListItemId: $request.path.PriceListItemId

rules

Operation: /fscmRestApi/resources/11.13.18.05/priceLists/{PriceListId}/child/items/{PriceListItemId}/child/charges/{PriceListChargeId}/child/pricingMatrixes/{MatrixId}/child/rules

Parameters:

• MatrixId: $request.path.MatrixId
• PriceListChargeId: $request.path.PriceListChargeId
• PriceListId: $request.path.PriceListId
• PriceListItemId: $request.path.PriceListItemId

Back to Top