Jump to

• Request
• Response
• Examples

Get Price Agreement Pricing Matrix Grid Data

get

/rest/v19/pricingSetup/agreements/{agreementVariableName}/matrixGrid

Use this endpoint to retrive all pricing matrix grid data. The matrix data input and output fields will be prefixed by the "_matrix_" string in the response to distinguish from other charge or reference fields with the same name.

Request

Path Parameters

• agreementVariableName(required): string

Query Parameters

• chargeq: string
  Filter charges (a "where"clause) to restrict the items returned in the collection. The chargeq filtering is applied jointly ("AND") with the q parameter search. You can filter by searchable price model item columns and charge columns, for example, partNumber, bomItemVariableName, chargeType, priceType, and searchable custom charge attributes. You can't search by join fields like description, slaesProductType, ratePlanName or currency custom charge attributes. By default, no filtering is applied.
• distinct: boolean
  The items returned in the resource collection will have distinct field values when "?distinct=true".
• fields: string
  This parameter filters the resource attributes. Only the specified attributes are returned, which means that if no attributes are specified, all attributes are returned.
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>
  The following are the available finder names and corresponding finder variables:

  • findByGridKeyword: Find matrix grid rows using pricing matrix fields, part number, BOM item name or variable name, Root BOM item name or variable name.
    Finder Variable:
    • keyword;string:The search text. The character '%' if present will be treated as a wild card otherwise, the default is 'contains' search
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderby: string
  This parameter orders a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "ASC" or "DESC". Specify "ASC" for ascending and "DESC" for descending. The default value is "ASC". For example, ?orderby=field1:ASC,field2:DESC.
• q: string
  Filter matrix data (a "where"clause) to restrict the items returned in the collection. You can search by matrix data columns, for example, dateAdded, dateModified, and searchable matrix template columns. You can't search by createdBy, modifiedBy or currency matrix columns. Prefix "matrix" to the matrix template column variable name. For example, use "_matrix_region" for the matrix template column "region". By default, no filtering is applied.
• totalResults: boolean
  The resource collection representation will include the total row count when "?totalResults=true", otherwise the count is not included. The default value is "false".

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : PricingResourceCollection_PricingMatrixGrid

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.
• groupAccessEnabled: boolean()
  Title: Group Access Enabled

  Read Only: true

  Indicates whether the user has access to the groups segment
• 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.
• segmentLevelAccessType: string()
  Title: Segment-level Access Type

  Read Only: true

  Segment-level Access Type
• 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":{
        "segmentLevelAccessType":{
            "type":"string",
            "format":"",
            "description":"Segment-level Access Type",
            "title":"Segment-level Access Type",
            "readOnly":true
        },
        "groupAccessEnabled":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether the user has access to the groups segment",
            "title":"Group Access Enabled",
            "readOnly":true
        },
        "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/PricingMatrixGrid"
            }
        },
        "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

The details of the user who created the record.

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 PricingMatrixGrid

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

Nested Schema : Last Modified By

Title: Last Modified By

Read Only: true

The details of the user who modified the record.

Match All

The details of the user who modified the record.

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 : PricingMatrixGrid

Type: object

Show Source

• _proxy_id: integer()
  Title: Proxy ID

  Read Only: true

  The proxy identifier for the resource that was added.
• bomItemName: string()
  Title: BOM Item Name

  The BOM item's display name. When clients sets field bomItemVariableName, this field should also be explicitly set in the request.
• bomItemVariableName: string()
  Title: BOM Item Variable Name

  The BOM Item's variable name.
• chargeDateAdded: string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
  Title: Charge Date Added

  The date from which the Charge is created.
• chargeDateModified: string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
  Title: Charge Date Modified

  The date from which the Charge is modified.
• chargeDefinition: string()
  Title: Charge Definition

  Read Only: true

  Display Name of the Charge Definition.
• chargeDefinitionCode: string()
  Title: Charge Definition Code

  The unique code of the Charge Definition.
• chargeDefinitionId: integer()
  Title: Charge Definition ID

  ID of the Charge Definition.
• chargeEndDate: string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
  Title: Charge End Date

  The date at which the Charge will end.
• chargeId: integer()
  Title: Charge ID

  ID of the Charge.
• chargeStartDate: string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
  Title: Charge Start Date

  The date from which the Charge will be applicable.
• chargeType: string()
  Title: Charge Type

  The category of charge.
• 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 data.
• dateModified: string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
  Title: Date Modified

  Read Only: true

  Last Modified date of the Pricing Matrix data.
• description: string()
  Title: Description

  The description of the Price Model Data
