Get Price Agreement Pricing Matrix Grid Data
get
/rest/v16/pricingSetup/agreements/{agreementVarName}/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
Query Parameters
-
fields: string
This parameter filters the resource attributes. Only the specified attributes are returned, which means that if no attributes are specified, all attributes are returned.
-
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.
-
totalResults: boolean
The resource collection representation will include the total row count when "?totalResults=true", otherwise the count is not included. The default value is "false".
Response
Supported Media Types
- application/json
200 Response
Success
Root Schema : PricingResourceCollection_PricingMatrixGrid
Type:
Show Source
object
-
count:
integer()
Title:
Count
Read Only:true
The number of resource instances returned in the current range. -
createdBy:
Created By
Title:
Created By
Read Only:true
The details of the user who created the record. -
hasMore:
boolean()
Title:
HasMore
Read Only:true
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false. -
items:
array items
-
lastModifiedBy:
Last Modified By
Title:
Last Modified By
Read Only:true
The details of the user who modified the record. -
limit:
integer()
Title:
Limit
Read Only:true
The actual paging size used by the server. -
links:
array Links
Title:
Links
Read Only:true
The link relations associated with the resource instance. -
offset:
integer()
Title:
OffSet
Read Only:true
The offset value used in the current page. -
totalResults:
integer()
Title:
Total Results
Read Only:true
Captures the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.
Nested Schema : Created By
Title:
Created By
Read Only:
true
The details of the user who created the record.
Match All
Show Source
Nested Schema : Last Modified By
Title:
Last Modified By
Read Only:
true
The details of the user who modified the record.
Match All
Show Source
Nested Schema : Links
Type:
array
Title:
Links
Read Only:
true
The link relations associated with the resource instance.
Show Source
Nested Schema : UserDetails
Type:
Show Source
object
-
emailId:
string()
Title:
Email Id
Email Id of the user -
firstName:
string()
Title:
First Name
First Name of the user -
lastName:
string()
Title:
Last Name
Last Name of the user
Nested Schema : PricingMatrixGrid
Type:
Show Source
object
-
_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. -
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. -
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. -
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.
Nested Schema : Created By
Title:
Created By
Read Only:
true
The details of the user who created the record.
Match All
Show Source
Nested Schema : Last Modified By
Title:
Last Modified By
Read Only:
true
The details of the user who modified the record.
Match All
Show Source
Nested Schema : Links
Type:
array
Title:
Links
Read Only:
true
The link relations associated with the resource instance.
Show Source
Examples
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 - i - H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" - H "Content-type: application/json" https://sitename.oracle.com/rest/v16/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 }