Overview
These endpoints enable administration of Pricing Matrices and Pricing Matrix Templates using REST API services.
Administration
Pricing Matrices
|
Description |
Use this endpoint to add a pricing matrix. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/matrixes |
|
|
Endpoint Parameters |
None |
|
|
HTTP Method |
POST |
|
| Request Body Parameters |
active |
Indicates if the pricing matrix is active |
|
allowedChargeDefinitions |
The list of charge definitions that this pricing matrix will apply to |
|
|
allowedUsageUOM |
The usage UOM lookup code that this pricing matrix will apply to |
|
|
data |
An array of pricing matrix data | |
|
description |
Description of the pricing matrix | |
|
name |
Name of the pricing matrix |
|
|
template |
The name and variable name of the pricing matrix template object |
|
|
templateVariableName |
The variable name of the pricing matrix template | |
|
variableName |
Variable name of the pricing matrix |
|
| Response Body Parameters |
JSON data for the pricing matrix. |
|
https://sitename.oracle.com/rest/v17/pricingSetup/matrixes
{ "name": "NA Internet Data Usage Rate", "variableName": "nAInternetDataUsageRate", "templateVariableName": "internetDataTemplate", "description": "U.S. Enterprise Discount" }
{ "name": "NA Internet Data Usage Rate", "variableName": "nAInternetDataUsageRate", "description": "U.S. Enterprise Discount", "active": true, "templateVariableName": "internetDataTemplate", "dateAdded": "2023-01-19T16:46:46Z", "dateModified": "2023-01-19T16:46:46Z" }
|
Description |
Use this endpoint to delete a pricing matrix. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/matrixes/{pricingMatrixVariableName} |
|
|
Endpoint Parameters |
pricingMatrixVariableName |
The variable name of the pricing matrix. |
|
HTTP Method |
DELETE |
|
|
Request Body Parameters |
None |
|
|
Success Response |
204 |
|
|
Description |
Use this endpoint to retrieve all pricing matrices. | |
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/matrixes |
|
|
Endpoint Parameters |
None |
|
|
(Optional) This endpoint supports the following query specifications: For more information, see Manage Collections. |
||
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Response Body Parameters |
A collection of pricing matrices. |
|
|
active |
Indicates if the pricing matrix is active |
|
|
allowedChargeDefinitions |
The list of charge definitions that this pricing matrix will apply to |
|
|
allowedUsageUOM |
The usage UOM lookup code that this pricing matrix will apply to |
|
|
createdBy |
The details of the user who created the record. |
|
|
data |
An array of pricing matrix data | |
|
dateAdded |
Creation date of the pricing matrix |
|
|
dateModified |
Last modified date of the pricing matrix |
|
|
description |
Description of the pricing matrix | |
|
lastModifiedBy |
The details of the user who modified the record. |
|
|
name |
Name of the pricing matrix |
|
|
priceModelCount |
The count of pricing models linked to this pricing matrix | |
|
template |
The name and variable name of the pricing matrix template object |
|
|
templateVariableName |
The variable name of the pricing matrix template | |
|
variableName |
Variable name of the pricing matrix |
|
https://sitename.oracle.com/rest/v17/pricingSetup/matrixes
{ "items": [{ "name": "NA Phone Call Rate Card", "variableName": "naPhoneRateCard", "description": "", "active": true, "template": { "name": "Zoom Phone Call Template", "variableName": "zoomPhoneCallTemplate" }, "priceModelCount": 3 }, { "name": "APAC Phone Call Rate Card", "variableName": "apacPhoneRateCard", "description": "", "active": true, "template": { "name": "Zoom Phone Call Template", "variableName": "zoomPhoneCallTemplate" }, "priceModelCount": 0 }, { "name": "Enterprise Data Usage Rate Card", "variableName": "enterpriseDataUsageRateCard", "description": "", "active": true, "template": { "name": "Data Usage Rate Template", "variableName": "dataUsageRateTemplate" }, "priceModelCount": 2 } ], "offset": 0, "limit": 25, "count": 3, "totalResults": 3, "hasMore": false, "links": [{ "rel": "string", "href": "string" } ] }
|
Description |
Use this endpoint to retrieve the specified pricing matrix. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/matrixes/{pricingMatrixVariableName} |
|
|
Endpoint Parameters |
pricingMatrixVariableName |
The variable name of the pricing matrix |
|
(Optional) This endpoint supports the following query specifications: For more information, see Manage Collections. |
||
|
HTTP Method |
GET |
|
| Request Body Parameters | None | |
| Response Body Parameters |
active |
Indicates if the pricing matrix is active |
|
allowedChargeDefinitions |
The list of charge definitions that this pricing matrix will apply to |
|
|
allowedUsageUOM |
The usage UOM lookup code that this pricing matrix will apply to |
|
|
createdBy |
The details of the user who created the record. |
|
|
data |
An array of pricing matrix data | |
|
dateAdded |
Creation date of the pricing matrix |
|
|
dateModified |
Last modified date of the pricing matrix |
|
|
description |
Description of the pricing matrix | |
|
lastModifiedBy |
The details of the user who modified the record. |
|
|
name |
Name of the pricing matrix |
|
|
priceModelCount |
The count of pricing models linked to this pricing matrix | |
|
template |
The name and variable name of the pricing matrix template object |
|
|
templateVariableName |
The variable name of the pricing matrix template | |
|
variableName |
Variable name of the pricing matrix |
|
https://sitename.oracle.com/rest/v17/pricingSetup/matrixes/naPhoneRateCard?expand=data
{ "name": "NA Phone Call Rate Card", "variableName": "naPhoneRateCard", "description": "", "active": true, "priceModelCount": 3, "dateAdded": "", "dateModified": "", "data": { "items": [{ "fromCountry": "US", "toCountry": "Canada", "rate": [{ "currencyCode": "USD", "value": 1.20 }, { "currencyCode": "CAD", "value": 1.35 } ] }, { "fromCountry": "US", "toCountry": "Mexico", "rate": [{ "currencyCode": "USD", "value": 1.20 }, { "currencyCode": "CAD", "value": 1.35 } ] }, "template": { "name": "test4", "variableName": "test4" } } }
|
Description |
Use this endpoint to retrieve data for the specified pricing matrix. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/matrixes/{pricingMatrixVariableName}/data |
|
|
Endpoint Parameters |
pricingMatrixVariableName |
The variable name of the pricing matrix |
|
(Optional) This endpoint supports the following query specifications: For more information, see Manage Collections. |
||
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Response Body Parameters |
An array of pricing matrix data items |
|
|
createdBy |
The details of the user who created the record. |
|
|
dateAdded |
Creation date of the pricing matrix data item |
|
|
dateModified |
Last modified date of the pricing matrix data item |
|
|
id |
The unique identifier of the pricing matrix data item |
|
|
lastModifiedBy |
The details of the user who modified the record. |
|
|
... |
Additional fields as specified in the associated pricing matrix template |
|
https://sitename.oracle.com/rest/v17/pricingSetup/matrixes/naPhoneRateCard/data
{ "items": [{ "fromCountry": "US", "toCountry": "Canada", "rate": [{ "currencyCode": "USD", "value": 0.10 }, { "currencyCode": "CAD", "value": 0.20 } ] } ], "offset": 0, "limit": 25, "count": 3, "totalResults": 3, "hasMore": false }
|
Description |
Use this endpoint to update the specified pricing matrix. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/matrixes/{pricingMatrixVariableName} |
|
|
Endpoint Parameters |
pricingMatrixVariableName |
The variable name of the pricing matrix. |
|
HTTP Method |
PATCH |
|
| Request Body Parameters |
The array of pricing patch operations. |
|
|
active |
Indicates if the pricing matrix is active |
|
|
allowedChargeDefinitions |
The list of charge definitions that this pricing matrix will apply to |
|
|
allowedUsageUOM |
The usage UOM lookup code that this pricing matrix will apply to |
|
|
data |
An array of pricing matrix data | |
|
description |
Description of the pricing matrix | |
|
name |
Name of the pricing matrix |
|
|
template |
The name and variable name of the pricing matrix template object |
|
|
templateVariableName |
The variable name of the pricing matrix template | |
|
variableName |
Variable name of the pricing matrix |
|
|
Success Response |
204 |
|
https://sitename.oracle.com/rest/v17/pricingSetup/matrixes/newCallRateCard
{ "name": "NA Internet Data Usage Rate", "active": false, "description": "U.S. Enterprise Discount" }
|
Description |
Use this endpoint to add, update, or delete pricing matrix data. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/matrixes/{pricingMatrixVariableName}/data |
|
|
Endpoint Parameters |
pricingMatrixVariableName |
The variable name of the pricing matrix. |
|
HTTP Method |
PATCH |
|
| Request Body Parameters |
The array of pricing patch operations. |
|
|
op |
The operation to be performed. Allowed values: "add", "remove", and "replace". | |
|
path |
The JSON pointer string for "path" property. | |
|
value |
The target value for the pricing matrix data items as specified in the associated pricing matrix template. Refer to Get Pricing Matrix Data | |
|
Success Response |
204 |
|
https://sitename.oracle.com/rest/v17/pricingSetup/matrixes/naPhoneRateCard/data
[{ "op": "add", "path": "/", "value": { "fromCountry": "US", "toCountry": "Canada", "itemPrice": [{ "currencyCode": "USD", "value": 0.10 }, { "currencyCode": "CAD", "value": 0.20 } ], "id": -1 } }, { "op": "add", "path": "/", "value": { "fromCountry": "US", "toCountry": "UK", "itemPrice": [{ "currencyCode": "USD", "value": 0.15 }, { "currencyCode": "CAD", "value": 0.30 } ], "id": -2 } }, { "op": "remove", "path": "/12345" }, { "op": "replace", "path": "/12346", "value": { "fromCountry": "US", "toCountry": "India", "itemPrice": [{ "currencyCode": "USD", "value": 0.10 }, { "currencyCode": "CAD", "value": 0.30 } ] } } ]
Pricing Matrix Templates
|
Description |
Use this endpoint to add a pricing matrix template. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/matrixTemplates |
|
|
Endpoint Parameters |
None |
|
|
HTTP Method |
POST |
|
| Request Body Parameters |
active |
Indicates if the pricing matrix is active |
|
allowedChargeDefinitions |
The list of charge definitions that this pricing matrix will apply to |
|
|
columns |
List of columns for the pricing matrix template. This field is Ignored for pricing matrix templates. |
|
|
description |
Description of the pricing matrix | |
|
name |
Name of the pricing matrix |
|
|
template |
The name and variable name of the pricing matrix template object |
|
|
templateType |
The type of this pricing matrix template. Allowed Values:"rateCard", "attributeBasedCharge", "scriptingPriceModel" |
|
|
variableName |
Variable name of the pricing matrix template |
|
| Response Body Parameters |
JSON data for the newly added pricing matrix template. |
|
https://sitename.oracle.com/rest/v17/pricingSetup/matrixTemplates
{ "name": "testMatrixABC1", "variableName": "testMatrixABC1", "templateType": "attributeBasedCharge", "description": "ABC matrix 1" }
{ "name": "testMatrixABC1", "variableName": "testMatrixABC1", "active": true, "description": "ABC matrix 1", "dateAdded": "2023-11-21T23:00:39Z", "dateModified": "2023-11-21T23:00:39Z", "templateType": "attributeBasedCharge" }
Add Pricing Matrix Template Column
|
Description |
Use this endpoint to add a column to the specified pricing matrix template. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/matrixTemplates/{templateVariableName}/columns |
|
|
Endpoint Parameters |
templateVariableName |
The variable name of the pricing matrix template |
|
HTTP Method |
POST |
|
| Request Body Parameters |
active |
Indicates if the pricing matrix template is active |
|
dataType |
Data type of the pricing matrix template column. Allowed Values: "Boolean", "Currency", "String", "Decimal", "Date", or "Integer" |
|
|
defaultOverridable |
Indicates if the default value is overridable |
|
|
defaultValue |
Default value of the pricing matrix template column |
|
|
description |
Description of the pricing matrix template column | |
|
id |
The unique identifier of the pricing matrix template column |
|
|
integrationId |
Identifier for the corresponding entity in Fusion Pricing. |
|
|
ioType |
The Input/Output type of the pricing matrix column. Allowed Values: "input" or "output" |
|
|
key |
Indicates if the pricing matrix template column is a key |
|
|
lookupType |
Lookup type of the pricing matrix template column |
|
|
lookupTypeLabel |
The lookup type display label of the pricing matrix template column |
|
|
name |
Name of the pricing matrix template column. |
|
|
negotiable |
Indicates if the value stores in this pricing matrix template column is negotiable |
|
|
operator |
The operator to be applied on this pricing matrix column. Allowed Values: "none", "<", "<=", "Not =", "=", ">", ">=", "Contains", "Not Contains", "Starts With", "Not Starts With", "Ends With", or "Not Ends With" |
|
|
orderNumber |
The sequence number of the column in the template |
|
|
pricingAttribute |
The pricing attribute referenced to for this pricing matrix column |
|
|
required |
Indicates if the value of this pricing matrix template column is required |
|
|
templateType |
The type of this pricing matrix template. Allowed Values: "rateCard", "attributeBasedCharge", "scriptingPriceModel" |
|
|
variableName |
Variable name of the pricing matrix template column |
|
|
wildCardSupported |
Indicates if this column supports wild card values |
|
| Response Body Parameters |
JSON data for the newly added pricing matrix template column. |
|
https://sitename.oracle.com/rest/v17/pricingSetup/matrixTemplates/testMatrixTemp1/columns
{ "name": "To Country", "variableName": "toCountry", "dataType": "String", "defaultOverridable": false, "description": "To country.", "active": true, "negotiable": false, "required": false, "ioType": "input", "lookupType": "custom1_c", "pricingAttribute": "pricingEngineMainString", "operator": "=" }
{ "id": 3023092501, "name": "To Country", "variableName": "toCountry", "key": false, "dataType": "String", "lookupType": "custom1_c", "defaultOverridable": false, "description": "To country.", "active": true, "negotiable": false, "required": false, "dateAdded": "2023-11-27T15:30:25Z", "dateModified": "2023-11-27T15:30:25Z", "ioType": "input", "operator": "=", "pricingAttribute": "pricingEngineMainString" }
Delete Pricing Matrix Template
|
Description |
Use this endpoint to delete the specified pricing matrix template. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/matrixTemplates/{templateVariableName} |
|
|
Endpoint Parameters |
templateVariableName |
The variable name of the pricing matrix template |
|
HTTP Method |
DELETE |
|
|
Request Body Parameters |
None |
|
|
Success Response |
204 |
|
Delete Pricing Matrix Template Column
|
Description |
Use this endpoint to delete a pricing matrix template column. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/matrixTemplates/{templateVariableName}/columns/{id}} |
|
|
Endpoint Parameters |
templateVariableName |
The variable name of the pricing matrix template |
|
id |
The unique identifier of the pricing matrix template column |
|
|
HTTP Method |
DELETE |
|
|
Request Body Parameters |
None |
|
|
Success Response |
204 |
|
|
Description |
Use this endpoint to retrieve all pricing matrix templates. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/matrixTemplates |
|
|
Endpoint Parameters |
None |
|
|
(Optional) This endpoint supports the following query specifications: For more information, see Manage Collections. |
||
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Response Body Parameters |
A collection of pricing matrix template items |
|
|
active |
Indicates if the pricing matrix is active |
|
|
allowedChargeDefinitions |
The list of charge definitions that this pricing matrix will apply to |
|
|
columns |
List of columns for the pricing matrix template. This field is Ignored for pricing matrix templates. |
|
|
createdBy |
The details of the user who created the record. |
|
|
dateAdded |
Creation date of the pricing matrix |
|
|
dateModified |
Last modified date of the pricing matrix |
|
|
description |
Description of the pricing matrix | |
|
lastModifiedBy |
The details of the user who modified the record. |
|
|
name |
Name of the pricing matrix |
|
|
pricingMatrixCount |
The count of pricing matrices linked to this template | |
|
rateCardCount |
The count of pricing matrices linked to this template |
|
|
template |
The name and variable name of the pricing matrix template object |
|
|
templateType |
The type of this pricing matrix template. Allowed Values: "rateCard", "attributeBasedCharge", "scriptingPriceModel" |
|
|
variableName |
Variable name of the pricing matrix template |
|
https://sitename.oracle.com/rest/v17/pricingSetup/matrixTemplates
{ "items": [{ "name": "t1", "variableName": "t1", "active": true, "description": "", "rateCardCount": 1, "pricingMatrixCount": 1, "dateAdded": "2023-11-08T05:42:17Z", "dateModified": "2023-11-08T05:42:17Z", "templateType": "rateCard" }, { "name": "testMatrixTemp1", "variableName": "testMatrixTemp1", "active": true, "description": "testMatrixTemp1", "pricingMatrixCount": 0, "dateAdded": "2023-11-08T06:01:08Z", "dateModified": "2023-11-08T06:01:08Z", "templateType": "attributeBasedCharge" } ], "offset": 0, "limit": 1000, "count": 2, "hasMore": false }
|
Description |
Use this endpoint to retrieve the specified pricing matrix template. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/matrixTemplates/{templateVariableName} |
|
|
Endpoint Parameters |
templateVariableName |
The variable name of the pricing matrix template. |
|
(Optional) This endpoint supports the following query specifications: For more information, see Manage Collections. |
||
|
HTTP Method |
GET |
|
| Request Body Parameters | None | |
| Response Body Parameters |
active |
Indicates if the pricing matrix is active |
|
allowedChargeDefinitions |
The list of charge definitions that this pricing matrix will apply to |
|
|
columns |
List of columns for the pricing matrix template. This field is Ignored for pricing matrix templates. |
|
|
createdBy |
The details of the user who created the record. |
|
|
dateAdded |
Creation date of the pricing matrix |
|
|
dateModified |
Last modified date of the pricing matrix |
|
|
description |
Description of the pricing matrix | |
|
lastModifiedBy |
The details of the user who modified the record. |
|
|
name |
Name of the pricing matrix |
|
|
pricingMatrixCount |
The count of pricing matrices linked to this template | |
|
rateCardCount |
The count of pricing matrices linked to this template |
|
|
template |
The name and variable name of the pricing matrix template object |
|
|
templateType |
The type of this pricing matrix template. Allowed Values: "rateCard" or "attributeBasedCharge" |
|
|
variableName |
Variable name of the pricing matrix template |
|
https://sitename.oracle.com/rest/v17/pricingSetup/matrixTemplates/testMatrixTemp1
{ "name": "testMatrixTemp1", "variableName": "testMatrixTemp1", "active": true, "description": "testMatrixTemp1", "pricingMatrixCount": 0, "dateAdded": "2023-11-08T06:01:08Z", "dateModified": "2023-11-08T06:01:08Z", "templateType": "attributeBasedCharge" }
Get Pricing Matrix Template Columns
|
Description |
Use this endpoint to retrieve all columns for the specified pricing matrix template. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/matrixTemplates/{templateVariableName}/columns |
|
|
Endpoint Parameters |
templateVariableName |
The variable name of the pricing matrix template |
|
(Optional) This endpoint supports the following query specifications: For more information, see Manage Collections. |
||
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Response Body Parameters |
A collection of pricing matrix template column items. |
|
|
active |
Indicates if the pricing matrix template is active |
|
|
createdBy |
The details of the user who created the record. |
|
|
dataType |
Data type of the pricing matrix template column. Allowed Values: "Boolean", "Currency", "String", "Decimal", "Date", or "Integer" |
|
|
dateAdded |
Creation date of the pricing matrix template column |
|
|
dateModified |
Last modified date of the pricing matrix template column |
|
|
defaultOverridable |
Indicates if the default value is overridable |
|
|
defaultValue |
Default value of the pricing matrix template column |
|
|
description |
Description of the pricing matrix template column | |
|
id |
The unique identifier of the pricing matrix template column |
|
|
integrationId |
Identifier for the corresponding entity in Fusion Pricing. |
|
|
ioType |
The Input/Output type of the pricing matrix column. Allowed Values: "input" or "output" |
|
|
key |
Indicates if the pricing matrix template column is a key |
|
|
lastModifiedBy |
The details of the user who modified the record. |
|
|
lookupType |
Lookup type of the pricing matrix template column |
|
|
lookupTypeLabel |
The lookup type display label of the pricing matrix template column |
|
|
name |
Name of the pricing matrix template column. |
|
|
negotiable |
Indicates if the value stores in this pricing matrix template column is negotiable |
|
|
operator |
The operator to be applied on this pricing matrix column. Allowed Values: "none", "<", "<=", "Not =", "=", ">", ">=", "Contains", "Not Contains", "Starts With", "Not Starts With", "Ends With", or "Not Ends With" |
|
|
orderNumber |
The sequence number of the column in the template |
|
|
pricingAttribute |
The pricing attribute referenced to for this pricing matrix column |
|
|
required |
Indicates if the value of this pricing matrix template column is required |
|
|
templateType |
The type of this pricing matrix template. Allowed Values: "rateCard" or "attributeBasedCharge" |
|
|
variableName |
Variable name of the pricing matrix template column |
|
|
wildCardSupported |
Indicates if this column supports wild card values |
|
https://sitename.oracle.com/rest/v17/pricingSetup/matrixTemplates/testMatrixTemp1/columns
{ "items": [{ "id": 3023105055, "orderNumber": 1, "name": "Item Price", "variableName": "itemPrice", "key": false, "dataType": "Currency", "defaultOverridable": true, "description": "The item price.", "active": true, "negotiable": true, "required": false, "dateAdded": "2023-11-08T06:01:09Z", "dateModified": "2023-11-08T06:01:09Z", "ioType": "output", "operator": "none", "wildCardSupported": false } ], "offset": 0, "limit": 1000, "count": 1, "hasMore": false }
Get Pricing Matrix Template Column
|
Description |
Use this endpoint to retrieve a pricing matrix template column. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/matrixTemplates/{templateVariableName}/columns/{id} |
|
|
Endpoint Parameters |
templateVariableName |
The variable name of the pricing matrix template. |
|
id |
The unique identifier of the pricing matrix template column. |
|
|
(Optional) This endpoint supports the following query specifications: For more information, see Manage Collections. |
||
|
HTTP Method |
GET |
|
| Request Body Parameters | None | |
| Response Body Parameters |
active |
Indicates if the pricing matrix template is active |
|
createdBy |
The details of the user who created the record. |
|
|
dataType |
Data type of the pricing matrix template column. Allowed Values: "Boolean", "Currency", "String", "Decimal", "Date", or "Integer" |
|
|
dateAdded |
Creation date of the pricing matrix template column |
|
|
dateModified |
Last modified date of the pricing matrix template column |
|
|
defaultOverridable |
Indicates if the default value is overridable |
|
|
defaultValue |
Default value of the pricing matrix template column |
|
|
description |
Description of the pricing matrix template column | |
|
id |
The unique identifier of the pricing matrix template column |
|
|
integrationId |
Identifier for the corresponding entity in Fusion Pricing. |
|
|
ioType |
The Input/Output type of the pricing matrix column. Allowed Values: "input" or "output" |
|
|
key |
Indicates if the pricing matrix template column is a key |
|
|
lastModifiedBy |
The details of the user who modified the record. |
|
|
lookupType |
Lookup type of the pricing matrix template column |
|
|
lookupTypeLabel |
The lookup type display label of the pricing matrix template column |
|
|
name |
Name of the pricing matrix template column. |
|
|
negotiable |
Indicates if the value stores in this pricing matrix template column is negotiable |
|
|
operator |
The operator to be applied on this pricing matrix column. Allowed Values: "none", "<", "<=", "Not =", "=", ">", ">=", "Contains", "Not Contains", "Starts With", "Not Starts With", "Ends With", or "Not Ends With" |
|
|
orderNumber |
The sequence number of the column in the template |
|
|
pricingAttribute |
The pricing attribute referenced to for this pricing matrix column |
|
|
required |
Indicates if the value of this pricing matrix template column is required |
|
|
templateType |
The type of this pricing matrix template. Allowed Values: "rateCard" or "attributeBasedCharge" |
|
|
variableName |
Variable name of the pricing matrix template column |
|
|
wildCardSupported |
Indicates if this column supports wild card values |
|
https://sitename.oracle.com/rest/v17/pricingSetup/matrixTemplates/testMatrixTemp1/columns/3023112345
{ "id": 3023112345, "orderNumber": 1, "name": "Item Price", "variableName": "itemPrice", "key": false, "dataType": "Currency", "defaultOverridable": false, "description": "The item price.", "active": true, "negotiable": true, "required": false, "dateAdded": "2023-11-15T19:13:04Z", "dateModified": "2023-11-15T19:13:04Z", "ioType": "output", "operator": "none", "wildCardSupported": false }
Update Pricing Matrix Template
|
Description |
Use this endpoint to update the specified pricing matrix template. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/matrixTemplates/{templateVariableName} |
|
|
Endpoint Parameters |
templateVariableName |
The variable name of the pricing matrix template |
|
HTTP Method |
PATCH |
|
| Request Body Parameters |
active |
Indicates if the pricing matrix is active |
|
allowedChargeDefinitions |
The list of charge definitions that this pricing matrix will apply to |
|
|
columns |
List of columns for the pricing matrix template. This field is Ignored for pricing matrix templates. |
|
|
description |
Description of the pricing matrix | |
|
name |
Name of the pricing matrix |
|
|
template |
The name and variable name of the pricing matrix template object |
|
|
templateType |
The type of this pricing matrix template. Allowed Values: "rateCard" or "attributeBasedCharge" |
|
|
variableName |
Variable name of the pricing matrix template |
|
|
Success Response |
204 |
|
https://sitename.oracle.com/rest/v17/pricingSetup/matrixTemplates/testMatrixTemp1
{ "active": false }
Update Pricing Matrix Template Columns
|
Description |
Use this endpoint to update columns for the specified pricing matrix template. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/matrixTemplates/{templateVariableName}/columns |
|
|
Endpoint Parameters |
templateVariableName |
The variable name of the pricing matrix template |
|
HTTP Method |
PATCH |
|
| Request Body Parameters |
The array of pricing patch operations. |
|
|
op |
The operation to be performed. Allowed values: "add", "remove", and "replace". | |
|
path |
The JSON pointer string for "path" property. | |
|
value |
The target value. Refer to Update Pricing Matrix Template Column for more information. | |
|
Success Response |
204 |
|
https://sitename.oracle.com/rest/v17/pricingSetup/matrixTemplates/testMatrixTemp1/columns
[{ "op": "add", "path": "/", "value": { "orderNumber": 2, "name": "Post Code", "variableName": "postCode", "dataType": "String", "description": "The post code.", "active": true } }, { "op": "replace", "path": "/toCountry", "value": { "name": "Price", "description": "The To country.", "active": true } } ]
Update Pricing Matrix Template Column
|
Description |
Use this endpoint to update the specified pricing matrix template column. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/matrixTemplates/{templateVariableName}/columns/{id} |
|
|
Endpoint Parameters |
templateVariableName |
The variable name of the pricing matrix template. |
|
id |
The unique identifier of the pricing matrix template column. |
|
|
HTTP Method |
PATCH |
|
| Request Body Parameters |
active |
Indicates if the pricing matrix template is active |
|
dataType |
Data type of the pricing matrix template column. Allowed Values: "Boolean", "Currency", "String", "Decimal", "Date", or "Integer" |
|
|
defaultOverridable |
Indicates if the default value is overridable |
|
|
defaultValue |
Default value of the pricing matrix template column |
|
|
description |
Description of the pricing matrix template column | |
|
id |
The unique identifier of the pricing matrix template column |
|
|
integrationId |
Identifier for the corresponding entity in Fusion Pricing. |
|
|
ioType |
The Input/Output type of the pricing matrix column. Allowed Values: "input" or "output" |
|
|
key |
Indicates if the pricing matrix template column is a key |
|
|
lookupType |
Lookup type of the pricing matrix template column |
|
|
lookupTypeLabel |
The lookup type display label of the pricing matrix template column |
|
|
name |
Name of the pricing matrix template column. |
|
|
negotiable |
Indicates if the value stores in this pricing matrix template column is negotiable |
|
|
operator |
The operator to be applied on this pricing matrix column. Allowed Values: "none", "<", "<=", "Not =", "=", ">", ">=", "Contains", "Not Contains", "Starts With", "Not Starts With", "Ends With", or "Not Ends With" |
|
|
orderNumber |
The sequence number of the column in the template |
|
|
pricingAttribute |
The pricing attribute referenced to for this pricing matrix column |
|
|
required |
Indicates if the value of this pricing matrix template column is required |
|
|
templateType |
The type of this pricing matrix template. Allowed Values: "rateCard" or "attributeBasedCharge" |
|
|
variableName |
Variable name of the pricing matrix template column |
|
|
wildCardSupported |
Indicates if this column supports wild card values |
|
|
Success Response |
204 |
|
https://sitename.oracle.com/rest/v17/pricingSetup/matrixTemplates/testMatrixTemp1/columns/36991124
{ "active": false }
Pricing Matrix & Pricing Matrix Template Translations
Get Pricing Matrix Translations
|
Description |
Use this endpoint to retrieve translations for the specified pricing matrix. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/matrixes/{pricingMatrixVariableName}/translations |
|
|
Endpoint Parameters |
pricingMatrixVariableName |
The variable name of the pricing matrix. |
|
(Optional) This endpoint supports the For more information, see Manage Collections. |
||
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Response Body Parameters |
A collection of translations for the specified pricing matrix. See Get pricing matrix Translation for detailed response body parameters. |
|
https://sitename.oracle.com/rest/v17/pricingSetup/matrixes/naPhoneRateCard/translations
{ "items": [{ "languageCode": "en", "languageLabel": "English", "name": "NA Phone Call Rate Card", "description": "This is some sample text" }, { .... } ] }
Get Pricing Matrix Translation
|
Description |
Use this endpoint to retrieve the specified language translation for a pricing matrix. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/matrixes/{pricingMatrixVariableName}/translations/{languageCode} |
|
|
Endpoint Parameters |
pricingMatrixVariableName |
The variable name of the pricing matrix. |
|
(Optional) This endpoint supports the following query specifications: For more information, see Manage Collections. |
||
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Response Body Parameters |
description |
Display description of pricing matrix template column. |
|
languageCode |
Language code. |
|
|
languageLabel |
Display language label in the given language code. | |
|
name |
Display name of pricing matrix template column. | |
https://sitename.oracle.com/rest/v17/pricingSetup/matrixes/naPhoneRateCard/translations/en
{ "languageCode": "en", "languageLabel": "English", "name": "NA Phone Call Rate Card", "description": "This is some sample text" }
Get Pricing Matrix Template Translations
|
Description |
Use this endpoint to retrieve translations for the specified pricing matrix template. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/matrixTemplates/{templateVariableName}/translations |
|
|
Endpoint Parameters |
templateVariableName |
The variable name of the pricing matrix template |
|
(Optional) This endpoint supports the For more information, see Manage Collections. |
||
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Response Body Parameters |
An array of pricing matrix template translations | |
|
description |
Display description of pricing matrix template column | |
|
languageCode |
Language code |
|
|
languageLabel |
Display language label in the given language code | |
|
name |
Display name of pricing matrix template column | |
https://sitename.oracle.com/rest/v17/pricingSetup/matrixTemplates/zoomPhoneCallTemplate/translations
{ "items": [{ "languageCode": "en", "languageLabel": "English", "name": "Zoom Phone Call Template", "description": "This is some sample text" }, { "languageCode": "de", "languageLabel": "German", "name": "Vorlage fur Zoom-Telefonanrufe", "description": "Dies ist ein Beispieltext" }, { "languageCode": "fr", "languageLabel": "French", "name": "Modele d'appel telephonique Zoom", "description": "Ceci est un exemple de texte" } ] }
Get Pricing Matrix Template Translation
|
Description |
Use this endpoint to retrieve the specified language translation for a pricing matrix template. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/matrixTemplates/{templateVariableName}/translations/{languageCode} |
|
|
Endpoint Parameters |
templateVariableName |
The variable name of the pricing matrix template |
|
languageCode |
The language code |
|
|
(Optional) This endpoint supports the following query specifications: For more information, see Manage Collections. |
||
|
HTTP Method |
GET |
|
| Request Body Parameters | None | |
| Response Body Parameters |
description |
Display description of pricing matrix template column |
|
languageCode |
Language code |
|
|
languageLabel |
Display language label in the given language code | |
|
name |
Display name of pricing matrix template column | |
https://sitename.oracle.com/rest/v17/pricingSetup/matrixTemplates/zoomPhoneCallTemplate/translations/fr
{ "languageCode": "fr", "languageLabel": "French", "name": "Modele d'appel telephonique Zoom", "description": "Ceci est un exemple de texte" }
Get Pricing Matrix Template Column Translations
|
Description |
Use this endpoint to retrieve translations for the specified pricing matrix template column. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/matrixTemplates/{templateVariableName}/columns/{id}/translations |
|
|
Endpoint Parameters |
templateVariableName |
The variable name of the pricing matrix template. |
|
id |
The unique identifier of the pricing matrix template column. |
|
|
(Optional) This endpoint supports the For more information, see Manage Collections. |
||
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Response Body Parameters |
A collection of pricing matrix template column translations. See Get pricing matrix template Column Translation for detailed response body parameters. |
|
https://sitename.oracle.com/rest/v17/pricingSetup/matrixTemplates/testMatrixTemp1/columns/36991124
{ "items": [{ "languageCode": "en", "languageLabel": "English", "name": "From Country", "description": "..." }, { "languageCode": "fr", "languageLabel": "French", "name": "Du pays", "description": "..." }, { .... } ] }
Get Pricing Matrix Template Column Translation
|
Description |
Use this endpoint to retrieve the specified language translation for a pricing matrix template column. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/matrixTemplates/{templateVariableName}/columns/{id}/translations /{languageCode} |
|
|
Endpoint Parameters |
templateVariableName |
The variable name of the pricing matrix template. |
|
id |
The unique identifier of the pricing matrix template column. |
|
|
languageCode |
The language code. | |
|
(Optional) This endpoint supports the following query specifications: For more information, see Manage Collections. |
||
|
HTTP Method |
GET |
|
| Request Body Parameters | None | |
| Response Body Parameters |
description |
Display description of pricing matrix template column. |
|
languageCode |
Language code. |
|
|
languageLabel |
Display language label in the given language code. | |
|
name |
Display name of pricing matrix template column. | |
https://sitename.oracle.com/rest/v17/pricingSetup/matrixTemplates/dataUsagePricingMatrixTemplate/columns/36991124/de
{ "languageCode": "de", "languageLabel": "German", "name": "Vom Land", "description": "" }
Update Pricing Matrix Translations
|
Description |
Use this endpoint to update pricing matrix translations. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/matrixes/{pricingMatrixVariableName}/translations |
|
| Endpoint Parameters |
pricingMatrixVariableName |
The variable name of the pricing matrix |
|
HTTP Method |
PUT |
|
| Response Body Parameters | An array of pricing matrix translations | |
|
description |
Display description of the pricing matrix item | |
|
languageCode |
Language code |
|
|
languageLabel |
Display language label in the given language code | |
|
name |
Display name of pricing matrix item | |
|
Response Body Status |
204 No Content |
|
https://sitename.oracle.com/rest/v17/pricingSetup/matrixes/fromCountry
[{ "languageCode": "en", "name": "From Country", "description": "...." }, { "languageCode": "de", "name": "Vom Land", "description": "...." }, ..... ]
Update Pricing Matrix Template Translations
|
Description |
Use this endpoint to update pricing matrix template translations. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/matrixTemplates/{templateVariableName}/translations |
|
| Endpoint Parameters |
templateVariableName |
The variable name of the pricing matrix template |
|
HTTP Method |
PUT |
|
| Response Body Parameters | An array of pricing matrix template translations | |
|
description |
Display description of pricing matrix template column | |
|
languageCode |
Language code |
|
|
languageLabel |
Display language label in the given language code | |
|
name |
Display name of pricing matrix template column | |
|
Response Body Status |
204 No Content |
|
https://sitename.oracle.com/rest/v17/pricingSetup/matrixTemplates/testMatrixTemp1/translations
[{ "languageCode": "en", "name": "From Country", "description": "...." }, { "languageCode": "de", "name": "Vom Land", "description": "...." }, ..... ]
Update Pricing Matrix Template Column Translations
|
Description |
Use this endpoint to update pricing matrix template column translations. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/matrixTemplates/{templateVariableName}/columns/{id}/translations |
|
| Endpoint Parameters |
templateVariableName |
The variable name of the pricing matrix template |
|
id |
The unique identifier of the pricing matrix template column |
|
|
HTTP Method |
PUT |
|
| Request Body Parameters | An array of pricing matrix template column translations | |
|
description |
Display description of pricing matrix template column | |
|
languageCode |
Language code |
|
|
languageLabel |
Display language label in the given language code | |
|
name |
Display name of pricing matrix template column | |
|
Response Body Status |
204 No Content |
|
https://sitename.oracle.com/rest/v17/pricingSetup/matrixTemplates/testMatrixTemp1/columns/3023092501/translations
[{ "languageCode": "en", "name": "From Country", "description": "...." }, { "languageCode": "de", "name": "Vom Land", "description": "...." }, ..... ]