• dynamicPricingType: string()
  Title: Dynamic Pricing Type

  Allowed Values: [ "static", "advanced", "volume", "tiered", "rateCard", "attributeBasedCharge" ]

  The dynamic pricing type of the charge.
• groupAccessEnabled: boolean()
  Title: Group Access Enabled

  Read Only: true

  Indicates whether the user has access to the groups segment
• id: integer()
  Title: Id

  Read Only: true

  The Unique Identifier of the Pricing Matrix data.
• 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.
• partNumber: string()
  Title: Part Number

  The part Number of the Price Model Data.This should match the Part Lookup's lookupCode.
• priceModelItemId: integer()
  Title: Price Model Item ID

  ID of the Price Model item.
• pricePeriod: string()
  Title: Price Period

  The billing period.
• priceType: string()
  Title: Price Type

  The type of charge.
• primaryCharge: boolean()
  Title: Primary Charge

  Indicates whether this is the primary charge.
• ratePlanDescription: string()
  Title: Rate Plan Description

  Rate Plan description.
• ratePlanEndDate: string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
  Title: Rate Plan End Date

  The date at which the Rate Plan will end.
• ratePlanName: string()
  Title: Rate Plan Name

  Rate Plan name.
• ratePlanNumber: string()
  Title: Rate Plan Number

  Rate Plan Number.
• ratePlanStartDate: string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
  Title: Rate Plan Start Date

  The date from which the Rate Plan will be applicable.
• rootBomItemName: string()
  Title: Root BOM Item Name

  The root BOM item's display name.
• rootBomItemVariableName: string()
  Title: Root BOM Item Variable Name

  The root BOM item's variable name.
• salesProductType: string()
  Title: Sales Product Type

  Sales Product type.
• segmentLevelAccessType: string()
  Title: Segment-level Access Type

  Read Only: true

  Segment-level Access Type
• serviceDuration: integer()
  Title: Service Duration

  Service duration.
• serviceDurationPeriod: string()
  Title: Service Duration Period

  Service duration period code.
• serviceDurationType: string()
  Title: Service Duration Type

  Service duration type.
• usageUOM: string()
  Title: Usage UOM

  The unit of measure for the charge.

{
    "properties":{
        "segmentLevelAccessType":{
            "type":"string",
            "format":"",
            "description":"Segment-level Access Type",
            "title":"Segment-level Access Type",
            "readOnly":true
        },
        "groupAccessEnabled":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether the user has access to the groups segment",
            "title":"Group Access Enabled",
            "readOnly":true
        },
        "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 Pricing Matrix data.",
            "title":"Id",
            "readOnly":true
        },
        "dateAdded":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Creation Date of the Pricing Matrix data.",
            "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 data.",
            "title":"Date Modified",
            "readOnly":true
        },
        "chargeDefinition":{
            "type":"string",
            "format":"",
            "description":"Display Name of the Charge Definition.",
            "title":"Charge Definition",
            "readOnly":true
        },
        "chargeDefinitionCode":{
            "type":"string",
            "format":"",
            "description":"The unique code of the Charge Definition.",
            "title":"Charge Definition Code"
        },
        "chargeDefinitionId":{
            "type":"integer",
            "format":"",
            "description":"ID of the Charge Definition.",
            "title":"Charge Definition ID"
        },
        "links":{
            "type":"array",
            "format":"",
            "description":"The link relations associated with the resource instance.",
            "title":"Links",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "_proxy_id":{
            "type":"integer",
            "format":"",
            "description":"The proxy identifier for the resource that was added.",
            "title":"Proxy ID",
            "readOnly":true
        },
        "priceModelItemId":{
            "type":"integer",
            "format":"",
            "description":"ID of the Price Model item.",
            "title":"Price Model Item ID"
        },
        "partNumber":{
            "type":"string",
            "format":"",
            "description":"The part Number of the Price Model Data.This should match the Part Lookup's lookupCode.",
            "title":"Part Number"
        },
        "description":{
            "type":"string",
            "format":"",
            "description":"The description of the Price Model Data",
            "title":"Description"
        },
        "bomItemVariableName":{
            "type":"string",
            "format":"",
            "description":"The BOM Item's variable name.",
            "title":"BOM Item Variable Name"
        },
        "rootBomItemVariableName":{
            "type":"string",
            "format":"",
            "description":"The root BOM item's variable name.",
            "title":"Root BOM Item Variable Name"
        },
        "bomItemName":{
            "type":"string",
            "format":"",
            "description":"The BOM item's display name. When clients sets field bomItemVariableName, this field should also be explicitly set in the request.",
            "title":"BOM Item Name"
        },
        "rootBomItemName":{
            "type":"string",
            "format":"",
            "description":"The root BOM item's display name.",
            "title":"Root BOM Item Name"
        },
        "chargeId":{
            "type":"integer",
            "format":"",
            "description":"ID of the Charge.",
            "title":"Charge ID"
        },
        "chargeType":{
            "type":"string",
            "format":"",
            "description":"The category of charge.",
            "title":"Charge Type"
        },
        "priceType":{
            "type":"string",
            "format":"",
            "description":"The type of charge.",
            "title":"Price Type"
        },
        "pricePeriod":{
            "type":"string",
            "format":"",
            "description":"The billing period.",
            "title":"Price Period"
        },
        "usageUOM":{
            "type":"string",
            "format":"",
            "description":"The unit of measure for the charge.",
            "title":"Usage UOM"
        },
        "primaryCharge":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether this is the primary charge.",
            "title":"Primary Charge"
        },
        "dynamicPricingType":{
            "type":"string",
            "format":"",
            "description":"The dynamic pricing type of the charge.",
            "title":"Dynamic Pricing Type",
            "enum":[
                "static",
                "advanced",
                "volume",
                "tiered",
                "rateCard",
                "attributeBasedCharge"
            ]
        },
        "chargeStartDate":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"The date from which the Charge will be applicable.",
            "title":"Charge Start Date"
        },
        "chargeEndDate":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"The date at which the Charge will end.",
            "title":"Charge End Date"
        },
        "ratePlanNumber":{
            "type":"string",
            "format":"",
            "description":"Rate Plan Number.",
            "title":"Rate Plan Number"
        },
        "ratePlanName":{
            "type":"string",
            "format":"",
            "description":"Rate Plan name.",
            "title":"Rate Plan Name"
        },
        "ratePlanDescription":{
            "type":"string",
            "format":"",
            "description":"Rate Plan description.",
            "title":"Rate Plan Description"
        },
        "ratePlanStartDate":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"The date from which the Rate Plan will be applicable.",
            "title":"Rate Plan Start Date"
        },
        "ratePlanEndDate":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"The date at which the Rate Plan will end.",
            "title":"Rate Plan End Date"
        },
        "serviceDuration":{
            "type":"integer",
            "format":"",
            "description":"Service duration.",
            "title":"Service Duration"
        },
        "serviceDurationPeriod":{
            "type":"string",
            "format":"",
            "description":"Service duration period code.",
            "title":"Service Duration Period"
        },
        "serviceDurationType":{
            "type":"string",
            "format":"",
            "description":"Service duration type.",
            "title":"Service Duration Type"
        },
        "salesProductType":{
            "type":"string",
            "format":"",
            "description":"Sales Product type.",
            "title":"Sales Product Type"
        },
        "chargeDateAdded":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"The date from which the Charge is created.",
            "title":"Charge Date Added"
        },
        "chargeDateModified":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"The date from which the Charge is modified.",
            "title":"Charge Date Modified"
        }
    }
}

Nested Schema : Created By

Title: Created By

Read Only: true

The details of the user who created the record.

Match All

The details of the user who created the record.

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

The details of the user who modified the record.

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

Examples

q and chargeq query parameters support to the following resources. The query expression should follow the MongoDB syntax.

• Supported comparison operators: $eq, $ne, $gt, $gte, $lt, $lte, $exists, $like, $in
• Supported logical operators: $and, $or
• When using the "%" wildcard with the $like operator, the wildcard must be encoded as "%25"

q Parameter Support

Supported Query Fields

• partNumber, bomItemVariableName, rootBomItemVariableName, chargeType, priceType, pricePeriod, primaryCharge, dynamicPricingType
• System fields, like chargeDateAdded, chargeDateModified

Not Supported Query Fields

• Inactive charge attribute and the charge attributes
• Currency data type attributes
• Parameters with joined fields, like createdBy, lastModifiedBy, description, salesProductType, bomItemName, rootBomItemName, serviceDurationType, ratePlanName, etc.
• The $like operator is not supported for "dynamicPricingType"

Examples

• q={dateAdded: { $lte: "2025-02-01"}}
• q={dateModified: { $gte: "2025-02-01"}}
• q={_matrix_inputDateCol: { $eq: "2025-02-01"}}
• q={_matrix_inputBooleanCol: true}
• q={_matrix_inputBooleanCol: {$eq: true}}
• q={_matrix_inputDecimalCol: 1.5}
• q={_matrix_inputStringCol: { $in: ['test1', 'test3'] }, _matrix_outputStringCol: { $in: ['test2'] }}
• q={$and: [{_matrix_inputIntegerCol: {$lt: 100}}, {_matrix_outputIntegerCol: {$exists: true}}]}
• q={$or: [{_matrix_inputBooleanCol: {$eq: true}}, {_matrix_outputBooleanCol: {$eq: false}}]}
• q={_matrix_inputStringCol: {$like: "%25test%25"}}
• q={_matrix_inputStringCol: {$like: "test%25"}}
• q={_matrix_inputStringCol: {$like:"test%25", $options: "I"}}
• q={_matrix_inputStringCol: {$like: "%25test"}}
• q={_matrix_inputStringCol: {$like: "test"}}

chargeq Parameter Support

Supported Query Fields

• partNumber, bomItemVariableName, rootBomItemVariableName, chargeType, priceType, pricePeriod, primaryCharge, dynamicPricingType
• System fields, like chargeDateAdded, chargeDateModified

Not Supported Query Fields

• Inactive charge attribute and the charge attributes
• Currency data type attributes
• Parameters with joined fields, like createdBy, lastModifiedBy, description, salesProductType, bomItemName, rootBomItemName, serviceDurationType, ratePlanName, etc.
• The $like operator is not supported for "dynamicPricingType"

Examples

• chargeq={partNumber: 'part1'}
• chargeq={bomItemVariableName: {'$in': ['defLineItemPart12', 'test123']}}
• chargeq={priceType: 'Recurring', chargeType: 'ORA_SALE'
• chargeq={primaryCharge: true}
• chargeq={dynamicPricingType: 'attributeBasedCharge'}
• chargeq={myStringCharge_c: "charge1"}
• chargeq={myBooleanCharge_c: true}
• chargeq={chargeDateModified: { $gte: "2025-02-01"}}
• chargeq={partNumber: 'part12', chargeDateAdded: { $gte: '2025-03-05'}}
• q={_matrix_inputBooleanCol: true}&chargeq={priceType: 'Recurring', chargeType: 'ORA_SALE'}

Note: When use q and chargeq together, we will use the logical operator '&' between the two filters

Endpoint Sample

The following example shows how to retrive all pricing matrix grid data by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.

The matrix data input and output fields will be prefixed by the 'matrix' string in the response to distinguish from other charge or reference fields with the same name.

curl - X GET -H "Authorization: Bearer <token>" - H "Content-type: application/json"
https://sitename.oracle.com/rest/v19/pricingSetup/agreements/mbpAgreement/matrixGrid

Response Body Sample

{
  "items": [{
      "id": 452345,
      "partNumber": "part10",
      "description": "Part 10",
      "bomItemVariableName": "child",
      "rootBomItemVariableName": "parent",
      "bomItemName": "Child",
      "rootBomItemName": "Parent",
      "serviceDuration": 1,
      "serviceDurationPeriod": "months",
      "chargeType": "salesPrice",
      "priceType": "oneTime",
      "ratePlanName": "myRatePlan",
      "ratePlanNumber": "RP10234",
      "dynamicPricingType": "attributeBasedCharge",
      "chargeDefinitionCode": "ONE_TIME_SALES_PRICE",
      "chargeStartDate": "2024-11-08T00:0:00Z",
      "chargeEndDate": "2025-10-07T23:59:59Z",
      "dateAdded": "2023-11-08T05:42:17Z",
      "dateModified": "2023-11-08T05:42:17Z",
      "str1_c": "test",
      "int1_c": 11,
      "_matrix_str1": "testMatrix1",
      "_matrix_int1": 102,
      "_matrix_itemPrice": {
        "currency": "USD",
        "value": 20
      }
    }, {
      "id": 452346,
      "partNumber": "part10",
      "description": "Part 10",
      "bomItemVariableName": "child",
      "rootBomItemVariableName": "parent",
      "bomItemName": "Child",
      "rootBomItemName": "Parent",
      "serviceDuration": 1,
      "serviceDurationPeriod": "months",
      "chargeType": "salesPrice",
      "priceType": "oneTime",
      "ratePlanName": "myRatePlan",
      "ratePlanNumber": "RP10234",
      "dynamicPricingType": "attributeBasedCharge",
      "chargeDefinitionCode": "ONE_TIME_SALES_PRICE",
      "chargeStartDate": "2024-11-08T00:0:00Z",
      "chargeEndDate": "2025-10-07T23:59:59Z",
      "dateAdded": "2023-11-08T05:42:17Z",
      "dateModified": "2023-11-08T05:42:17Z",
      "str1_c": "test",
      "int1_c": 11,
      "_matrix_str1": "testMatrix2",
      "_matrix_int1": 103,
      "_matrix_itemPrice": {
        "currency": "USD",
        "value": 22
      }
    }
  ],
  "offset": 0,
  "limit": 1000,
  "count": 2,
  "hasMore": false
}

Back to Top